Class ZodRecord<Key, Value>

Type Parameters

Key extends KeySchema = ZodString
Value extends ZodTypeAny = ZodTypeAny

Hierarchy (View Summary)

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

Index

Accessors

description

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

keySchema

get keySchema(): Key
Returns Key
- Defined in ../../node_modules/zod/v3/types.d.cts:668

valueSchema

get valueSchema(): Value
Returns Value
- Defined in ../../node_modules/zod/v3/types.d.cts:669

element

get element(): Value
Returns Value
- Defined in ../../node_modules/zod/v3/types.d.cts:671

Constructors

constructor

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

Methods

_getType

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

_getOrReturnCtx

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

_processInputParams

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

_parseSync

_parseSync(
input: ParseInput,
): 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/v3/types.d.cts:62

_parseAsync

_parseAsync(
input: ParseInput,
): 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/v3/types.d.cts:63

parse

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

safeParse

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

~validate

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

parseAsync

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

safeParseAsync

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

refine

refine<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    check: (arg: RecordType) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: RecordType) => CustomErrorParams),
): 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: RecordType) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: RecordType) => CustomErrorParams)
Returns ZodEffects<
    ZodRecord<Key, Value>,
    RefinedOutput,
    RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in ../../node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: RecordType) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: RecordType) => CustomErrorParams),
): ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: RecordType) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: RecordType) => CustomErrorParams)
Returns ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refine
- Defined in ../../node_modules/zod/v3/types.d.cts:72

refinement<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    check: (arg: RecordType) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | ((arg: RecordType, ctx: RefinementCtx) => IssueData),
): 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: RecordType) => arg is RefinedOutput
- refinementData: IssueData | ((arg: RecordType, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<
    ZodRecord<Key, Value>,
    RefinedOutput,
    RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.refinement
- Defined in ../../node_modules/zod/v3/types.d.cts:73
refinement(
    check: (arg: RecordType) => boolean,
    refinementData:
        | IssueData
        | ((arg: RecordType, ctx: RefinementCtx) => IssueData),
): ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- check: (arg: RecordType) => boolean
- refinementData: IssueData | ((arg: RecordType, ctx: RefinementCtx) => 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/v3/types.d.cts:74

_refinement

_refinement(
    refinement: (arg: RecordType, ctx: RefinementCtx) => any,
): ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: RecordType, ctx: RefinementCtx) => 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/v3/types.d.cts:75

superRefine

superRefine<
    RefinedOutput extends
        | Record<Key["_output"], Value["_output"]>
        | Partial<Record<Key["_output"], Value["_output"]>>,
>(
    refinement: (
        arg: RecordType,
        ctx: RefinementCtx,
    ) => arg is RefinedOutput,
): 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: RecordType, ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<
    ZodRecord<Key, Value>,
    RefinedOutput,
    RecordType<Key["_input"], Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:76
superRefine(
    refinement: (arg: RecordType, ctx: RefinementCtx) => void,
): ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: RecordType, ctx: RefinementCtx) => 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/v3/types.d.cts:77
superRefine(
    refinement: (arg: RecordType, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<
    ZodRecord<Key, Value>,
    RecordType<Key["_output"], Value["_output"]>,
    RecordType<Key["_input"], Value["_input"]>,
>
Parameters
- refinement: (arg: RecordType, ctx: RefinementCtx) => 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/v3/types.d.cts:78

optional

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

nullable

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

nullish

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

array

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

promise

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

or

or<T extends ZodTypeAny>(option: T): 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/v3/types.d.cts:85

and

and<T extends ZodTypeAny>(
incoming: T,
): 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/v3/types.d.cts:86

transform

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

default

default(
def: noUndefined<RecordType<Key["_input"], Value["_input"]>>,
): 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/v3/types.d.cts:88
default(
def: () => noUndefined<RecordType<Key["_input"], Value["_input"]>>,
): 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/v3/types.d.cts:89

brand

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

catch

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

describe

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

pipe

pipe<T extends ZodTypeAny>(target: T): 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/v3/types.d.cts:97

readonly

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

isOptional

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

isNullable

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

_parse

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

`Static`create

create<Value extends ZodTypeAny>(
valueType: Value,
params?: RawCreateParams,
): ZodRecord<ZodString, Value>
Type Parameters
- Value extends ZodTypeAny
Parameters
- valueType: Value
- Optionalparams: RawCreateParams
Returns ZodRecord<ZodString, Value>
- Defined in ../../node_modules/zod/v3/types.d.cts:672
create<Keys extends KeySchema, Value extends ZodTypeAny>(
    keySchema: Keys,
    valueType: Value,
    params?: RawCreateParams,
): ZodRecord<Keys, Value>
Type Parameters
- Keys extends KeySchema
- Value extends ZodTypeAny
Parameters
- keySchema: Keys
- valueType: Value
- Optionalparams: RawCreateParams
Returns ZodRecord<Keys, Value>
- Defined in ../../node_modules/zod/v3/types.d.cts:673

Properties

~standard

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

spa

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

Alias of safeParseAsync

Class ZodRecord<Key, Value>

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

description

Returns undefined | string

keySchema

Returns Key

valueSchema

Returns Value

element

Returns Value

Constructors

constructor

Type Parameters

Parameters

Returns ZodRecord<Key, Value>

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

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

_parseAsync

Parameters

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

parse

Parameters

Returns RecordType

safeParse

Parameters

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

~validate

Parameters

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

parseAsync

Parameters

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

safeParseAsync

Parameters

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

refine

Type Parameters

Parameters

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

Parameters

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

refinement

Type Parameters

Parameters

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

Parameters

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

_refinement

Parameters

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

superRefine

Type Parameters

Parameters

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

Parameters

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

Parameters

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

optional

Returns ZodOptional<ZodRecord<Key, Value>>

nullable

Returns ZodNullable<ZodRecord<Key, Value>>

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

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

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

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

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

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

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

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

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

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

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

`Static`create

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def