Variable entryConst

entry: ZodObject<{
    keys: ZodArray<ZodString, "many">;
    content: ZodString;
    extensions: ZodRecord<ZodString, ZodAny>;
    enabled: ZodBoolean;
    insertion_order: ZodNumber;
    case_sensitive: ZodOptional<ZodBoolean>;
    name: ZodOptional<ZodString>;
    priority: ZodOptional<ZodNumber>;
    id: ZodOptional<ZodNumber>;
    comment: ZodOptional<ZodString>;
    selective: ZodOptional<ZodBoolean>;
    secondary_keys: ZodOptional<ZodArray<ZodString, "many">>;
    constant: ZodOptional<ZodBoolean>;
    position: ZodOptional<ZodUnion<[ZodLiteral<"before_char">, ZodLiteral<"after_char">]>>;
}, "strip", ZodTypeAny, {
    keys: string[];
    content: string;
    extensions: Record<string, any>;
    enabled: boolean;
    insertion_order: number;
    case_sensitive?: boolean;
    name?: string;
    priority?: number;
    id?: number;
    comment?: string;
    selective?: boolean;
    secondary_keys?: string[];
    constant?: boolean;
    position?: "before_char" | "after_char";
}, {
    keys: string[];
    content: string;
    extensions: Record<string, any>;
    enabled: boolean;
    insertion_order: number;
    case_sensitive?: boolean;
    name?: string;
    priority?: number;
    id?: number;
    comment?: string;
    selective?: boolean;
    secondary_keys?: string[];
    constant?: boolean;
    position?: "before_char" | "after_char";
}> = ...

A parser object made with the zod library which can be used to validate or parse CharacterBookEntry objects, which are used inside the V2 spec.

https://github.com/malfoyslastname/character-card-spec-v2/blob/main/spec_v2.md

Example

import * as Cards from 'character-card-utils'

// parsing
Cards.entry.parse(validEntry) //=> return type CharacterBookEntry
Cards.entry.parse(invalidEntry) //=> throws ZodError

// exception-free parsing
Cards.entry.safeParse(validEntry) // => return type { success: true; data: CharacterBookEntry }
Cards.entry.safeParse(invalidEntry) //=> return type { success: false; error: ZodError }

Settings

Member Visibility

Theme

Generated using TypeDoc