Class ZodRecord<Key, Value>

Type Parameters

Key extends Zod.KeySchema = Zod.ZodString
Value extends Zod.ZodTypeAny = Zod.ZodTypeAny

Hierarchy (View Summary)

Zod.ZodType<
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.ZodRecordDef<Key, Value>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
- ZodRecord

Index

Constructors

constructor

new ZodRecord<
    Key extends Zod.KeySchema = Zod.ZodString,
    Value extends Zod.ZodTypeAny = Zod.ZodTypeAny,
>(
    def: Zod.ZodRecordDef,
): Zod.ZodRecord<Key, Value>
Type Parameters
- Key extends Zod.KeySchema = Zod.ZodString
- Value extends Zod.ZodTypeAny = Zod.ZodTypeAny
Parameters
- def: Zod.ZodRecordDef
Returns Zod.ZodRecord<Key, Value>
Inherited from ZodType.constructor

Properties

spa

spa: (
    data: unknown,
    params?: Partial<Zod.ParseParams>,
) => Promise<
    Zod.SafeParseReturnType<
        Zod.RecordType<Key["_input"], Value["_input"]>,
        Zod.RecordType<Key["_output"], Value["_output"]>,
    >,
>

Alias of safeParseAsync

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

element

get element(): Value
Returns Value

keySchema

get keySchema(): Key
Returns Key

valueSchema

get valueSchema(): Value
Returns Value

Methods

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_parse

_parse(
input: Zod.ParseInput,
): Zod.ParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>
Overrides ZodType._parse

_parseAsync

_parseAsync(
input: Zod.ParseInput,
): Zod.AsyncParseReturnType<
Zod.RecordType<Key["_output"], Value["_output"]>,
>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(
input: Zod.ParseInput,
): Zod.SyncParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseSync

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
    refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodRecord<Key, Value>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodRecord<Key, Value>, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodRecord<Key, Value>>
Returns Zod.ZodArray<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodRecord<Key, Value>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodRecord<Key, Value>, B>
Inherited from ZodType.brand

catch

catch(def: Zod.RecordType): Zod.ZodCatch<Zod.ZodRecord<Key, Value>>
Parameters
- def: Zod.RecordType
Returns Zod.ZodCatch<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.catch
catch(
    def: (
        ctx: { error: Zod.ZodError; input: Zod.RecordType },
    ) => Zod.RecordType,
): Zod.ZodCatch<Zod.ZodRecord<Key, Value>>
Parameters
- def: (ctx: { error: Zod.ZodError; input: Zod.RecordType }) => Zod.RecordType
Returns Zod.ZodCatch<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.catch

default

default(
def: noUndefined<Zod.RecordType<Key["_input"], Value["_input"]>>,
): Zod.ZodDefault<Zod.ZodRecord<Key, Value>>
Parameters
- def: noUndefined<Zod.RecordType<Key["_input"], Value["_input"]>>
Returns Zod.ZodDefault<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.default
default(
def: () => noUndefined<Zod.RecordType<Key["_input"], Value["_input"]>>,
): Zod.ZodDefault<Zod.ZodRecord<Key, Value>>
Parameters
- def: () => noUndefined<Zod.RecordType<Key["_input"], Value["_input"]>>
Returns Zod.ZodDefault<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

nullable

nullable(): Zod.ZodNullable<Zod.ZodRecord<Key, Value>>
Returns Zod.ZodNullable<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodRecord<Key, Value>>>
Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodRecord<Key, Value>>>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodRecord<Key, Value>>
Returns Zod.ZodOptional<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.optional

or

or<T extends Zod.ZodTypeAny>(
option: T,
): Zod.ZodUnion<[Zod.ZodRecord<Key, Value>, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodRecord<Key, Value>, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): Zod.RecordType
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.RecordType
Inherited from ZodType.parse

parseAsync

parseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.RecordType<Key["_output"], Value["_output"]>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(
target: T,
): Zod.ZodPipeline<Zod.ZodRecord<Key, Value>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodRecord<Key, Value>, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodRecord<Key, Value>>
Returns Zod.ZodPromise<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodRecord<Key, Value>>
Returns Zod.ZodReadonly<Zod.ZodRecord<Key, Value>>
Inherited from ZodType.readonly

refine

refine<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    check: (arg: Zod.RecordType) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Zod.RecordType) => Zod.CustomErrorParams),
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends
  | Record<Key["_output"], Value["_output"]>
  | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- check: (arg: Zod.RecordType) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Zod.RecordType) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
refine(
    check: (arg: Zod.RecordType) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Zod.RecordType) => Zod.CustomErrorParams),
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: Zod.RecordType) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Zod.RecordType) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine

