Membrane SDK - v0.29.2
    Preparing search index...

    Interface $ZodFunctionInternals<Args, Returns>Internal

    interface $ZodFunctionInternals<
        Args extends $ZodFunctionIn,
        Returns extends $ZodFunctionOut,
    > {
        version: { major: 4; minor: 3; patch: number };
        deferred: AnyFunc[] | undefined;
        run(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        parse(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        traits: Set<string>;
        optin?: "optional";
        optout?: "optional";
        values?: PrimitiveSet;
        propValues?: PropValues;
        pattern: RegExp | undefined;
        constr: new (def: any) => $ZodType;
        bag: Record<string, unknown>;
        processJSONSchema?: (
            ctx: ToJSONSchemaContext,
            json: JSONSchema,
            params: ProcessParams,
        ) => void;
        toJSONSchema?: () => unknown;
        parent?: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        output: $InferOuterFunctionType;
        input: $InferInnerFunctionType;
        def: $ZodFunctionDef<Args, Returns>;
        isst: $ZodIssueInvalidType;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    run parse

    Properties

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

    The @zod/core version of this schema

    deferred: AnyFunc[] | undefined

    List of deferred initializers.

    traits: Set<string>

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

    optin?: "optional"
    optout?: "optional"
    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?

    propValues?: PropValues

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

    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().

    constr: new (def: any) => $ZodType

    The constructor function of this schema.

    bag: Record<string, unknown>

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

    processJSONSchema?: (
        ctx: ToJSONSchemaContext,
        json: JSONSchema,
        params: ProcessParams,
    ) => void

    Subject to change, not a public API.

    toJSONSchema?: () => unknown

    An optional method used to override toJSONSchema logic.

    parent?: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

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

    output: $InferOuterFunctionType

    The inferred output type

    input: $InferInnerFunctionType

    The inferred input type

    def: $ZodFunctionDef<Args, Returns>

    Schema definition.

    isst: $ZodIssueInvalidType

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

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods