Class ZodMap<Key, Value>

Type Parameters

Key extends ZodTypeAny = ZodTypeAny
Value extends ZodTypeAny = ZodTypeAny

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodMap<
    Key extends ZodType<any, any, any, Key> = ZodTypeAny,
    Value extends ZodType<any, any, any, Value> = ZodTypeAny,
>(
    def: ZodMapDef<Key, Value>,
): ZodMap<Key, Value>
Type Parameters
- Key extends ZodType<any, any, any, Key> = ZodTypeAny
- Value extends ZodType<any, any, any, Value> = ZodTypeAny
Parameters
- def: ZodMapDef<Key, Value>
Returns ZodMap<Key, Value>
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:76

Properties

`Readonly`_def

_def: ZodMapDef<Key, Value>

`Readonly`_input

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

`Readonly`_output

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

`Readonly`_type

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

spa

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

Alias of safeParseAsync

`Static`create

create: <
    Key_1 extends ZodType<any, any, any, Key_1> = ZodTypeAny,
    Value_1 extends ZodType<any, any, any, Value_1> = ZodTypeAny,
>(
    keyType: Key_1,
    valueType: Value_1,
    params?: RawCreateParams,
) => ZodMap<Key_1, Value_1>

Accessors

description

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

keySchema

get keySchema(): Key
Returns Key
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:695

valueSchema

get valueSchema(): Value
Returns Value
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:696

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:55

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

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

and

and<T extends ZodType<any, any, any, T>>(
incoming: T,
): ZodIntersection<ZodMap<Key, Value>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodMap<Key, Value>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:83

array

array(): ZodArray<ZodMap<Key, Value>, "many">
Returns ZodArray<ZodMap<Key, Value>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:80

brand

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

catch

catch(def: Map<Key["_output"], Value["_output"]>): ZodCatch<ZodMap<Key, Value>>
Parameters
- def: Map<Key["_output"], Value["_output"]>
Returns ZodCatch<ZodMap<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:88
catch(
    def: (
        ctx: {
            error: ZodError<any>;
            input: Map<Key["_input"], Value["_input"]>;
        },
    ) => Map<Key["_output"], Value["_output"]>,
): ZodCatch<ZodMap<Key, Value>>
Parameters
- def: (
      ctx: {
          error: ZodError<any>;
          input: Map<Key["_input"], Value["_input"]>;
      },
  ) => Map<Key["_output"], Value["_output"]>
Returns ZodCatch<ZodMap<Key, Value>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:89

default

default(
def: Map<Key["_input"], Value["_input"]>,
): ZodDefault<ZodMap<Key, Value>>
Parameters
- def: Map<Key["_input"], Value["_input"]>
Returns ZodDefault<ZodMap<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:85
default(
def: () => Map<Key["_input"], Value["_input"]>,
): ZodDefault<ZodMap<Key, Value>>
Parameters
- def: () => Map<Key["_input"], Value["_input"]>
Returns ZodDefault<ZodMap<Key, Value>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:86

describe

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

isNullable

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

isOptional

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

nullable

nullable(): ZodNullable<ZodMap<Key, Value>>
Returns ZodNullable<ZodMap<Key, Value>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:78

nullish

nullish(): ZodOptional<ZodNullable<ZodMap<Key, Value>>>
Returns ZodOptional<ZodNullable<ZodMap<Key, Value>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:79

optional

optional(): ZodOptional<ZodMap<Key, Value>>
Returns ZodOptional<ZodMap<Key, Value>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:77

or

or<T extends ZodType<any, any, any, T>>(
option: T,
): ZodUnion<[ZodMap<Key, Value>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodMap<Key, Value>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:82

parse

parse(
data: unknown,
params?: Partial<ParseParams>,
): Map<Key["_output"], Value["_output"]>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Map<Key["_output"], Value["_output"]>
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:62

parseAsync

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

pipe

pipe<T extends ZodType<any, any, any, T>>(
target: T,
): ZodPipeline<ZodMap<Key, Value>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodMap<Key, Value>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:94

promise

promise(): ZodPromise<ZodMap<Key, Value>>
Returns ZodPromise<ZodMap<Key, Value>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:81

readonly

readonly(): ZodReadonly<ZodMap<Key, Value>>
Returns ZodReadonly<ZodMap<Key, Value>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:95

refine

refine<
    RefinedOutput extends
        Map<Key["_output"], Value["_output"], RefinedOutput>,
>(
    check: (
        arg: Map<Key["_output"], Value["_output"]>,
    ) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (
            arg: Map<Key["_output"], Value["_output"]>,
        ) => Partial<Omit<ZodCustomIssue, "code">>,
): ZodEffects<
    ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Map<Key["_output"], Value["_output"], RefinedOutput>
Parameters
- check: (arg: Map<Key["_output"], Value["_output"]>) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | (
          arg: Map<Key["_output"], Value["_output"]>,
      ) => Partial<Omit<ZodCustomIssue, "code">>
Returns ZodEffects<
    ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:68
refine(
    check: (arg: Map<Key["_output"], Value["_output"]>) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (
            arg: Map<Key["_output"], Value["_output"]>,
        ) => Partial<Omit<ZodCustomIssue, "code">>,
): ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: Map<Key["_output"], Value["_output"]>) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | (
          arg: Map<Key["_output"], Value["_output"]>,
      ) => Partial<Omit<ZodCustomIssue, "code">>
Returns ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:69

refinement

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

safeParse

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

safeParseAsync

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

superRefine

superRefine<
    RefinedOutput extends
        Map<Key["_output"], Value["_output"], RefinedOutput>,
>(
    refinement: (
        arg: Map<Key["_output"], Value["_output"]>,
        ctx: RefinementCtx,
    ) => arg is RefinedOutput,
): ZodEffects<
    ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Map<Key["_output"], Value["_output"], RefinedOutput>
Parameters
- refinement: (
  arg: Map<Key["_output"], Value["_output"]>,
  ctx: RefinementCtx,
  ) => arg is RefinedOutput
Returns ZodEffects<
    ZodMap<Key, Value>,
    RefinedOutput,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:73
superRefine(
    refinement: (
        arg: Map<Key["_output"], Value["_output"]>,
        ctx: RefinementCtx,
    ) => void,
): ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: Map<Key["_output"], Value["_output"]>, ctx: RefinementCtx) => void
Returns ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:74
superRefine(
    refinement: (
        arg: Map<Key["_output"], Value["_output"]>,
        ctx: RefinementCtx,
    ) => Promise<void>,
): ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (
  arg: Map<Key["_output"], Value["_output"]>,
  ctx: RefinementCtx,
  ) => Promise<void>
Returns ZodEffects<
    ZodMap<Key, Value>,
    Map<Key["_output"], Value["_output"]>,
    Map<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:75

transform

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

Class ZodMap<Key, Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodMap<Key, Value>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

keySchema

Returns Key

valueSchema

Returns Value

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

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

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

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

brand

Type Parameters

Parameters

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

catch

Parameters

Returns ZodCatch<ZodMap<Key, Value>>

Parameters

Returns ZodCatch<ZodMap<Key, Value>>

default

Parameters

Returns ZodDefault<ZodMap<Key, Value>>

Parameters

Returns ZodDefault<ZodMap<Key, Value>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns ZodNullable<ZodMap<Key, Value>>

nullish

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

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

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

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

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

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

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

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

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

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

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

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