Class ZodRecord<Key, Value>

Type Parameters

Key extends KeySchema = ZodString
Value extends ZodTypeAny = ZodTypeAny

Hierarchy (view full)

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

Index

Constructors

constructor

new ZodRecord<Key, Value>(def): ZodRecord<Key, Value>
Type Parameters
- Key extends KeySchema = ZodString
- Value extends ZodTypeAny = ZodTypeAny
Parameters
- def: ZodRecordDef<Key, Value>
Returns ZodRecord<Key, Value>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly` _def

_def: ZodRecordDef<Key, Value>

`Readonly` _input

_input: RecordType<Key["_input"], Value["_input"]>

`Readonly` _output

_output: RecordType<Key["_output"], Value["_output"]>

`Readonly` _type

_type: RecordType<Key["_output"], Value["_output"]>

spa

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

Alias of safeParseAsync

Type declaration

- (data, params?): Promise<SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>>

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/zod/lib/types.d.ts:49

element

get element(): Value
Returns Value
- Defined in node_modules/zod/lib/types.d.ts:641

keySchema

get keySchema(): Key
Returns Key
- Defined in node_modules/zod/lib/types.d.ts:638

valueSchema

get valueSchema(): Value
Returns Value
- Defined in node_modules/zod/lib/types.d.ts:639

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

_getType(input): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:51

_parse

_parse(input): ParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Parameters
- input: ParseInput
Returns ParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:640

_parseAsync

_parseAsync(input): AsyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input): SyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Parameters
- input: ParseInput
Returns SyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:57

_processInputParams

_processInputParams(input): {
ctx: ParseContext;
status: ParseStatus;
}
Parameters
- input: ParseInput
Returns {
ctx: ParseContext;
status: ParseStatus;
}
- ctx: ParseContext
- status: ParseStatus
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Parameters
- refinement: ((arg, ctx) => any)
  - - (arg, ctx): any
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      ctx: RefinementCtx
      Returns any
Returns ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

and<T>(incoming): ZodIntersection<ZodRecord<Key, Value>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodRecord<Key, Value>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:80

array

array(): ZodArray<ZodRecord<Key, Value>, "many">
Returns ZodArray<ZodRecord<Key, Value>, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:77

brand

brand<B>(brand?): ZodBranded<ZodRecord<Key, Value>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodRecord<Key, Value>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

catch(def): ZodCatch<ZodRecord<Key, Value>>
Parameters
- def: RecordType<Key["_output"], Value["_output"]>
Returns ZodCatch<ZodRecord<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(def): ZodCatch<ZodRecord<Key, Value>>
Parameters
- def: ((ctx) => RecordType<Key["_output"], Value["_output"]>)
  - - (ctx): RecordType<Key["_output"], Value["_output"]>
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: RecordType<Key["_input"], Value["_input"]>;
      }
      error: ZodError<any>
      input: RecordType<Key["_input"], Value["_input"]>
      Returns RecordType<Key["_output"], Value["_output"]>
Returns ZodCatch<ZodRecord<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

default

default(def): ZodDefault<ZodRecord<Key, Value>>
Parameters
- def: noUndefined<RecordType<Key["_input"], Value["_input"]>>
Returns ZodDefault<ZodRecord<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(def): ZodDefault<ZodRecord<Key, Value>>
Parameters
- def: (() => noUndefined<RecordType<Key["_input"], Value["_input"]>>)
  - - (): noUndefined<RecordType<Key["_input"], Value["_input"]>>
    - Returns noUndefined<RecordType<Key["_input"], Value["_input"]>>
Returns ZodDefault<ZodRecord<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:83

describe

describe(description): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:90

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/lib/types.d.ts:94

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/lib/types.d.ts:93

nullable

nullable(): ZodNullable<ZodRecord<Key, Value>>
Returns ZodNullable<ZodRecord<Key, Value>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

nullish(): ZodOptional<ZodNullable<ZodRecord<Key, Value>>>
Returns ZodOptional<ZodNullable<ZodRecord<Key, Value>>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:76

optional

optional(): ZodOptional<ZodRecord<Key, Value>>
Returns ZodOptional<ZodRecord<Key, Value>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:74

or

or<T>(option): ZodUnion<[ZodRecord<Key, Value>, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[ZodRecord<Key, Value>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:79

parse

parse(data, params?): RecordType<Key["_output"], Value["_output"]>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns RecordType<Key["_output"], Value["_output"]>
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data, params?): Promise<RecordType<Key["_output"], Value["_output"]>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/lib/types.d.ts:61

pipe

pipe<T>(target): ZodPipeline<ZodRecord<Key, Value>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodRecord<Key, Value>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:91

promise

promise(): ZodPromise<ZodRecord<Key, Value>>
Returns ZodPromise<ZodRecord<Key, Value>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

readonly(): ZodReadonly<ZodRecord<Key, Value>>
Returns ZodReadonly<ZodRecord<Key, Value>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

refine<RefinedOutput>(check, message?): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Type Parameters
- RefinedOutput extends Record<Key["_output"], Value["_output"]> | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:65
refine(check, message?): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Parameters
- check: ((arg) => unknown)
  - - (arg): unknown
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Type Parameters
- RefinedOutput extends Record<Key["_output"], Value["_output"]> | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check, refinementData): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Parameters
- check: ((arg) => boolean)
  - - (arg): boolean
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      Returns boolean
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

safeParse

safeParse(data, params?): SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Type Parameters
- RefinedOutput extends Record<Key["_output"], Value["_output"]> | Partial<Record<Key["_output"], Value["_output"]>>
Parameters
- refinement: ((arg, ctx) => arg is RefinedOutput)
  - - (arg, ctx): arg is RefinedOutput
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      ctx: RefinementCtx
      Returns arg is RefinedOutput
Returns ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Parameters
- refinement: ((arg, ctx) => void)
  - - (arg, ctx): void
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      ctx: RefinementCtx
      Returns void
Returns ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71
superRefine(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Parameters
- refinement: ((arg, ctx) => Promise<void>)
  - - (arg, ctx): Promise<void>
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:72

transform

transform<NewOut>(transform): ZodEffects<ZodRecord<Key, Value>, NewOut, RecordType<Key["_input"], Value["_input"]>>
Type Parameters
- NewOut
Parameters
- transform: ((arg, ctx) => NewOut | Promise<NewOut>)
  - - (arg, ctx): NewOut | Promise<NewOut>
    - Parameters
      arg: RecordType<Key["_output"], Value["_output"]>
      ctx: RefinementCtx
      Returns NewOut | Promise<NewOut>
Returns ZodEffects<ZodRecord<Key, Value>, NewOut, RecordType<Key["_input"], Value["_input"]>>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:81

`Static` create

create<Value>(valueType, params?): ZodRecord<ZodString, Value>
Type Parameters
- Value extends ZodTypeAny
Parameters
- valueType: Value
- Optional params: RawCreateParams
Returns ZodRecord<ZodString, Value>
- Defined in node_modules/zod/lib/types.d.ts:642
create<Keys, Value>(keySchema, valueType, params?): ZodRecord<Keys, Value>
Type Parameters
- Keys extends KeySchema
- Value extends ZodTypeAny
Parameters
- keySchema: Keys
- valueType: Value
- Optional params: RawCreateParams
Returns ZodRecord<Keys, Value>
- Defined in node_modules/zod/lib/types.d.ts:643

Class ZodRecord<Key, Value>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodRecord<Key, Value>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

Accessors

description

Returns undefined | string

element

Returns Value

keySchema

Returns Key

valueSchema

Returns Value

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

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

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

and

Type Parameters

Parameters

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

array

Returns ZodArray<ZodRecord<Key, Value>, "many">

brand

Type Parameters

Parameters

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

catch

Parameters

Returns ZodCatch<ZodRecord<Key, Value>>

Parameters

Parameters

error: ZodError<any>

input: RecordType<Key["_input"], Value["_input"]>

Returns RecordType<Key["_output"], Value["_output"]>

Returns ZodCatch<ZodRecord<Key, Value>>

default

Parameters

Returns ZodDefault<ZodRecord<Key, Value>>

Parameters

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

Returns {
ctx: ParseContext;
status: ParseStatus;
}