Class ZodMap<Key, Value>

Type Parameters

Key extends z.ZodTypeAny = z.ZodTypeAny
Value extends z.ZodTypeAny = z.ZodTypeAny

Hierarchy (View Summary)

z.ZodType<
    Map<Key["_output"], Value["_output"]>,
    z.ZodMapDef<Key, Value>,
    Map<Key["_input"], Value["_input"]>,
>
- ZodMap

Index

Constructors

constructor

new ZodMap<
    Key extends z.ZodTypeAny = z.ZodTypeAny,
    Value extends z.ZodTypeAny = z.ZodTypeAny,
>(
    def: z.ZodMapDef,
): z.ZodMap<Key, Value>
Type Parameters
- Key extends z.ZodTypeAny = z.ZodTypeAny
- Value extends z.ZodTypeAny = z.ZodTypeAny
Parameters
- def: z.ZodMapDef
Returns z.ZodMap<Key, Value>
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_def

_def: z.ZodMapDef

`Readonly`_input

_input: Map

`Readonly`_output

_output: Map

`Readonly`_type

_type: Map

~standard

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

spa

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

Alias of safeParseAsync

`Static`create

create: <
    KeySchema extends z.ZodTypeAny = z.ZodTypeAny,
    ValueSchema extends z.ZodTypeAny = z.ZodTypeAny,
>(
    keyType: KeySchema,
    valueType: ValueSchema,
    params?: z.RawCreateParams,
) => z.ZodMap<KeySchema, ValueSchema>

Accessors

description

get description(): string | undefined
Returns string | undefined
Inherited from ZodType.description
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:53

keySchema

get keySchema(): Key
Returns Key
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:681

valueSchema

get valueSchema(): Value
Returns Value
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:682

Methods

_getOrReturnCtx

_getOrReturnCtx(input: z.ParseInput, ctx?: z.ParseContext): z.ParseContext
Parameters
- input: z.ParseInput
- Optionalctx: z.ParseContext
Returns z.ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:57

_getType

_getType(input: z.ParseInput): string
Parameters
- input: z.ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:56

_parse

_parse(
input: z.ParseInput,
): z.ParseReturnType<Map<Key["_output"], Value["_output"]>>
Parameters
- input: z.ParseInput
Returns z.ParseReturnType<Map<Key["_output"], Value["_output"]>>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:683

_parseAsync

_parseAsync(
input: z.ParseInput,
): z.AsyncParseReturnType<Map<Key["_output"], Value["_output"]>>
Parameters
- input: z.ParseInput
Returns z.AsyncParseReturnType<Map<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:63

_parseSync

_parseSync(
input: z.ParseInput,
): z.SyncParseReturnType<Map<Key["_output"], Value["_output"]>>
Parameters
- input: z.ParseInput
Returns z.SyncParseReturnType<Map<Key["_output"], Value["_output"]>>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:62

_processInputParams

