title: Core.z. Zod Map

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

Class: ZodMap<Key, Value>

Core.z.ZodMap

Type parameters

Hierarchy

• ZodType<Map<Key["_output"], Value["_output"]>, ZodMapDef<Key, Value>, Map<Key["_input"], Value["_input"]>>

  ↳ ZodMap

Table of contents

Constructors

• constructor

Properties

• _def
• _input
• _output
• _type
• create
• spa
• ~standard

Accessors

• description
• keySchema
• valueSchema

Methods

• _getOrReturnCtx
• _getType
• _parse
• _parseAsync
• _parseSync
• _processInputParams
• _refinement
• and
• array
• brand
• catch
• default
• describe
• isNullable
• isOptional
• nullable
• nullish
• optional
• or
• parse
• parseAsync
• pipe
• promise
• readonly
• refine
• refinement
• safeParse
• safeParseAsync
• superRefine
• transform
• ~validate

Constructors

constructor

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

Type parameters

Parameters

Returns

ZodMap<Key, Value>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodMapDef<Key, Value>

Inherited from

ZodType._def

_input

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

Inherited from

ZodType._input

_output

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

Inherited from

ZodType._output

_type

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

Inherited from

ZodType._type

create

▪ Static create: <KeySchema, ValueSchema>(keyType: KeySchema, valueType: ValueSchema, params?: RawCreateParams) => ZodMap<KeySchema, ValueSchema>

Type declaration

▸ <KeySchema, ValueSchema>(keyType, valueType, params?): ZodMap<KeySchema, ValueSchema>

Type parameters

Parameters

Returns

ZodMap<KeySchema, ValueSchema>

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<Map<Key["_input"], Value["_input"]>, Map<Key["_output"], Value["_output"]>>>

Alias of safeParseAsync

Type declaration

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

Parameters

Returns

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

Inherited from

ZodType.spa

~standard

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

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

keySchema

• get keySchema(): Key

Returns

Key

valueSchema

• get valueSchema(): Value

Returns

Value

Methods

_getOrReturnCtx

▸ _getOrReturnCtx(input, ctx?): ParseContext

Parameters

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx

_getType

▸ _getType(input): string

Parameters

Returns

string

Inherited from

ZodType._getType

_parse

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

Parameters

Returns

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

Overrides

ZodType._parse

_parseAsync

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

Parameters

Returns

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

Inherited from

ZodType._parseAsync

_parseSync

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

Parameters

Returns

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

Inherited from

ZodType._parseSync

_processInputParams

▸ _processInputParams(input): Object

Parameters

Returns

Object

Inherited from

ZodType._processInputParams

_refinement

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

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, Map<Key["_output"], Value["_output"]>, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType._refinement

and

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

Type parameters

Parameters

Returns

ZodIntersection<ZodMap<Key, Value>, T>

Inherited from

ZodType.and

array

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

Returns

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

Inherited from

ZodType.array

brand

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

Type parameters

Parameters

Returns

ZodBranded<ZodMap<Key, Value>, B>

Inherited from

ZodType.brand

catch

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

Parameters

Returns

ZodCatch<ZodMap<Key, Value>>

Inherited from

ZodType.catch

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

Parameters

Returns

ZodCatch<ZodMap<Key, Value>>

Inherited from

ZodType.catch

default

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

Parameters

Returns

ZodDefault<ZodMap<Key, Value>>

Inherited from

ZodType.default

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

Parameters

Returns

ZodDefault<ZodMap<Key, Value>>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

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<ZodMap<Key, Value>>

Returns

ZodNullable<ZodMap<Key, Value>>

Inherited from

ZodType.nullable

nullish

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

Returns

ZodOptional<ZodNullable<ZodMap<Key, Value>>>

Inherited from

ZodType.nullish

optional

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

Returns

ZodOptional<ZodMap<Key, Value>>

Inherited from

ZodType.optional

or

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

Type parameters

Parameters

Returns

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

Inherited from

ZodType.or

parse

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

Parameters

Returns

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

Inherited from

ZodType.parse

parseAsync

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

Parameters

Returns

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

Inherited from

ZodType.parseAsync

pipe

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

Type parameters

Parameters

Returns

ZodPipeline<ZodMap<Key, Value>, T>

Inherited from

ZodType.pipe

promise

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

Returns

ZodPromise<ZodMap<Key, Value>>

Inherited from

ZodType.promise

readonly

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

Returns

ZodReadonly<ZodMap<Key, Value>>

Inherited from

ZodType.readonly

refine

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

Type parameters

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, RefinedOutput, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.refine

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

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, Map<Key["_output"], Value["_output"]>, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.refine

refinement

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

Type parameters

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, RefinedOutput, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.refinement

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

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, Map<Key["_output"], Value["_output"]>, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.refinement

safeParse

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

Parameters

Returns

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

Inherited from

ZodType.safeParse

safeParseAsync

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

Parameters

Returns

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

Inherited from

ZodType.safeParseAsync

superRefine

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

Type parameters

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, RefinedOutput, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.superRefine

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

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, Map<Key["_output"], Value["_output"]>, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.superRefine

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

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, Map<Key["_output"], Value["_output"]>, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.superRefine

transform

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

Type parameters

Parameters

Returns

ZodEffects<ZodMap<Key, Value>, NewOut, Map<Key["_input"], Value["_input"]>>

Inherited from

ZodType.transform

~validate

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

Parameters

Returns

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

Inherited from

ZodType.~validate