@karmaniverous/get-dotenv
    Preparing search index...

    Interface $ZodCustomInternals<O, I>Internal

    interface $ZodCustomInternals<O = unknown, I = unknown> {
        bag: LoosePartial<{ Class: typeof Class }>;
        constr: new (def: any) => z.core.$ZodType;
        def: $ZodCustomDef;
        deferred: AnyFunc[] | undefined;
        input: I;
        issc: $ZodIssue;
        isst: never;
        onattach: ((schema: z.core.$ZodType) => void)[];
        optin?: "optional";
        optout?: "optional";
        output: O;
        parent?: z.core.$ZodType<
            unknown,
            unknown,
            $ZodTypeInternals<unknown, unknown>,
        >;
        pattern: RegExp | undefined;
        propValues?: PropValues;
        toJSONSchema?: () => unknown;
        traits: Set<string>;
        values?: PrimitiveSet;
        version: { major: 4; minor: 1; patch: number };
        check(payload: ParsePayload<O>): MaybeAsync<void>;
        parse(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        run(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
    }

    Type Parameters

    • O = unknown
    • I = unknown

    Hierarchy (View Summary)

    Index

    Properties

    bag constr def deferred input issc isst onattach optin? optout? output parent? pattern propValues? toJSONSchema? traits values? version

    Methods

    check parse run

    Properties

    bag: LoosePartial<{ Class: typeof Class }>

    A catchall object for bag metadata related to this schema. Commonly modified by checks using onattach.

    constr: new (def: any) => z.core.$ZodType

    The constructor function of this schema.

    def: $ZodCustomDef

    Schema definition.

    deferred: AnyFunc[] | undefined

    List of deferred initializers.

    input: I

    The inferred input type

    issc: $ZodIssue

    The set of issues this check might throw.

    isst: never

    The set of issues this schema might throw during type checking.

    onattach: ((schema: z.core.$ZodType) => void)[]
    optin?: "optional"
    optout?: "optional"
    output: O

    The inferred output type

    parent?: z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

    The parent of this schema. Only set during certain clone operations.

    pattern: RegExp | undefined

    This flag indicates that a schema validation can be represented with a regular expression. Used to determine allowable schemas in z.templateLiteral().

    propValues?: PropValues

    A set of literal discriminators used for the fast path in discriminated unions.

    toJSONSchema?: () => unknown

    An optional method used to override toJSONSchema logic.

    traits: Set<string>

    Stores identifiers for the set of traits implemented by this schema.

    values?: PrimitiveSet

    The set of literal values that will pass validation. Must be an exhaustive set. Used to determine optionality in z.record().

    Defined on: enum, const, literal, null, undefined Passthrough: optional, nullable, branded, default, catch, pipe Todo: unions?

    version: { major: 4; minor: 1; patch: number }

    The @zod/core version of this schema

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods