Class ZodObject<T, UnknownKeys, Catchall, Output, Input>

Type Parameters

T extends ZodRawShape
UnknownKeys extends UnknownKeysParam = "strip"
Catchall extends ZodTypeAny = ZodTypeAny
Output = objectOutputType<T, Catchall>
Input = objectInputType<T, Catchall>

Hierarchy

ZodType<Output, ZodObjectDef<T, UnknownKeys, Catchall>, Input>
- ZodObject

Index

Constructors

constructor

new ZodObject<T, UnknownKeys, Catchall, Output, Input>(def: ZodObjectDef<T, UnknownKeys, Catchall>): ZodObject<T, UnknownKeys, Catchall, Output, Input>
Type Parameters
- T extends ZodRawShape
- UnknownKeys extends UnknownKeysParam = "strip"
- Catchall extends ZodType<any, any, any, Catchall> = ZodTypeAny
- Output = objectOutputType<T, Catchall>
- Input = objectInputType<T, Catchall>
Parameters
- def: ZodObjectDef<T, UnknownKeys, Catchall>
Returns ZodObject<T, UnknownKeys, Catchall, Output, Input>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:72

Properties

`Private` _cached

_cached: any

`Readonly` _def

_def: ZodObjectDef<T, UnknownKeys, Catchall>

`Readonly` _input

_input: Input

`Readonly` _output

_output: Output

`Readonly` _type

_type: Output

augment

augment: (<Augmentation>(augmentation: Augmentation) => ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>)

Type declaration

- <Augmentation>(augmentation: Augmentation): ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>
- Type Parameters
  - Augmentation extends ZodRawShape
  Parameters
  - augmentation: Augmentation
  Returns ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>

extend

extend: (<Augmentation>(augmentation: Augmentation) => ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>)

Type declaration

- <Augmentation>(augmentation: Augmentation): ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>
- Type Parameters
  - Augmentation extends ZodRawShape
  Parameters
  - augmentation: Augmentation
  Returns ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>

nonstrict

nonstrict: (() => ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>)

Type declaration

- (): ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
- Deprecated
  In most cases, this is no longer needed - unknown properties are now silently stripped. If you want to pass through unknown properties, use .passthrough() instead.
  
  Returns ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<Input, Output>>)

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
- Alias of safeParseAsync
  Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<Input, Output>>

`Static` create

create: (<T_1>(shape: T_1, params?: RawCreateParams) => ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>)

Type declaration

- <T_1>(shape: T_1, params?: RawCreateParams): ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>
- Type Parameters
  - T_1 extends ZodRawShape
  Parameters
  - shape: T_1
  - Optional params: RawCreateParams
  Returns ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

`Static` lazycreate

lazycreate: (<T_1>(shape: (() => T_1), params?: RawCreateParams) => ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>)

Type declaration

- <T_1>(shape: (() => T_1), params?: RawCreateParams): ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>
- Type Parameters
  - T_1 extends ZodRawShape
  Parameters
  - shape: (() => T_1)
    - (): T_1
      
      Returns T_1
  - Optional params: RawCreateParams
  Returns ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

`Static` strictCreate

strictCreate: (<T_1>(shape: T_1, params?: RawCreateParams) => ZodObject<T_1, "strict", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>)

Type declaration

- <T_1>(shape: T_1, params?: RawCreateParams): ZodObject<T_1, "strict", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>
- Type Parameters
  - T_1 extends ZodRawShape
  Parameters
  - shape: T_1
  - Optional params: RawCreateParams
  Returns ZodObject<T_1, "strict", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

Accessors

description

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

shape

get shape(): T
Returns T
- Defined in node_modules/zod/lib/types.d.ts:431

Methods

_getCached

_getCached(): {
keys: string[];
shape: T;
}
Returns {
keys: string[];
shape: T;
}
- keys: string[]
- shape: T
- Defined in node_modules/zod/lib/types.d.ts:426

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

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

_parse

_parse(input: ParseInput): ParseReturnType<Output>
Parameters
- input: ParseInput
Returns ParseReturnType<Output>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:430

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<Output>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns SyncParseReturnType<Output>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:57

_processInputParams

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

_refinement

_refinement(refinement: ((arg: Output, ctx: RefinementCtx) => any)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => any)
  - - (arg: Output, ctx: RefinementCtx): any
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns any
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

and<T>(incoming: T): ZodIntersection<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:79

array

array(): ZodArray<ZodObject<T, UnknownKeys, Catchall, Output, Input>, "many">
Returns ZodArray<ZodObject<T, UnknownKeys, Catchall, Output, Input>, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:76

brand

brand<B>(brand?: B): ZodBranded<ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:83

catch

catch(def: Input): ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: Input
Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:84
catch(def: (() => Input)): ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: (() => Input)
  - - (): Input
    - Returns Input
Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85

catchall

catchall<Index>(index: Index): ZodObject<T, UnknownKeys, Index, objectOutputType<T, Index>, objectInputType<T, Index>>
Type Parameters
- Index extends ZodType<any, any, any, Index>
Parameters
- index: Index
Returns ZodObject<T, UnknownKeys, Index, objectOutputType<T, Index>, objectInputType<T, Index>>
- Defined in node_modules/zod/lib/types.d.ts:451

deepPartial

deepPartial(): DeepPartial<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns DeepPartial<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
- Defined in node_modules/zod/lib/types.d.ts:458

default

default(def: noUndefined<Input>): ZodDefault<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: noUndefined<Input>
Returns ZodDefault<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:81
default(def: (() => noUndefined<Input>)): ZodDefault<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: (() => noUndefined<Input>)
  - - (): noUndefined<Input>
    - Returns noUndefined<Input>
Returns ZodDefault<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82

describe

describe(description: string): ZodObject<T, UnknownKeys, Catchall, Output, Input>
Parameters
- description: string
Returns ZodObject<T, UnknownKeys, Catchall, Output, Input>
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:86

isNullable

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

isOptional

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

keyof

keyof(): ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>
Returns ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>
- Defined in node_modules/zod/lib/types.d.ts:475

merge

merge<Incoming>(merging: Incoming): ZodObject<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["catchall"]>, objectInputType<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["catchall"]>>
Prior to zod@1.0.12 there was a bug in the inferred type of merged objects. Please upgrade if you are experiencing issues.
Type Parameters
- Incoming extends ZodObject<any, any, any, {}, {}, Incoming>
Parameters
- merging: Incoming
Returns ZodObject<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["catchall"]>, objectInputType<extendShape<T, ReturnType<Incoming["_def"]["shape"]>>, Incoming["_def"]["catchall"]>>
- Defined in node_modules/zod/lib/types.d.ts:450

nullable

nullable(): ZodNullable<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns ZodNullable<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:74

nullish

nullish(): ZodNullable<ZodOptional<ZodObject<T, UnknownKeys, Catchall, Output, Input>>>
Returns ZodNullable<ZodOptional<ZodObject<T, UnknownKeys, Catchall, Output, Input>>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:75

omit

omit<Mask>(mask: Mask): ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall, objectOutputType<Omit<T, keyof Mask>, Catchall>, objectInputType<Omit<T, keyof Mask>, Catchall>>
Type Parameters
- Mask extends { [ k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall, objectOutputType<Omit<T, keyof Mask>, Catchall>, objectInputType<Omit<T, keyof Mask>, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:455

optional

optional(): ZodOptional<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns ZodOptional<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:73

or

or<T>(option: T): ZodUnion<[ZodObject<T, UnknownKeys, Catchall, Output, Input>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodObject<T, UnknownKeys, Catchall, Output, Input>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:78

parse

parse(data: unknown, params?: Partial<ParseParams>): Output
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Output
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/lib/types.d.ts:61

partial

partial(): ZodObject<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, Catchall>, objectInputType<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, Catchall>>
Returns ZodObject<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, Catchall>, objectInputType<{ [ k in string | number | symbol]: ZodOptional<T[k]> }, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:459
partial<Mask>(mask: Mask): ZodObject<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, Catchall>, objectInputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, Catchall>>
Type Parameters
- Mask extends { [ k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns ZodObject<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, Catchall>, objectInputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? ZodOptional<T[k]> : T[k] }[k] : never }, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:462

passthrough

passthrough(): ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
Returns ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:434

pick

pick<Mask>(mask: Mask): ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, Catchall, objectOutputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall>, objectInputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall>>
Type Parameters
- Mask extends { [ k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, Catchall, objectOutputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall>, objectInputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:452

pipe

pipe<T>(target: T): ZodPipeline<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:87

promise

promise(): ZodPromise<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns ZodPromise<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:77

refine

refine<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg: Output): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:65
refine(check: ((arg: Output) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- check: ((arg: Output) => unknown)
  - - (arg: Output): unknown
    - Parameters
      
      arg: Output
      
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg: Output): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check: ((arg: Output) => boolean), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- check: ((arg: Output) => boolean)
  - - (arg: Output): boolean
    - Parameters
      
      arg: Output
      
      Returns boolean
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

required

required(): ZodObject<{ [ k in string | number | symbol]: deoptional<T[k]> }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: deoptional<T[k]> }, Catchall>, objectInputType<{ [ k in string | number | symbol]: deoptional<T[k]> }, Catchall>>
Returns ZodObject<{ [ k in string | number | symbol]: deoptional<T[k]> }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: deoptional<T[k]> }, Catchall>, objectInputType<{ [ k in string | number | symbol]: deoptional<T[k]> }, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:467
required<Mask>(mask: Mask): ZodObject<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, Catchall>, objectInputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, Catchall>>
Type Parameters
- Mask extends { [ k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns ZodObject<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, UnknownKeys, Catchall, objectOutputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, Catchall>, objectInputType<{ [ k in string | number | symbol]: k extends keyof T ? { [ k in string | number | symbol]: k extends keyof Mask ? deoptional<T[k]> : T[k] }[k] : never }, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:470

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<Input, Output>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<Input, Output>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

setKey

setKey<Key, Schema>(key: Key, schema: Schema): ZodObject<T & { [ k in string]: Schema }, UnknownKeys, Catchall, objectOutputType<T & { [ k in string]: Schema }, Catchall>, objectInputType<T & { [ k in string]: Schema }, Catchall>>
Type Parameters
- Key extends string
- Schema extends ZodType<any, any, any, Schema>
Parameters
- key: Key
- schema: Schema
Returns ZodObject<T & { [ k in string]: Schema }, UnknownKeys, Catchall, objectOutputType<T & { [ k in string]: Schema }, Catchall>, objectInputType<T & { [ k in string]: Schema }, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:442

strict

strict(message?: ErrMessage): ZodObject<T, "strict", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
Parameters
- Optional message: ErrMessage
Returns ZodObject<T, "strict", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:432

strip

strip(): ZodObject<T, "strip", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
Returns ZodObject<T, "strip", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>
- Defined in node_modules/zod/lib/types.d.ts:433

superRefine

superRefine<RefinedOutput>(refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg: Output, ctx: RefinementCtx): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns arg is RefinedOutput
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(refinement: ((arg: Output, ctx: RefinementCtx) => void)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => void)
  - - (arg: Output, ctx: RefinementCtx): void
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns void
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71

transform

transform<NewOut>(transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut, Input>
Type Parameters
- NewOut
Parameters
- transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
  - - (arg: Output, ctx: RefinementCtx): NewOut | Promise<NewOut>
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns NewOut | Promise<NewOut>
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut, Input>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:80

Class ZodObject<T, UnknownKeys, Catchall, Output, Input>

Type Parameters

T extends ZodRawShape

UnknownKeys extends UnknownKeysParam = "strip"

Catchall extends ZodTypeAny = ZodTypeAny

Output = objectOutputType<T, Catchall>

Input = objectInputType<T, Catchall>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ZodRawShape

UnknownKeys extends UnknownKeysParam = "strip"

Catchall extends ZodType<any, any, any, Catchall> = ZodTypeAny

Output = objectOutputType<T, Catchall>

Input = objectInputType<T, Catchall>

Parameters

def: ZodObjectDef<T, UnknownKeys, Catchall>

Returns ZodObject<T, UnknownKeys, Catchall, Output, Input>

Properties

Private _cached

Readonly _def

Readonly _input

Readonly _output

Readonly _type

augment

Type declaration

Type Parameters

Augmentation extends ZodRawShape

Parameters

augmentation: Augmentation

Returns ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>

extend

Type declaration

Type Parameters

Augmentation extends ZodRawShape

Parameters

augmentation: Augmentation

Returns ZodObject<extendShape<T, Augmentation>, UnknownKeys, Catchall, objectOutputType<extendShape<T, Augmentation>, Catchall>, objectInputType<extendShape<T, Augmentation>, Catchall>>

nonstrict

Type declaration

Deprecated

Returns ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall>, objectInputType<T, Catchall>>

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<Input, Output>>

Static create

Type declaration

Type Parameters

T_1 extends ZodRawShape

Parameters

shape: T_1

Optional params: RawCreateParams

Returns ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

Static lazycreate

Type declaration

Type Parameters

T_1 extends ZodRawShape

Parameters

shape: (() => T_1)

Returns T_1

Optional params: RawCreateParams

Returns ZodObject<T_1, "strip", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

Static strictCreate

Type declaration

Type Parameters

T_1 extends ZodRawShape

Parameters

shape: T_1

Optional params: RawCreateParams

Returns ZodObject<T_1, "strict", ZodTypeAny, { [ k_1 in string | number | symbol]: addQuestionMarks<{ [ k in string | number | symbol]: T_1[k]["_output"] }>[k_1] }, { [ k_3 in string | number | symbol]: addQuestionMarks<{ [ k_2 in string | number | symbol]: T_1[k_2]["_input"] }>[k_3] }>

Accessors

`Private` _cached

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Optional` params: Partial<ParseParams>

`Static` create

`Optional` params: RawCreateParams

`Static` lazycreate

`Optional` params: RawCreateParams

`Static` strictCreate

`Optional` params: RawCreateParams

Returns {
keys: string[];
shape: T;
}

`Optional` ctx: ParseContext

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B