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

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>

augment

nonstrict

Staticcreate

Staticlazycreate

StaticstrictCreate

shape

• get shape(): T

• Returns T

_getCached

• _getCached(): {
      keys: string[];
      shape: T;
  }

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

  • keys: string[]

  • shape: T

_parse

• _parse(input): ParseReturnType<Output>

• Parameters

  • input: ParseInput

  Returns ParseReturnType<Output>

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>>

deepPartial

• deepPartial(): DeepPartial<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

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

  Deprecated

extend

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

• Type Parameters

  • Augmentation extends ZodRawShape

  Parameters

  • augmentation: Augmentation

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

keyof

• keyof(): ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>

• Returns ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>

merge

• merge<Incoming, Augmentation>(merging): ZodObject<extendShape<T, Augmentation>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<T, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<extendShape<T, Augmentation>, 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<extendShape<T, Augmentation>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<T, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<extendShape<T, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>

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 Exactly<{
        [k in string | number | symbol]?: true
    }, Mask>

  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>>

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>>

• 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 Exactly<{
        [k in string | number | symbol]?: true
    }, Mask>

  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>>

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">>

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 Exactly<{
        [k in string | number | symbol]?: true
    }, Mask>

  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>>

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>>

• 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 Exactly<{
        [k in string | number | symbol]?: true
    }, Mask>

  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>>

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>>

strict

• strict(message?): ZodObject<T, "strict", Catchall, objectOutputType<T, Catchall, "strict">, objectInputType<T, Catchall, "strict">>

• Parameters

  • Optionalmessage: ErrMessage

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

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">>