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

Type Parameters

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

Hierarchy (view full)

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

Constructors

constructor

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

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) => ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>>)

Type declaration

- <Augmentation>(augmentation): ZodObject<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, UnknownKeys, Catchall, objectOutputType<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, Catchall, UnknownKeys>, objectInputType<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, Catchall, UnknownKeys>>
- Type Parameters
  - Augmentation extends ZodRawShape
  Parameters
  - augmentation: Augmentation
  Returns ZodObject<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, UnknownKeys, Catchall, objectOutputType<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, Catchall, UnknownKeys>, objectInputType<{
      [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
  }, Catchall, UnknownKeys>>

Deprecated

Use .extend instead

nonstrict

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

Type declaration

- (): ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall, "passthrough">, objectInputType<T, Catchall, "passthrough">>
- Returns ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall, "passthrough">, objectInputType<T, Catchall, "passthrough">>

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.

spa

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

Alias of safeParseAsync

Type declaration

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

`Static` create

create: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)

Type declaration

- <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
      [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>
- 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<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>

`Static` lazycreate

lazycreate: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)

Type declaration

- <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
      [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>
- 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<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>

`Static` strictCreate

strictCreate: (<T_1>(shape, params?) => ZodObject<T_1, "strict", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)

Type declaration

- <T_1>(shape, params?): ZodObject<T_1, "strict", ZodTypeAny, {
      [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>
- 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<baseObjectOutputType<T_1>, {
          [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
              ? never
              : k
      }[keyof T_1]>[k_1]
  }, {
      [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
  }>

Accessors

description

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

shape

get shape(): T
Returns T
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:497

Methods

_getCached

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

_getOrReturnCtx

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

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

_refinement(refinement): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- refinement: ((arg, ctx) => any)
  - - (arg, ctx): 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:69

and

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

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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:77

brand

brand<B>(brand?): 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:84

catch

catch(def): ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: Output
Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:85
catch(def): ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: ((ctx) => Output)
  - - (ctx): Output
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: Input;
      }
      error: ZodError<any>
      input: Input
      Returns Output
Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:86

catchall

catchall<Index>(index): ZodObject<T, UnknownKeys, Index, objectOutputType<T, Index, UnknownKeys>, objectInputType<T, Index, UnknownKeys>>
Type Parameters
- Index extends ZodTypeAny
Parameters
- index: Index
Returns ZodObject<T, UnknownKeys, Index, objectOutputType<T, Index, UnknownKeys>, objectInputType<T, Index, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:520

deepPartial

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

default

default(def): 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:82
default(def): 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:83

describe

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

extend

extend<Augmentation>(augmentation): ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>>
Type Parameters
- Augmentation extends ZodRawShape
Parameters
- augmentation: Augmentation
Returns ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:506

isNullable

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

isOptional

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

keyof

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

merge

merge<Incoming, Augmentation>(merging): ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>
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 AnyZodObject
- Augmentation extends any
Parameters
- merging: Incoming
Returns ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:516

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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:75

nullish

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

omit

omit<Mask>(mask): ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall, objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>, objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>>
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, UnknownKeys>, objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:524

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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:74

or

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

parse

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

parseAsync

parseAsync(data, params?): Promise<Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.22.4/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, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: ZodOptional<T[k]>
}, Catchall, UnknownKeys>>
Returns ZodObject<{
    [k in string | number | symbol]: ZodOptional<T[k]>
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: ZodOptional<T[k]>
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: ZodOptional<T[k]>
}, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:531
partial<Mask>(mask): ZodObject<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? ZodOptional<T[k<k>]>
                : T[k]
        }[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<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? ZodOptional<T[k<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>>
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<k>]>
                : T[k]
        }[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<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? ZodOptional<T[k<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:534

passthrough

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

pick

pick<Mask>(mask): ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, Catchall, objectOutputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall, UnknownKeys>, objectInputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall, UnknownKeys>>
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, UnknownKeys>, objectInputType<Pick<T, Extract<keyof T, keyof Mask>>, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:521

pipe

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

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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:78

readonly

readonly(): ZodReadonly<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns ZodReadonly<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:92

refine

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

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: Output
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:67
refinement(check, refinementData): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Parameters
- check: ((arg) => boolean)
  - - (arg): boolean
    - Parameters
      arg: Output
      Returns boolean
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.22.4/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, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: deoptional<T[k]>
}, Catchall, UnknownKeys>>
Returns ZodObject<{
    [k in string | number | symbol]: deoptional<T[k]>
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: deoptional<T[k]>
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: deoptional<T[k]>
}, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:539
required<Mask>(mask): ZodObject<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? deoptional<T[k<k>]>
                : T[k]
        }[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<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? deoptional<T[k<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>>
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<k>]>
                : T[k]
        }[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<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: k extends keyof T
        ? {
            [k in string | number | symbol]: k extends keyof Mask
                ? deoptional<T[k<k>]>
                : T[k]
        }[k<k>]
        : never
}, Catchall, UnknownKeys>>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:542

safeParse

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

safeParseAsync

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

setKey

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

strict

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

strip

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

superRefine

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

transform

transform<NewOut>(transform): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut, Input>
Type Parameters
- NewOut
Parameters
- transform: ((arg, ctx) => NewOut | Promise<NewOut>)
  - - (arg, ctx): 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:81

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

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Private _cached

Readonly _def

Readonly _input

Readonly _output

Readonly _type

augment

Type declaration

Type Parameters

Parameters

Deprecated

nonstrict

Type declaration

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

Deprecated

spa

Type declaration

Parameters

Returns Promise<SafeParseReturnType<Input, Output>>

Static create

Type declaration

Type Parameters

Parameters

Static lazycreate

Type declaration

Type Parameters

Parameters

Returns T_1

Static strictCreate

Type declaration

Type Parameters

Parameters

Accessors

description

Returns undefined | string

shape

Returns T

Methods

_getCached

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

keys: string[]

shape: T

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<Output>

_parseAsync

Parameters

Returns AsyncParseReturnType<Output>

_parseSync

Parameters

Returns SyncParseReturnType<Output>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

`Private` _cached

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

`Static` lazycreate

`Static` strictCreate

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

Returns {
ctx: ParseContext;
status: ParseStatus;
}