_processInputParams(
input: z.ParseInput,
): { ctx: z.ParseContext; status: z.ParseStatus }
Parameters
- input: z.ParseInput
Returns { ctx: z.ParseContext; status: z.ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:58

_refinement

_refinement(
    refinement: (arg: Map, ctx: z.RefinementCtx) => any,
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Map, ctx: z.RefinementCtx) => any
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:75

~validate

"~validate"(
    data: unknown,
):
    | Result<Map<Key["_output"], Value["_output"]>>
    | Promise<Result<Map<Key["_output"], Value["_output"]>>>
Parameters
- data: unknown
Returns
| Result<Map<Key["_output"], Value["_output"]>>
| Promise<Result<Map<Key["_output"], Value["_output"]>>>
Inherited from ZodType.~validate
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:66

and

and<T extends z.ZodTypeAny>(
incoming: T,
): z.ZodIntersection<z.ZodMap<Key, Value>, T>
Type Parameters
- T extends z.ZodTypeAny
Parameters
- incoming: T
Returns z.ZodIntersection<z.ZodMap<Key, Value>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:86

array

array(): z.ZodArray<z.ZodMap<Key, Value>>
Returns z.ZodArray<z.ZodMap<Key, Value>>
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:83

brand

brand<B extends string | number | symbol>(
brand?: B,
): z.ZodBranded<z.ZodMap<Key, Value>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns z.ZodBranded<z.ZodMap<Key, Value>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:90

catch

catch(def: Map): z.ZodCatch<z.ZodMap<Key, Value>>
Parameters
- def: Map
Returns z.ZodCatch<z.ZodMap<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:91
catch(
def: (ctx: { error: z.ZodError; input: Map }) => Map,
): z.ZodCatch<z.ZodMap<Key, Value>>
Parameters
- def: (ctx: { error: z.ZodError; input: Map }) => Map
Returns z.ZodCatch<z.ZodMap<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:92

default

default(def: Map<Key["_input"]>): z.ZodDefault<z.ZodMap<Key, Value>>
Parameters
- def: Map<Key["_input"]>
Returns z.ZodDefault<z.ZodMap<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:88
default(def: () => Map<Key["_input"]>): z.ZodDefault<z.ZodMap<Key, Value>>
Parameters
- def: () => Map<Key["_input"]>
Returns z.ZodDefault<z.ZodMap<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:89

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:96

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:100

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:99

nullable

nullable(): z.ZodNullable<z.ZodMap<Key, Value>>
Returns z.ZodNullable<z.ZodMap<Key, Value>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:81

nullish

nullish(): z.ZodOptional<z.ZodNullable<z.ZodMap<Key, Value>>>
Returns z.ZodOptional<z.ZodNullable<z.ZodMap<Key, Value>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:82

optional

optional(): z.ZodOptional<z.ZodMap<Key, Value>>
Returns z.ZodOptional<z.ZodMap<Key, Value>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:80

or

or<T extends z.ZodTypeAny>(option: T): z.ZodUnion<[z.ZodMap<Key, Value>, T]>
Type Parameters
- T extends z.ZodTypeAny
Parameters
- option: T
Returns z.ZodUnion<[z.ZodMap<Key, Value>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:85

parse

parse(data: unknown, params?: z.util.InexactPartial<z.ParseParams>): Map
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns Map
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:64

parseAsync

parseAsync(
data: unknown,
params?: z.util.InexactPartial<z.ParseParams>,
): Promise<Map<Key["_output"], Value["_output"]>>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns Promise<Map<Key["_output"], Value["_output"]>>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:67

pipe

pipe<T extends z.ZodTypeAny>(target: T): z.ZodPipeline<z.ZodMap<Key, Value>, T>
Type Parameters
- T extends z.ZodTypeAny
Parameters
- target: T
Returns z.ZodPipeline<z.ZodMap<Key, Value>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:97

promise

promise(): z.ZodPromise<z.ZodMap<Key, Value>>
Returns z.ZodPromise<z.ZodMap<Key, Value>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:84

readonly

readonly(): z.ZodReadonly<z.ZodMap<Key, Value>>
Returns z.ZodReadonly<z.ZodMap<Key, Value>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:98

refine

refine<RefinedOutput extends Map<Key["_output"], Value["_output"]>>(
    check: (arg: Map) => arg is RefinedOutput,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | ((arg: Map) => z.CustomErrorParams),
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Map<Key["_output"], Value["_output"]>
Parameters
- check: (arg: Map) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
      | ((arg: Map) => z.CustomErrorParams)
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: Map) => unknown,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | ((arg: Map) => z.CustomErrorParams),
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: Map) => unknown
- Optionalmessage:
      | string
      | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
      | ((arg: Map) => z.CustomErrorParams)
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:72

refinement<RefinedOutput extends Map<Key["_output"], Value["_output"]>>(
    check: (arg: Map) => arg is RefinedOutput,
    refinementData:
        | z.IssueData
        | ((arg: Map, ctx: z.RefinementCtx) => z.IssueData),
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Map<Key["_output"], Value["_output"]>
Parameters
- check: (arg: Map) => arg is RefinedOutput
- refinementData: z.IssueData | ((arg: Map, ctx: z.RefinementCtx) => z.IssueData)
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:73
refinement(
    check: (arg: Map) => boolean,
    refinementData:
        | z.IssueData
        | ((arg: Map, ctx: z.RefinementCtx) => z.IssueData),
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: Map) => boolean
- refinementData: z.IssueData | ((arg: Map, ctx: z.RefinementCtx) => z.IssueData)
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:74

safeParse

safeParse(
    data: unknown,
    params?: z.util.InexactPartial<z.ParseParams>,
): z.SafeParseReturnType<
    Map<Key["_input"], Value["_input"]>,
    Map<Key["_output"], Value["_output"]>,
>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns z.SafeParseReturnType<
Map<Key["_input"], Value["_input"]>,
Map<Key["_output"], Value["_output"]>,
>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:65

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: z.util.InexactPartial<z.ParseParams>,
): Promise<
    z.SafeParseReturnType<
        Map<Key["_input"], Value["_input"]>,
        Map<Key["_output"], Value["_output"]>,
    >,
>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns Promise<
    z.SafeParseReturnType<
        Map<Key["_input"], Value["_input"]>,
        Map<Key["_output"], Value["_output"]>,
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:68

superRefine

superRefine<RefinedOutput extends Map<Key["_output"], Value["_output"]>>(
    refinement: (arg: Map, ctx: z.RefinementCtx) => arg is RefinedOutput,
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Map<Key["_output"], Value["_output"]>
Parameters
- refinement: (arg: Map, ctx: z.RefinementCtx) => arg is RefinedOutput
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:76
superRefine(
    refinement: (arg: Map, ctx: z.RefinementCtx) => void,
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Map, ctx: z.RefinementCtx) => void
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:77
superRefine(
    refinement: (arg: Map, ctx: z.RefinementCtx) => Promise<void>,
): z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Map, ctx: z.RefinementCtx) => Promise<void>
Returns z.ZodEffects<
    z.ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:78

transform

transform<NewOut>(
transform: (arg: Map, ctx: z.RefinementCtx) => NewOut | Promise<NewOut>,
): z.ZodEffects<z.ZodMap<Key, Value>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Map, ctx: z.RefinementCtx) => NewOut | Promise<NewOut>
Returns z.ZodEffects<z.ZodMap<Key, Value>, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:87

