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

    Interface $ZodObjectInternals<Shape, Config>

    interface $ZodObjectInternals<
        out Shape extends Readonly<$ZodShape> = Readonly<$ZodShape>,
        out Config extends $ZodObjectConfig = $ZodObjectConfig,
    > {
        version: { major: 4; minor: 1; patch: number };
        deferred: undefined | AnyFunc[];
        run(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        parse(
            payload: ParsePayload<any>,
            ctx: ParseContextInternal,
        ): MaybeAsync<ParsePayload<unknown>>;
        traits: Set<string>;
        values?: PrimitiveSet;
        pattern: undefined | RegExp;
        constr: new (def: any) => $ZodType;
        bag: Record<string, unknown>;
        toJSONSchema?: () => unknown;
        parent?: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        def: $ZodObjectDef<Shape>;
        config: Config;
        isst: $ZodIssueUnrecognizedKeys | $ZodIssueInvalidType<unknown>;
        propValues: PropValues;
        output: $InferObjectOutput<Shape, Config["out"]>;
        input: $InferObjectInput<Shape, Config["in"]>;
        optin?: "optional";
        optout?: "optional";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    run parse

    Properties

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

    The @zod/core version of this schema

    deferred: undefined | AnyFunc[]

    List of deferred initializers.

    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?

    pattern: undefined | RegExp

    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.

    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.

    def: $ZodObjectDef<Shape>

    Schema definition.

    config: Config
    isst: $ZodIssueUnrecognizedKeys | $ZodIssueInvalidType<unknown>

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

    propValues: PropValues

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

    output: $InferObjectOutput<Shape, Config["out"]>
    input: $InferObjectInput<Shape, Config["in"]>
    optin?: "optional"
    optout?: "optional"

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods