title: Core.z. Zod Record

A2A Node SDK - v0.1.0 / Modules / Core / z / ZodRecord

Class: ZodRecord<Key, Value>

Core.z.ZodRecord

Type parameters

Name	Type
`Key`	extends `KeySchema` = `ZodString`
`Value`	extends `ZodTypeAny` = `ZodTypeAny`

Hierarchy

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

↳ ZodRecord

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new ZodRecord<Key, Value>(def): ZodRecord<Key, Value>

Type parameters

Name	Type
`Key`	extends `KeySchema` = `ZodString`
`Value`	extends `ZodTypeAny` = `ZodTypeAny`

Parameters

Name	Type
`def`	`ZodRecordDef`<`Key`, `Value`>

Returns

ZodRecord<Key, Value>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodRecordDef<Key, Value>

Inherited from

ZodType._def

_input

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

Inherited from

ZodType._input

_output

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

Inherited from

ZodType._output

_type

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

Inherited from

ZodType._type

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => 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

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

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

Inherited from

ZodType.spa

~standard

• ~standard: Props<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>

Inherited from

ZodType.~standard

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, ctx?): ParseContext

Parameters

Name	Type
`input`	`ParseInput`
`ctx?`	`ParseContext`

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx

_getType

▸ _getType(input): string

Parameters

Name	Type
`input`	`ParseInput`

Returns

string

Inherited from

ZodType._getType

_parse

▸ _parse(input): ParseReturnType<RecordType<Key["_output"], Value["_output"]>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

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

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

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

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<RecordType<Key["_output"], Value["_output"]>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

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

Inherited from

ZodType._parseSync

_processInputParams

▸ _processInputParams(input): Object

Parameters

Name	Type
`input`	`ParseInput`

Returns

Object

Name	Type
`ctx`	`ParseContext`
`status`	`ParseStatus`

Inherited from

ZodType._processInputParams

_refinement