Class ZodMap<Key, Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns z.ZodMap<Key, Value>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

Staticcreate

Accessors

description

Returns string | undefined

keySchema

Returns Key

valueSchema

Returns Value

Methods

_getOrReturnCtx

Parameters

Returns z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns z.ParseReturnType<Map<Key["_output"], Value["_output"]>>

_parseAsync

Parameters

Returns z.AsyncParseReturnType<Map<Key["_output"], Value["_output"]>>

_parseSync

Parameters

Returns z.SyncParseReturnType<Map<Key["_output"], Value["_output"]>>

_processInputParams

Parameters

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

_refinement

Parameters

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

~validate

Parameters

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

and

Type Parameters

Parameters

Returns z.ZodIntersection<z.ZodMap<Key, Value>, T>

array

Returns z.ZodArray<z.ZodMap<Key, Value>>

brand

Type Parameters

Parameters

Returns z.ZodBranded<z.ZodMap<Key, Value>, B>

catch

Parameters

Returns z.ZodCatch<z.ZodMap<Key, Value>>

Parameters

Returns z.ZodCatch<z.ZodMap<Key, Value>>

default

Parameters

Returns z.ZodDefault<z.ZodMap<Key, Value>>

Parameters

Returns z.ZodDefault<z.ZodMap<Key, Value>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

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

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

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

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

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

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

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

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

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

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

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