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.ZodType<any, any, any, Catchall> = z.ZodTypeAny,
    Output = z.objectOutputType<T, Catchall, UnknownKeys>,
    Input = z.objectInputType<T, Catchall, UnknownKeys>,
>(
    def: z.ZodObjectDef<T, UnknownKeys, Catchall>,
): z.ZodObject<T, UnknownKeys, Catchall, Output, Input>
Type Parameters
- T extends z.ZodRawShape
- UnknownKeys extends z.UnknownKeysParam = z.UnknownKeysParam
- Catchall extends z.ZodType<any, any, any, Catchall> = z.ZodTypeAny
- Output = z.objectOutputType<T, Catchall, UnknownKeys>
- Input = z.objectInputType<T, Catchall, UnknownKeys>
Parameters
- def: z.ZodObjectDef<T, UnknownKeys, Catchall>
Returns z.ZodObject<T, UnknownKeys, Catchall, Output, Input>
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:76

Properties

`Readonly`_def

_def: z.ZodObjectDef<T, UnknownKeys, Catchall>

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

augment

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

Deprecated

Use .extend instead

nonstrict

nonstrict: () => z.ZodObject<
    T,
    "passthrough",
    Catchall,
    z.objectOutputType<T, Catchall, "passthrough">,
    z.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: unknown,
params?: Partial<z.ParseParams>,
) => Promise<z.SafeParseReturnType<Input, Output>>

Alias of safeParseAsync

`Static`create

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

`Static`lazycreate

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

`Static`strictCreate

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

Accessors

description

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

shape

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

Methods

_getCached

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

_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.23.8/node_modules/zod/lib/types.d.ts:55

_getType

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

_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.23.8/node_modules/zod/lib/types.d.ts:540

_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.23.8/node_modules/zod/lib/types.d.ts:61

_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.23.8/node_modules/zod/lib/types.d.ts:60

_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.23.8/node_modules/zod/lib/types.d.ts:56

_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.23.8/node_modules/zod/lib/types.d.ts:72

and

and<T extends z.ZodType<any, any, any, T>>(
    incoming: T,
): z.ZodIntersection<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    T,
>
Type Parameters
- T extends z.ZodType<any, any, any, T>
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.23.8/node_modules/zod/lib/types.d.ts:83

array

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

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.23.8/node_modules/zod/lib/types.d.ts:87

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.23.8/node_modules/zod/lib/types.d.ts:88
catch(
def: (ctx: { error: z.ZodError<any>; input: Input }) => Output,
): z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Parameters
- def: (ctx: { error: z.ZodError<any>; input: Input }) => Output
Returns z.ZodCatch<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:89

catchall

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

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.23.8/node_modules/zod/lib/types.d.ts:574

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.23.8/node_modules/zod/lib/types.d.ts:85
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.23.8/node_modules/zod/lib/types.d.ts:86

describe

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

extend

extend<Augmentation extends z.ZodRawShape>(
    augmentation: Augmentation,
): z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Catchall,
        UnknownKeys,
    >,
>
Type Parameters
- Augmentation extends z.ZodRawShape
Parameters
- augmentation: Augmentation
Returns z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:550

isNullable

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

isOptional

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

keyof

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

merge

merge<
    Incoming extends
        z.ZodObject<
            any,
            any,
            any,
            { [key: string]: any },
            { [key: string]: any },
            Incoming,
        >,
    Augmentation extends any,
>(
    merging: Incoming,
): z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    Incoming["_def"]["unknownKeys"],
    Incoming["_def"]["catchall"],
    z.objectOutputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
    z.objectInputType<
        z.objectUtil.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 z.ZodObject<
      any,
      any,
      any,
      { [key: string]: any },
      { [key: string]: any },
      Incoming,
  >
- Augmentation extends any
Parameters
- merging: Incoming
Returns z.ZodObject<
    z.objectUtil.extendShape<T, Augmentation>,
    Incoming["_def"]["unknownKeys"],
    Incoming["_def"]["catchall"],
    z.objectOutputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
    z.objectInputType<
        z.objectUtil.extendShape<T, Augmentation>,
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:560

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

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.23.8/node_modules/zod/lib/types.d.ts:79

omit

