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

    Interface $ZodStringFormatInternals<Format>Internal

    interface $ZodStringFormatInternals<Format extends string = string> {
        check(payload: ParsePayload<string>): MaybeAsync<void>;
        onattach: ((schema: $ZodType) => void)[];
        issc: $ZodIssueInvalidStringFormat;
        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>;
        optin?: "optional";
        optout?: "optional";
        values?: PrimitiveSet;
        propValues?: PropValues;
        constr: new (def: any) => $ZodType;
        toJSONSchema?: () => unknown;
        parent?: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        output: string;
        input: string;
        pattern: RegExp;
        isst: $ZodIssueInvalidType;
        bag: LoosePartial<
            {
                minimum: number;
                maximum: number;
                patterns: Set<RegExp>;
                format: string;
                contentEncoding: string;
            },
        >;
        def: $ZodStringFormatDef<Format>;
    }

    Type Parameters

    • Format extends string = string

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    check run parse

    Properties

    onattach: ((schema: $ZodType) => void)[]
    issc: $ZodIssueInvalidStringFormat

    The set of issues this check might throw.

    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.

    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.

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

    The constructor function of this schema.

    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: string

    The inferred output type

    input: string

    The inferred input type

    pattern: RegExp

    Internal API, use with caution (not deprecated)

    isst: $ZodIssueInvalidType

    Internal API, use with caution (not deprecated)

    bag: LoosePartial<
        {
            minimum: number;
            maximum: number;
            patterns: Set<RegExp>;
            format: string;
            contentEncoding: string;
        },
    >

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

    def: $ZodStringFormatDef<Format>

    Schema definition.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods