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

Type Parameters

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

Hierarchy (View Summary)

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

Constructors

constructor

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

Properties

`Readonly`_def

_def: z.ZodObjectDef

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

~standard

"~standard": Props<Input, Output>

augment

augment: <Augmentation extends z.ZodRawShape>(
    augmentation: Augmentation,
) => z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    UnknownKeys,
    Catchall,
>

Deprecated

Use .extend instead

nonstrict

nonstrict: () => z.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?: z.util.InexactPartial<z.ParseParams>,
) => Promise<z.SafeParseReturnType<Input, Output>>

Alias of safeParseAsync

`Static`create

create: <Shape extends z.ZodRawShape>(
    shape: Shape,
    params?: z.RawCreateParams,
) => z.ZodObject<
    Shape,
    "strip",
    z.ZodTypeAny,
    {
        [k in string
        | number
        | symbol]: z.objectUtil.addQuestionMarks<
            z.baseObjectOutputType<Shape>,
            any,
        >[k]
    },
    { [k in string
    | number
    | symbol]: z.baseObjectInputType<Shape>[k] },
>

`Static`lazycreate

lazycreate: <Shape extends z.ZodRawShape>(
shape: () => Shape,
params?: z.RawCreateParams,
) => z.ZodObject<Shape, "strip">

`Static`strictCreate

strictCreate: <Shape extends z.ZodRawShape>(
shape: Shape,
params?: z.RawCreateParams,
) => z.ZodObject<Shape, "strict">

Accessors

description

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

shape

get shape(): T
Returns T
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:536

Methods

_getCached

_getCached(): { keys: string[]; shape: T }
Returns { keys: string[]; shape: T }
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:531

_getOrReturnCtx

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

_getType

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

_parse

_parse(input: z.ParseInput): z.ParseReturnType<Output>
Parameters
- input: z.ParseInput
Returns z.ParseReturnType<Output>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:535

_parseAsync

_parseAsync(input: z.ParseInput): z.AsyncParseReturnType<Output>
Parameters
- input: z.ParseInput
Returns z.AsyncParseReturnType<Output>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:63

_parseSync

_parseSync(input: z.ParseInput): z.SyncParseReturnType<Output>
Parameters
- input: z.ParseInput
Returns z.SyncParseReturnType<Output>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:62

_processInputParams

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

_refinement

_refinement(
    refinement: (arg: Output, ctx: z.RefinementCtx) => any,
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: z.RefinementCtx) => any
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:75

~validate

"~validate"(data: unknown): Result<Output> | Promise<Result<Output>>
Parameters
- data: unknown
Returns Result<Output> | Promise<Result<Output>>
Inherited from ZodType.~validate
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:66

and

and<T extends z.ZodTypeAny>(
    incoming: T,
): z.ZodIntersection<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    T,
>
Type Parameters
- T extends z.ZodTypeAny
Parameters
- incoming: T
Returns z.ZodIntersection<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:86

array

array(): z.ZodArray<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns z.ZodArray<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:83

brand

brand<B extends string | number | symbol>(
brand?: B,
): z.ZodBranded<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns z.ZodBranded<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:90

catch

catch(
def: Output,
): z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: Output
Returns z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:91
catch(
def: (ctx: { error: z.ZodError; input: Input }) => Output,
): z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: (ctx: { error: z.ZodError; input: Input }) => Output
Returns z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:92

catchall

catchall<Index extends z.ZodTypeAny>(
index: Index,
): z.ZodObject<T, UnknownKeys, Index>
Type Parameters
- Index extends z.ZodTypeAny
Parameters
- index: Index
Returns z.ZodObject<T, UnknownKeys, Index>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:559

deepPartial

deepPartial(): DeepPartial<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns DeepPartial<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Deprecated
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:569

default

default(
def: z.util.noUndefined<Input>,
): z.ZodDefault<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: z.util.noUndefined<Input>
Returns z.ZodDefault<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:88
default(
def: () => z.util.noUndefined<Input>,
): z.ZodDefault<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: () => z.util.noUndefined<Input>
Returns z.ZodDefault<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:89

describe

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

extend

extend<Augmentation extends z.ZodRawShape>(
    augmentation: Augmentation,
): z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    UnknownKeys,
    Catchall,
>
Type Parameters
- Augmentation extends z.ZodRawShape
Parameters
- augmentation: Augmentation
Returns z.ZodObject<z.objectUtil.extendShape<T, Augmentation>, UnknownKeys, Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:545

isNullable

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

isOptional

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

keyof

keyof(): z.ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>
Returns z.ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:586

merge

merge<Incoming extends z.AnyZodObject, Augmentation extends any>(
    merging: Incoming,
): z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    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 z.AnyZodObject
- Augmentation extends any
Parameters
- merging: Incoming
Returns z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    Incoming["_def"]["unknownKeys"],
    Incoming["_def"]["catchall"],
>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:555

nullable

nullable(): z.ZodNullable<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns z.ZodNullable<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:81

nullish

nullish(): z.ZodOptional<
z.ZodNullable<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>,
>
Returns z.ZodOptional<
z.ZodNullable<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>,
>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:82

omit

omit<
    Mask extends
        z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>,
>(
    mask: Mask,
): z.ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall>
Type Parameters
- Mask extends z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>
Parameters
- mask: Mask
Returns z.ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:563

optional

optional(): z.ZodOptional<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns z.ZodOptional<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:80

or

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

parse

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

parseAsync

parseAsync(
data: unknown,
params?: z.util.InexactPartial<z.ParseParams>,
): Promise<Output>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:67

partial

partial(): z.ZodObject<
    { [k in string
    | number
    | symbol]: z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
>
Returns z.ZodObject<
    { [k in string
    | number
    | symbol]: z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:570
partial<
    Mask extends
        z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>,
>(
    mask: Mask,
): z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string
                | number
                | symbol]: k extends keyof Mask ? z.ZodOptional<T[k]> : T[k]
            }[k]
            : never
    },
    UnknownKeys,
    Catchall,
>
Type Parameters
- Mask extends z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>
Parameters
- mask: Mask
Returns z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string
                | number
                | symbol]: k extends keyof Mask ? z.ZodOptional<T[k]> : T[k]
            }[k]
            : never
    },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:573

passthrough

passthrough(): z.ZodObject<T, "passthrough", Catchall>
Returns z.ZodObject<T, "passthrough", Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:539

pick

pick<
    Mask extends
        z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>,
>(
    mask: Mask,
): z.ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, Catchall>
Type Parameters
- Mask extends z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>
Parameters
- mask: Mask
Returns z.ZodObject<Pick<T, Extract<keyof T, keyof Mask>>, UnknownKeys, Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:560

pipe

pipe<T extends z.ZodTypeAny>(
target: T,
): z.ZodPipeline<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Type Parameters
- T extends z.ZodTypeAny
Parameters
- target: T
Returns z.ZodPipeline<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:97

promise

promise(): z.ZodPromise<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns z.ZodPromise<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:84

readonly

readonly(): z.ZodReadonly<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Returns z.ZodReadonly<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:98

refine

refine<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | ((arg: Output) => z.CustomErrorParams),
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
      | ((arg: Output) => z.CustomErrorParams)
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: Output) => unknown,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | ((arg: Output) => z.CustomErrorParams),
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- check: (arg: Output) => unknown
- Optionalmessage:
      | string
      | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
      | ((arg: Output) => z.CustomErrorParams)
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:72

refinement<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    refinementData:
        | z.IssueData
        | ((arg: Output, ctx: z.RefinementCtx) => z.IssueData),
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- refinementData: z.IssueData | ((arg: Output, ctx: z.RefinementCtx) => z.IssueData)
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:73
refinement(
    check: (arg: Output) => boolean,
    refinementData:
        | z.IssueData
        | ((arg: Output, ctx: z.RefinementCtx) => z.IssueData),
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- check: (arg: Output) => boolean
- refinementData: z.IssueData | ((arg: Output, ctx: z.RefinementCtx) => z.IssueData)
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:74

required

required(): z.ZodObject<
    { [k in string
    | number
    | symbol]: z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
>
Returns z.ZodObject<
    { [k in string
    | number
    | symbol]: z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:578
required<
    Mask extends
        z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>,
>(
    mask: Mask,
): z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string
                | number
                | symbol]: k extends keyof Mask ? z.deoptional<T[k]> : T[k]
            }[k]
            : never
    },
    UnknownKeys,
    Catchall,
>
Type Parameters
- Mask extends z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>
Parameters
- mask: Mask
Returns z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string
                | number
                | symbol]: k extends keyof Mask ? z.deoptional<T[k]> : T[k]
            }[k]
            : never
    },
    UnknownKeys,
    Catchall,
>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:581

safeParse

safeParse(
data: unknown,
params?: z.util.InexactPartial<z.ParseParams>,
): z.SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns z.SafeParseReturnType<Input, Output>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:65

safeParseAsync

safeParseAsync(
data: unknown,
params?: z.util.InexactPartial<z.ParseParams>,
): Promise<z.SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optionalparams: z.util.InexactPartial<z.ParseParams>
Returns Promise<z.SafeParseReturnType<Input, Output>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:68

setKey

setKey<Key extends string, Schema extends z.ZodTypeAny>(
key: Key,
schema: Schema,
): z.ZodObject<T & { [k in string]: Schema }, UnknownKeys, Catchall>
Type Parameters
- Key extends string
- Schema extends z.ZodTypeAny
Parameters
- key: Key
- schema: Schema
Returns z.ZodObject<T & { [k in string]: Schema }, UnknownKeys, Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:556

strict

strict(message?: ErrMessage): z.ZodObject<T, "strict", Catchall>
Parameters
- Optionalmessage: ErrMessage
Returns z.ZodObject<T, "strict", Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:537

strip

strip(): z.ZodObject<T, "strip", Catchall>
Returns z.ZodObject<T, "strip", Catchall>
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:538

superRefine

superRefine<RefinedOutput>(
    refinement: (arg: Output, ctx: z.RefinementCtx) => arg is RefinedOutput,
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Type Parameters
- RefinedOutput
Parameters
- refinement: (arg: Output, ctx: z.RefinementCtx) => arg is RefinedOutput
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:76
superRefine(
    refinement: (arg: Output, ctx: z.RefinementCtx) => void,
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: z.RefinementCtx) => void
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:77
superRefine(
    refinement: (arg: Output, ctx: z.RefinementCtx) => Promise<void>,
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: z.RefinementCtx) => Promise<void>
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:78

transform

transform<NewOut>(
    transform: (
        arg: Output,
        ctx: z.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    NewOut,
>
Type Parameters
- NewOut
Parameters
- transform: (arg: Output, ctx: z.RefinementCtx) => NewOut | Promise<NewOut>
Returns z.ZodEffects<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/types.d.cts:87

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

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

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 z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns z.ParseReturnType<Output>

_parseAsync

Parameters

Returns z.AsyncParseReturnType<Output>

_parseSync

Parameters

Returns z.SyncParseReturnType<Output>

_processInputParams

Parameters

Returns { ctx: z.ParseContext; status: z.ParseStatus }

_refinement

Parameters

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

~validate

Parameters

Returns Result<Output> | Promise<Result<Output>>

and

Type Parameters

Parameters

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

array

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

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

catchall

Type Parameters

Parameters

Returns z.ZodObject<T, UnknownKeys, Index>

deepPartial

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

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`lazycreate

`Static`strictCreate

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

Returns z.ZodObject<
z.objectUtil.extendShape<T, Augmentation>,
Incoming["_def"]["unknownKeys"],
Incoming["_def"]["catchall"],
>

Returns z.ZodOptional<
z.ZodNullable<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>,
>

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

Returns z.ZodObject<
{
[k in string
| number
| symbol]: k extends keyof T
? {
[k in string
| number
| symbol]: k extends keyof Mask ? z.ZodOptional<T[k]> : T[k]
}[k]
: never
},
UnknownKeys,
Catchall,
>

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

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