omit<
    Mask extends
        z.util.Exactly<{ [k in string | number | symbol]?: true }, Mask>,
>(
    mask: Mask,
): z.ZodObject<
    Omit<T, keyof Mask>,
    UnknownKeys,
    Catchall,
    z.objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
    z.objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
>
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,
    z.objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
    z.objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:568

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

or

or<T extends z.ZodType<any, any, any, T>>(
option: T,
): z.ZodUnion<[z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, T]>
Type Parameters
- T extends z.ZodType<any, any, any, T>
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.23.8/node_modules/zod/lib/types.d.ts:82

parse

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

parseAsync

parseAsync(data: unknown, params?: Partial<z.ParseParams>): Promise<Output>
Parameters
- data: unknown
- Optionalparams: Partial<z.ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:64

partial

partial(): z.ZodObject<
    { [k in string
    | number
    | symbol]: z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        { [k in string
        | number
        | symbol]: z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        { [k in string
        | number
        | symbol]: z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
Returns z.ZodObject<
    { [k in string
    | number
    | symbol]: z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        { [k in string
        | number
        | symbol]: z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        { [k in string
        | number
        | symbol]: z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:575
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<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
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<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:578

passthrough

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

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,
    z.objectOutputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
>
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,
    z.objectOutputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:565

pipe

pipe<T extends z.ZodType<any, any, any, T>>(
target: T,
): z.ZodPipeline<z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>
Type Parameters
- T extends z.ZodType<any, any, any, T>
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.23.8/node_modules/zod/lib/types.d.ts:94

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.23.8/node_modules/zod/lib/types.d.ts:81

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.23.8/node_modules/zod/lib/types.d.ts:95

refine

refine<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | (arg: Output) => Partial<z.util.Omit<z.ZodCustomIssue, "code">>,
): 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) => Partial<z.util.Omit<z.ZodCustomIssue, "code">>
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:68
refine(
    check: (arg: Output) => unknown,
    message?:
        | string
        | Partial<z.util.Omit<z.ZodCustomIssue, "code">>
        | (arg: Output) => Partial<z.util.Omit<z.ZodCustomIssue, "code">>,
): 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) => Partial<z.util.Omit<z.ZodCustomIssue, "code">>
Returns z.ZodEffects<
    z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:69

refinement

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.23.8/node_modules/zod/lib/types.d.ts:70
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.23.8/node_modules/zod/lib/types.d.ts:71

required

required(): z.ZodObject<
    { [k in string
    | number
    | symbol]: z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        { [k in string
        | number
        | symbol]: z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        { [k in string
        | number
        | symbol]: z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
Returns z.ZodObject<
    { [k in string
    | number
    | symbol]: z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        { [k in string
        | number
        | symbol]: z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        { [k in string
        | number
        | symbol]: z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:583
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<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
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<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:586

safeParse

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

safeParseAsync

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

setKey

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

strict

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

strip

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

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.23.8/node_modules/zod/lib/types.d.ts:73
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.23.8/node_modules/zod/lib/types.d.ts:74
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.23.8/node_modules/zod/lib/types.d.ts:75

transform

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

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

augment

Deprecated

nonstrict

Deprecated

spa

Staticcreate

Staticlazycreate

StaticstrictCreate

Accessors

description

Returns undefined | string

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

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

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, z.objectOutputType<T, Index, UnknownKeys>, z.objectInputType<T, Index, UnknownKeys>,>

deepPartial

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

Deprecated

default

Parameters

Returns z.ZodDefault<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<
T,
UnknownKeys,
Index,
z.objectOutputType<T, Index, UnknownKeys>,
z.objectInputType<T, Index, UnknownKeys>,
>

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

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

Returns z.ZodObject<
Omit<T, keyof Mask>,
UnknownKeys,
Catchall,
z.objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
z.objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
>

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

Returns z.ZodObject<
Pick<T, Extract<keyof T, keyof Mask>>,
UnknownKeys,
Catchall,
z.objectOutputType<
Pick<T, Extract<keyof T, keyof Mask>>,
Catchall,
UnknownKeys,
>,
z.objectInputType<
Pick<T, Extract<keyof T, keyof Mask>>,
Catchall,
UnknownKeys,
>,
>

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

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

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

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