▸ _refinement(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>

Parameters

Name	Type
`refinement`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `any`

Returns

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

Inherited from

ZodType._refinement

and

▸ and<T>(incoming): ZodIntersection<ZodRecord<Key, Value>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodRecord<Key, Value>, T>

Inherited from

ZodType.and

array

▸ array(): ZodArray<ZodRecord<Key, Value>, "many">

Returns

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

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodRecord<Key, Value>, B>

Type parameters

Name	Type
`B`	extends `string` \| `number` \| `symbol`

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodRecord<Key, Value>, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodRecord<Key, Value>>

Parameters

Name	Type
`def`	`RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>

Returns

ZodCatch<ZodRecord<Key, Value>>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodRecord<Key, Value>>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `RecordType`<`Key`[`"_input"`], `Value`[`"_input"`]> }) => `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>

Returns

ZodCatch<ZodRecord<Key, Value>>

Inherited from

ZodType.catch

create

▸ create<Value>(valueType, params?): ZodRecord<ZodString, Value>

Type parameters

Name	Type
`Value`	extends `ZodTypeAny`

Parameters

Name	Type
`valueType`	`Value`
`params?`	`RawCreateParams`

Returns

ZodRecord<ZodString, Value>

▸ create<Keys, Value>(keySchema, valueType, params?): ZodRecord<Keys, Value>

Type parameters

Name	Type
`Keys`	extends `KeySchema`
`Value`	extends `ZodTypeAny`

Parameters

Name	Type
`keySchema`	`Keys`
`valueType`	`Value`
`params?`	`RawCreateParams`

Returns

ZodRecord<Keys, Value>

default

▸ default(def): ZodDefault<ZodRecord<Key, Value>>

Parameters

Name	Type
`def`	`noUndefined`<`RecordType`<`Key`[`"_input"`], `Value`[`"_input"`]>>

Returns

ZodDefault<ZodRecord<Key, Value>>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodRecord<Key, Value>>

Parameters

Name	Type
`def`	() => `noUndefined`<`RecordType`<`Key`[`"_input"`], `Value`[`"_input"`]>>

Returns

ZodDefault<ZodRecord<Key, Value>>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`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(): ZodNullable<ZodRecord<Key, Value>>

Returns

ZodNullable<ZodRecord<Key, Value>>

Inherited from

ZodType.nullable

nullish

▸ nullish(): ZodOptional<ZodNullable<ZodRecord<Key, Value>>>

Returns

ZodOptional<ZodNullable<ZodRecord<Key, Value>>>

Inherited from

ZodType.nullish

optional

▸ optional(): ZodOptional<ZodRecord<Key, Value>>

Returns

ZodOptional<ZodRecord<Key, Value>>

Inherited from

ZodType.optional

or

▸ or<T>(option): ZodUnion<[ZodRecord<Key, Value>, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodRecord<Key, Value>, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): RecordType<Key["_output"], Value["_output"]>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

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

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<RecordType<Key["_output"], Value["_output"]>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

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

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodRecord<Key, Value>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodRecord<Key, Value>, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodRecord<Key, Value>>

Returns

ZodPromise<ZodRecord<Key, Value>>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodRecord<Key, Value>>

Returns

ZodReadonly<ZodRecord<Key, Value>>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>

Type parameters

Name	Type
`RefinedOutput`	extends `Record`<`Key`[`"_output"`], `Value`[`"_output"`]> \| `Partial`<`Record`<`Key`[`"_output"`], `Value`[`"_output"`]>>

Parameters

Name	Type
`check`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => arg is RefinedOutput
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

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

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>

Parameters

Name	Type
`check`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

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

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>

Type parameters

Name	Type
`RefinedOutput`	extends `Record`<`Key`[`"_output"`], `Value`[`"_output"`]> \| `Partial`<`Record`<`Key`[`"_output"`], `Value`[`"_output"`]>>

Parameters

Name	Type
`check`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

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

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>

Parameters

Name	Type
`check`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

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

Inherited from

ZodType.refinement

safeParse

▸ safeParse(data, params?): SafeParseReturnType<RecordType<Key["_input"], Value["_input"]>, RecordType<Key["_output"], Value["_output"]>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

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

Inherited from

ZodType.safeParse

safeParseAsync

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

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

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

Inherited from

ZodType.safeParseAsync

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodRecord<Key, Value>, RefinedOutput, RecordType<Key["_input"], Value["_input"]>>

Type parameters

Name	Type
`RefinedOutput`	extends `Record`<`Key`[`"_output"`], `Value`[`"_output"`]> \| `Partial`<`Record`<`Key`[`"_output"`], `Value`[`"_output"`]>>

Parameters

Name	Type
`refinement`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

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

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>

Parameters

Name	Type
`refinement`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `void`

Returns

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

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodRecord<Key, Value>, RecordType<Key["_output"], Value["_output"]>, RecordType<Key["_input"], Value["_input"]>>

Parameters

Name	Type
`refinement`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

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

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodRecord<Key, Value>, NewOut, RecordType<Key["_input"], Value["_input"]>>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `RecordType`<`Key`[`"_output"`], `Value`[`"_output"`]>, `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

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

Inherited from

ZodType.transform

~validate

▸ ~validate(data): Result<RecordType<Key["_output"], Value["_output"]>> | Promise<Result<RecordType<Key["_output"], Value["_output"]>>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<RecordType<Key["_output"], Value["_output"]>> | Promise<Result<RecordType<Key["_output"], Value["_output"]>>>

Inherited from

ZodType.~validate

z.ZodReadonly z.ZodSet

title: Core.z. Zod Record

Class: ZodRecord<Key, Value>

Type parameters

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Properties

_def

Inherited from

_input

Inherited from

_output

Inherited from

_type

Inherited from

spa

Type declaration

Parameters

Returns

Inherited from

~standard

Inherited from

Accessors

description

Returns

Inherited from

element

Returns

keySchema

Returns

valueSchema

Returns

Methods

_getOrReturnCtx

Parameters

Returns

Inherited from

_getType

Parameters

Returns

Inherited from

_parse

Parameters

Returns

Overrides

_parseAsync

Parameters

Returns

Inherited from

_parseSync

Parameters

Returns

Inherited from

_processInputParams

Parameters

Returns

Inherited from

_refinement

Parameters

Returns

Inherited from

and

Type parameters

Parameters

Returns

Inherited from

array

Returns

Inherited from

brand

Type parameters