@traversable/schema
    Preparing search index...

    Interface ZodRecord

    interface ZodRecord {
        _def: $ZodRecordDef<
            $ZodRecordKey,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >;
        _input: Record<string | number | symbol, unknown>;
        _output: Record<string | number | symbol, unknown>;
        _zod: $ZodRecordInternals;
        "~standard": $ZodStandardSchema<ZodRecord>;
        def: $ZodRecordDef<
            $ZodRecordKey,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >;
        description?: string;
        keyType: $ZodRecordKey;
        spa: (
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ) => Promise<ZodSafeParseResult<Record<string | number | symbol, unknown>>>;
        type: "record";
        valueType: $ZodType;
        and<T extends SomeType>(incoming: T): ZodIntersection<ZodRecord, T>;
        array(): ZodArray<ZodRecord>;
        brand<T extends PropertyKey = PropertyKey>(
            value?: T,
        ): PropertyKey extends T ? ZodRecord : $ZodBranded<ZodRecord, T>;
        catch(def: core.output<this>): ZodCatch<ZodRecord>;
        catch(def: (ctx: $ZodCatchCtx) => core.output<this>): ZodCatch<ZodRecord>;
        check(
            ...checks: (
                | CheckFn<Record<string | number | symbol, unknown>>
                | $ZodCheck<Record<string | number | symbol, unknown>>
            )[],
        ): this;
        clone(
            def?: $ZodRecordDef<
                $ZodRecordKey,
                $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
            >,
            params?: { parent: boolean },
        ): this;
        default(def: core.output<this>): ZodDefault<ZodRecord>;
        default(
            def: () => util.NoUndefined<core.output<this>>,
        ): ZodDefault<ZodRecord>;
        describe(description: string): this;
        isNullable(): boolean;
        isOptional(): boolean;
        meta(): | undefined
        | {
            deprecated?: boolean;
            description?: string;
            id?: string;
            title?: string;
            [key: string]: unknown;
        };
        meta(
            data: {
                deprecated?: boolean;
                description?: string;
                id?: string;
                title?: string;
                [key: string]: unknown;
            },
        ): this;
        nonoptional(
            params?:
                | string
                | {
                    error?: string
                    | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                    message?: string;
                },
        ): ZodNonOptional<ZodRecord>;
        nullable(): ZodNullable<ZodRecord>;
        nullish(): ZodOptional<ZodNullable<ZodRecord>>;
        optional(): ZodOptional<ZodRecord>;
        or<T extends SomeType>(option: T): ZodUnion<[ZodRecord, T]>;
        overwrite(fn: (x: core.output<this>) => core.output<this>): this;
        parse(data: unknown, params?: ParseContext<$ZodIssue>): core.output<this>;
        parseAsync(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): Promise<Record<string | number | symbol, unknown>>;
        pipe<
            T extends
                $ZodType<
                    any,
                    Record<string | number | symbol, unknown>,
                    $ZodTypeInternals<any, Record<string | number | symbol, unknown>>,
                >,
        >(
            target:
                | T
                | $ZodType<
                    any,
                    Record<string | number | symbol, unknown>,
                    $ZodTypeInternals<any, Record<string | number | symbol, unknown>>,
                >,
        ): ZodPipe<ZodRecord, T>;
        prefault(def: () => core.input<this>): ZodPrefault<ZodRecord>;
        prefault(def: core.input<this>): ZodPrefault<ZodRecord>;
        readonly(): ZodReadonly<ZodRecord>;
        refine(
            check: (arg: core.output<this>) => unknown,
            params?:
                | string
                | {
                    abort?: boolean;
                    error?: string
                    | $ZodErrorMap<NonNullable<$ZodIssue>>;
                    message?: string;
                    params?: Record<string, any>;
                    path?: PropertyKey[];
                    when?: (payload: ParsePayload) => boolean;
                },
        ): this;
        register<
            R extends
                $ZodRegistry<
                    MetadataType,
                    $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
                >,
        >(
            registry: R,
            ...meta: ZodRecord extends R["_schema"]
                ? undefined extends R["_meta"]
                    ? [$replace<R["_meta"], R["_schema"] & ZodRecord>?]
                    : [$replace<R["_meta"], R["_schema"] & ZodRecord>]
                : ["Incompatible schema"],
        ): this;
        safeParse(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): ZodSafeParseResult<Record<string | number | symbol, unknown>>;
        safeParseAsync(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): Promise<ZodSafeParseResult<Record<string | number | symbol, unknown>>>;
        superRefine(
            refinement: (
                arg: core.output<this>,
                ctx: RefinementCtx<Record<string | number | symbol, unknown>>,
            ) => void | Promise<void>,
        ): this;
        transform<NewOut>(
            transform: (
                arg: core.output<this>,
                ctx: RefinementCtx<Record<string | number | symbol, unknown>>,
            ) => NewOut | Promise<NewOut>,
        ): ZodPipe<
            ZodRecord,
            ZodTransform<Awaited<NewOut>, Record<string | number | symbol, unknown>>,
        >;
    }

    Hierarchy

    • ZodRecord
      • ZodRecord
    Index

    Properties

    _def _input _output _zod ~standard def description? keyType spa type valueType

    Methods

    and array brand catch check clone default describe isNullable isOptional meta nonoptional nullable nullish optional or overwrite parse parseAsync pipe prefault readonly refine register safeParse safeParseAsync superRefine transform

    Properties

    _def

    _def: $ZodRecordDef<
        $ZodRecordKey,
        $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    >

    Use .def instead.

    _input

    _input: Record<string | number | symbol, unknown>

    Use z.input<typeof schema> instead.

    _output

    _output: Record<string | number | symbol, unknown>

    Use z.output<typeof schema> instead.

    _zod

    _zod: $ZodRecordInternals
    "~standard": $ZodStandardSchema<ZodRecord>
    def: $ZodRecordDef<
        $ZodRecordKey,
        $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    >
    description?: string
    keyType: $ZodRecordKey
    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<Record<string | number | symbol, unknown>>>
    type: "record"
    valueType: $ZodType

    Methods

    • Type Parameters

      • T extends SomeType

      Parameters

      • incoming: T

      Returns ZodIntersection<ZodRecord, T>

    • Returns ZodArray<ZodRecord>

    • Type Parameters

      • T extends PropertyKey = PropertyKey

      Parameters

      • Optionalvalue: T

      Returns PropertyKey extends T ? ZodRecord : $ZodBranded<ZodRecord, T>

    • Parameters

      • def: core.output<this>

      Returns ZodCatch<ZodRecord>

    • Parameters

      • def: (ctx: $ZodCatchCtx) => core.output<this>

      Returns ZodCatch<ZodRecord>

    • Parameters

      • ...checks: (
            | CheckFn<Record<string | number | symbol, unknown>>
            | $ZodCheck<Record<string | number | symbol, unknown>>
        )[]

      Returns this

    • Parameters

      • Optionaldef: $ZodRecordDef<
            $ZodRecordKey,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >
      • Optionalparams: { parent: boolean }

      Returns this

    • Parameters

      • def: core.output<this>

      Returns ZodDefault<ZodRecord>

    • Parameters

      • def: () => util.NoUndefined<core.output<this>>

      Returns ZodDefault<ZodRecord>

    • Returns a new instance that has been registered in z.globalRegistry with the specified description

      Parameters

      • description: string

      Returns this

    • Returns boolean

      Try safe-parsing null (this is what isNullable does internally):

      const schema = z.string().nullable();
      const isNullable = schema.safeParse(null).success; // true

    • Returns boolean

      Try safe-parsing undefined (this is what isOptional does internally):

      const schema = z.string().optional();
      const isOptional = schema.safeParse(undefined).success; // true

    • Returns the metadata associated with this instance in z.globalRegistry

      Returns
          | undefined
          | {
              deprecated?: boolean;
              description?: string;
              id?: string;
              title?: string;
              [key: string]: unknown;
          }

    • Returns a new instance that has been registered in z.globalRegistry with the specified metadata

      Parameters

      • data: {
            deprecated?: boolean;
            description?: string;
            id?: string;
            title?: string;
            [key: string]: unknown;
        }

      Returns this

    • Parameters

      • Optionalparams:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            }
        • string
        • {
              error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
          • Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>
          • Optionalmessage?: string

            This parameter is deprecated. Use error instead.

      Returns ZodNonOptional<ZodRecord>

    • Returns ZodNullable<ZodRecord>

    • Returns ZodOptional<ZodNullable<ZodRecord>>

    • Returns ZodOptional<ZodRecord>

    • Type Parameters

      • T extends SomeType

      Parameters

      • option: T

      Returns ZodUnion<[ZodRecord, T]>

    • Parameters

      • fn: (x: core.output<this>) => core.output<this>

      Returns this

    • Parameters

      • data: unknown
      • Optionalparams: ParseContext<$ZodIssue>

      Returns core.output<this>

    • Parameters

      • data: unknown
      • Optionalparams: ParseContext<$ZodIssue>

      Returns Promise<Record<string | number | symbol, unknown>>

    • Type Parameters

      • T extends $ZodType<
            any,
            Record<string | number | symbol, unknown>,
            $ZodTypeInternals<any, Record<string | number | symbol, unknown>>,
        >

      Parameters

      • target:
            | T
            | $ZodType<
                any,
                Record<string | number | symbol, unknown>,
                $ZodTypeInternals<any, Record<string | number | symbol, unknown>>,
            >

      Returns ZodPipe<ZodRecord, T>

    • Parameters

      • def: () => core.input<this>

      Returns ZodPrefault<ZodRecord>

    • Parameters

      • def: core.input<this>

      Returns ZodPrefault<ZodRecord>

    • Returns ZodReadonly<ZodRecord>

    • Parameters

      • check: (arg: core.output<this>) => unknown
      • Optionalparams:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<NonNullable<$ZodIssue>>;
                message?: string;
                params?: Record<string, any>;
                path?: PropertyKey[];
                when?: (payload: ParsePayload) => boolean;
            }
        • string
        • {
              abort?: boolean;
              error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
              message?: string;
              params?: Record<string, any>;
              path?: PropertyKey[];
              when?: (payload: ParsePayload) => boolean;
          }
          • Optionalabort?: boolean

            If true, no later checks will be executed if this check fails. Default false.

          • Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
          • Optionalmessage?: string

            This parameter is deprecated. Use error instead.

          • Optionalparams?: Record<string, any>
          • Optionalpath?: PropertyKey[]
          • Optionalwhen?: (payload: ParsePayload) => boolean

            If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).

      Returns this

    • Type Parameters

      • R extends $ZodRegistry<
            MetadataType,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >

      Parameters

      • registry: R
      • ...meta: ZodRecord extends R["_schema"]
            ? undefined extends R["_meta"]
                ? [$replace<R["_meta"], R["_schema"] & ZodRecord>?]
                : [$replace<R["_meta"], R["_schema"] & ZodRecord>]
            : ["Incompatible schema"]

      Returns this

    • Parameters

      • data: unknown
      • Optionalparams: ParseContext<$ZodIssue>

      Returns ZodSafeParseResult<Record<string | number | symbol, unknown>>

    • Parameters

      • data: unknown
      • Optionalparams: ParseContext<$ZodIssue>

      Returns Promise<ZodSafeParseResult<Record<string | number | symbol, unknown>>>

    • Parameters

      • refinement: (
            arg: core.output<this>,
            ctx: RefinementCtx<Record<string | number | symbol, unknown>>,
        ) => void | Promise<void>

      Returns this

      Use .check() instead.

    • Type Parameters

      • NewOut

      Parameters

      • transform: (
            arg: core.output<this>,
            ctx: RefinementCtx<Record<string | number | symbol, unknown>>,
        ) => NewOut | Promise<NewOut>

      Returns ZodPipe<
          ZodRecord,
          ZodTransform<Awaited<NewOut>, Record<string | number | symbol, unknown>>,
      >

    Settings

    Member Visibility

    On This Page

    Properties
    Methods