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

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

Constructors

constructor

new ZodObject<
    T extends ZodRawShape,
    UnknownKeys extends UnknownKeysParam = UnknownKeysParam,
    Catchall extends ZodTypeAny = ZodTypeAny,
    Output = objectOutputType<T, Catchall, UnknownKeys>,
    Input = objectInputType<T, Catchall, UnknownKeys>,
>(
    def: ZodObjectDef,
): 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
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

`Readonly`_def

_def: ZodObjectDef

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

augment

augment: <Augmentation extends ZodRawShape>(
    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,
    >,
>

Deprecated

Use .extend instead

nonstrict

nonstrict: () => ZodObject<T, "passthrough", 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.

spa

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

Alias of safeParseAsync

`Static`create

create: <T_1 extends ZodRawShape>(
    shape: T_1,
    params?: RawCreateParams,
) => 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 extends ZodRawShape>(
    shape: () => T_1,
    params?: RawCreateParams,
) => 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 extends ZodRawShape>(
    shape: T_1,
    params?: RawCreateParams,
) => 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(): string | undefined
Returns string | undefined
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 }
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:492

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.22.4/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/.pnpm/zod@3.22.4/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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:496

_parseAsync

_parseAsync(input: ParseInput): 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: ParseInput): 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: ParseInput,
): { ctx: ParseContext; status: ParseStatus }
Parameters
- input: ParseInput
Returns { 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: (arg: Output, ctx: RefinementCtx) => any,
): ZodEffects<
    ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => 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 extends ZodTypeAny>(
incoming: T,
): 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>>
Returns ZodArray<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:77

brand

brand<B extends string | number | symbol>(
brand?: B,
): ZodBranded<ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: 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: Output): 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: (ctx: { error: ZodError; input: Input }) => Output,
): ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: (ctx: { error: ZodError; input: Input }) => 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 extends ZodTypeAny>(
index: Index,
): ZodObject<T, UnknownKeys, Index>
Type Parameters
- Index extends ZodTypeAny
Parameters
- index: Index
Returns ZodObject<T, UnknownKeys, Index>
- 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: 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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:82
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/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:83

describe

describe(description: string): 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 extends ZodRawShape>(
    augmentation: Augmentation,
): ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    UnknownKeys,
    Catchall,
>
Type Parameters
- Augmentation extends ZodRawShape
Parameters
- augmentation: Augmentation
Returns ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    UnknownKeys,
    Catchall,
>
- 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 extends AnyZodObject, Augmentation extends any>(
    merging: Incoming,
): ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    Incoming["_def"]["unknownKeys"],
    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 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"],
>
- 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 extends { [k in string | number | symbol]?: true }>(
mask: Mask,
): ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall>
Type Parameters
- Mask extends { [k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall>
- 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 extends ZodTypeAny>(
option: T,
): 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: unknown, params?: Partial<ParseParams>): Output
Parameters
- data: unknown
- Optionalparams: 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: unknown, params?: Partial<ParseParams>): Promise<Output>
Parameters
- data: unknown
- Optionalparams: 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,
>
Returns ZodObject<
    { [k in string
    | number
    | symbol]: ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:531
partial<Mask extends { [k in string | number | symbol]?: true }>(
    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,
>
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,
>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:534

passthrough

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

pick

pick<Mask extends { [k in string | number | symbol]?: true }>(
mask: Mask,
): ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, 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>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:521

pipe

pipe<T extends ZodTypeAny>(
target: T,
): 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: (arg: Output) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Output) => CustomErrorParams),
): ZodEffects<
    ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Output) => CustomErrorParams)
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: (arg: Output) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Output) => CustomErrorParams),
): ZodEffects<
    ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- check: (arg: Output) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Output) => CustomErrorParams)
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<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
- 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/.pnpm/zod@3.22.4/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
- 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/.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,
>
Returns ZodObject<
    { [k in string
    | number
    | symbol]: deoptional<T[k]> },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:539
required<Mask extends { [k in string | number | symbol]?: true }>(
    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,
>
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,
>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:542

safeParse

safeParse(
data: unknown,
params?: Partial<ParseParams>,
): SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optionalparams: 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: unknown,
params?: Partial<ParseParams>,
): Promise<SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optionalparams: 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 extends string, Schema extends ZodTypeAny>(
key: Key,
schema: Schema,
): ZodObject<T & { [k in string]: Schema }, UnknownKeys, Catchall>
Type Parameters
- Key extends string
- Schema extends ZodTypeAny
Parameters
- key: Key
- schema: Schema
Returns ZodObject<T & { [k in string]: Schema }, UnknownKeys, Catchall>
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:517

strict

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

strip

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

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
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: (arg: Output, ctx: RefinementCtx) => void,
): ZodEffects<
    ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => 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: (arg: Output, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<
    ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => 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: (arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>,
): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut>
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 Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

augment

Deprecated

nonstrict

Deprecated

spa

Staticcreate

Staticlazycreate

StaticstrictCreate

Accessors

description

Returns string | undefined

shape

Returns T

Methods

_getCached

Returns { 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 }

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

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

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

catchall

Type Parameters

Parameters

Returns ZodObject<T, UnknownKeys, Index>

deepPartial

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

Deprecated

default

Parameters

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

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`lazycreate

`Static`strictCreate

Returns ZodObject<
{
[k in string
| number
| symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
},
UnknownKeys,
Catchall,
>

Returns ZodObject<
{
[k in string
| number
| symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
},
Incoming["_def"]["unknownKeys"],
Incoming["_def"]["catchall"],
>

Returns ZodObject<
{ [k in string
| number
| symbol]: ZodOptional<T[k]> },
UnknownKeys,
Catchall,
>

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

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

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