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

    Interface $ZodDiscriminatedUnionInternals<Options, Disc>

    interface $ZodDiscriminatedUnionInternals<
        Options extends readonly SomeType[] = readonly z.core.$ZodType[],
        Disc extends string = string,
    > {
        bag: Record<string, unknown>;
        constr: new (def: any) => z.core.$ZodType;
        def: $ZodDiscriminatedUnionDef<Options, Disc>;
        deferred: AnyFunc[] | undefined;
        input: $InferUnionInput<Options[number]>;
        isst: $ZodIssueInvalidUnion;
        optin: IsOptionalIn<Options[number]> extends false
            ? "optional" | undefined
            : "optional";
        optout: IsOptionalOut<Options[number]> extends false
            ? "optional" | undefined
            : "optional";
        output: $InferUnionOutput<Options[number]>;
        parent?: z.core.$ZodType<
            unknown,
            unknown,
            $ZodTypeInternals<unknown, unknown>,
        >;
        pattern: Options[number]["_zod"]["pattern"];
        propValues: PropValues;
        toJSONSchema?: () => unknown;
        traits: Set<string>;
        values: Options[number]["_zod"]["values"];
        version: { major: 4; minor: 1; patch: number };
        parse(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        run(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    parse run

    Properties

    bag: Record<string, unknown>

    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: $ZodDiscriminatedUnionDef<Options, Disc>

    Schema definition.

    deferred: AnyFunc[] | undefined

    List of deferred initializers.

    input: $InferUnionInput<Options[number]>
    isst: $ZodIssueInvalidUnion

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

    optin: IsOptionalIn<Options[number]> extends false
        ? "optional" | undefined
        : "optional"
    optout: IsOptionalOut<Options[number]> extends false
        ? "optional" | undefined
        : "optional"
    output: $InferUnionOutput<Options[number]>
    parent?: z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

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

    pattern: Options[number]["_zod"]["pattern"]

    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: Options[number]["_zod"]["values"]

    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