refinement<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    check: (arg: Zod.RecordType) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: Zod.RecordType, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends
  | Record<Key["_output"], Value["_output"]>
  | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- check: (arg: Zod.RecordType) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: Zod.RecordType, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refinement
refinement(
    check: (arg: Zod.RecordType) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: Zod.RecordType, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: Zod.RecordType) => boolean
- refinementData: Zod.IssueData | ((arg: Zod.RecordType, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refinement

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<
    Zod.RecordType<Key["_input"], Value["_input"]>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<
Zod.RecordType<Key["_input"], Value["_input"]>,
Zod.RecordType<Key["_output"], Value["_output"]>,
>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Promise<
    Zod.SafeParseReturnType<
        Zod.RecordType<Key["_input"], Value["_input"]>,
        Zod.RecordType<Key["_output"], Value["_output"]>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<
    Zod.SafeParseReturnType<
        Zod.RecordType<Key["_input"], Value["_input"]>,
        Zod.RecordType<Key["_output"], Value["_output"]>,
    >,
>
Inherited from ZodType.safeParseAsync

superRefine

superRefine<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    refinement: (
        arg: Zod.RecordType,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends
  | Record<Key["_output"], Value["_output"]>
  | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    RefinedOutput,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
superRefine(
    refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
superRefine(
    refinement: (
        arg: Zod.RecordType,
        ctx: Zod.RefinementCtx,
    ) => Promise<void>,
): Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<
    Zod.ZodRecord<Key, Value>,
    Zod.RecordType<Key["_output"], Value["_output"]>,
    Zod.RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine

transform

transform<NewOut>(
    transform: (
        arg: Zod.RecordType,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodRecord<Key, Value>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Zod.RecordType, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodRecord<Key, Value>, NewOut>
Inherited from ZodType.transform

`Static`create

create<Value extends Zod.ZodTypeAny>(
valueType: Value,
params?: Zod.RawCreateParams,
): Zod.ZodRecord<Zod.ZodString, Value>
Type Parameters
- Value extends Zod.ZodTypeAny
Parameters
- valueType: Value
- Optionalparams: Zod.RawCreateParams
Returns Zod.ZodRecord<Zod.ZodString, Value>
create<Keys extends Zod.KeySchema, Value extends Zod.ZodTypeAny>(
    keySchema: Keys,
    valueType: Value,
    params?: Zod.RawCreateParams,
): Zod.ZodRecord<Keys, Value>
Type Parameters
- Keys extends Zod.KeySchema
- Value extends Zod.ZodTypeAny
Parameters
- keySchema: Keys
- valueType: Value
- Optionalparams: Zod.RawCreateParams
Returns Zod.ZodRecord<Keys, Value>

Class ZodRecord<Key, Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.ZodRecord<Key, Value>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Accessors

description

Returns undefined | string

element

Returns Value

keySchema

Returns Key

valueSchema

Returns Value

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<Zod.RecordType<Key["_output"], Value["_output"]>>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

Returns Zod.ZodEffects< Zod.ZodRecord<Key, Value>, Zod.RecordType<Key["_output"], Value["_output"]>, Zod.RecordType<Key["_input"], Value["_input"]>,>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodRecord<Key, Value>, T>

array

Returns Zod.ZodArray<Zod.ZodRecord<Key, Value>>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodRecord<Key, Value>, B>

catch

Parameters

Returns Zod.ZodCatch<Zod.ZodRecord<Key, Value>>

Parameters

Returns Zod.ZodCatch<Zod.ZodRecord<Key, Value>>

default

Parameters

Returns Zod.ZodDefault<Zod.ZodRecord<Key, Value>>

Parameters

Returns Zod.ZodDefault<Zod.ZodRecord<Key, Value>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns Zod.ZodNullable<Zod.ZodRecord<Key, Value>>

nullish

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
Zod.RecordType<Key["_output"], Value["_output"]>,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
RefinedOutput,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
Zod.RecordType<Key["_output"], Value["_output"]>,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
RefinedOutput,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
Zod.RecordType<Key["_output"], Value["_output"]>,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.SafeParseReturnType<
Zod.RecordType<Key["_input"], Value["_input"]>,
Zod.RecordType<Key["_output"], Value["_output"]>,
>

Returns Promise<
Zod.SafeParseReturnType<
Zod.RecordType<Key["_input"], Value["_input"]>,
Zod.RecordType<Key["_output"], Value["_output"]>,
>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
RefinedOutput,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
Zod.RecordType<Key["_output"], Value["_output"]>,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

Returns Zod.ZodEffects<
Zod.ZodRecord<Key, Value>,
Zod.RecordType<Key["_output"], Value["_output"]>,
Zod.RecordType<Key["_input"], Value["_input"]>,
>

`Static`create