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

Type Parameters

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

Hierarchy (View Summary)

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

Constructors

constructor

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

Properties

`Readonly`_def

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

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

augment

augment: <Augmentation extends Zod.z.ZodRawShape>(
    augmentation: Augmentation,
) => Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Catchall,
        UnknownKeys,
    >,
>

Deprecated

Use .extend instead

nonstrict

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

Alias of safeParseAsync

`Static`create

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

`Static`lazycreate

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

`Static`strictCreate

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

Accessors

description

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

shape

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

Methods

_getCached

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

_getOrReturnCtx

_getOrReturnCtx(
input: Zod.z.ParseInput,
ctx?: Zod.z.ParseContext,
): Zod.z.ParseContext
Parameters
- input: Zod.z.ParseInput
- Optionalctx: Zod.z.ParseContext
Returns Zod.z.ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

_refinement(
    refinement: (arg: Output, ctx: Zod.z.RefinementCtx) => any,
): Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- refinement: (arg: Output, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

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

array

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

brand

brand<B extends string | number | symbol>(
    brand?: B,
): Zod.z.ZodBranded<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    B,
>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.z.ZodBranded<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

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

catchall

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

deepPartial

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

default

default(
def: noUndefined<Input>,
): Zod.z.ZodDefault<
Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
>
Parameters
- def: noUndefined<Input>
Returns Zod.z.ZodDefault<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(
def: () => noUndefined<Input>,
): Zod.z.ZodDefault<
Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
>
Parameters
- def: () => noUndefined<Input>
Returns Zod.z.ZodDefault<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.default
- Defined in 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/zod/lib/types.d.ts:90

extend

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

isNullable

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

isOptional

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

keyof

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

merge

merge<Incoming extends Zod.z.AnyZodObject, Augmentation extends any>(
    merging: Incoming,
): Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    Incoming["_def"]["unknownKeys"],
    Incoming["_def"]["catchall"],
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
>
Prior to zod@1.0.12 there was a bug in the inferred type of merged objects. Please upgrade if you are experiencing issues.
Type Parameters
- Incoming extends Zod.z.AnyZodObject
- Augmentation extends any
Parameters
- merging: Incoming
Returns Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    },
    Incoming["_def"]["unknownKeys"],
    Incoming["_def"]["catchall"],
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
        },
        Incoming["_def"]["catchall"],
        Incoming["_def"]["unknownKeys"],
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:516

nullable

nullable(): Zod.z.ZodNullable<
Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
>
Returns Zod.z.ZodNullable<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

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

omit

omit<Mask extends { [k in string | number | symbol]?: true }>(
    mask: Mask,
): Zod.z.ZodObject<
    Omit<T, keyof Mask>,
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
    Zod.z.objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
>
Type Parameters
- Mask extends { [k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns Zod.z.ZodObject<
    Omit<T, keyof Mask>,
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
    Zod.z.objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>,
>
- Defined in node_modules/zod/lib/types.d.ts:524

optional

optional(): Zod.z.ZodOptional<
Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
>
Returns Zod.z.ZodOptional<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:74

or

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

parse

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

parseAsync

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

partial

partial(): Zod.z.ZodObject<
    { [k in string
    | number
    | symbol]: Zod.z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        { [k in string
        | number
        | symbol]: Zod.z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        { [k in string
        | number
        | symbol]: Zod.z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
Returns Zod.z.ZodObject<
    { [k in string
    | number
    | symbol]: Zod.z.ZodOptional<T[k]> },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        { [k in string
        | number
        | symbol]: Zod.z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        { [k in string
        | number
        | symbol]: Zod.z.ZodOptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:531
partial<Mask extends { [k in string | number | symbol]?: true }>(
    mask: Mask,
): Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? Zod.z.ZodOptional<T[k<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
Type Parameters
- Mask extends { [k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? Zod.z.ZodOptional<T[k<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.ZodOptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:534

passthrough

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

pick

pick<Mask extends { [k in string | number | symbol]?: true }>(
    mask: Mask,
): Zod.z.ZodObject<
    Pick<T, Extract<keyof T, keyof Mask>>,
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
>
Type Parameters
- Mask extends { [k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns Zod.z.ZodObject<
    Pick<T, Extract<keyof T, keyof Mask>>,
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        Pick<T, Extract<keyof T, keyof Mask>>,
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:521

pipe

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

promise

promise(): Zod.z.ZodPromise<
Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
>
Returns Zod.z.ZodPromise<Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

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

refine

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

refinement

refinement<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    refinementData:
        | Zod.z.IssueData
        | (arg: Output, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- refinementData: Zod.z.IssueData | (arg: Output, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    RefinedOutput,
    Input,
>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(
    check: (arg: Output) => boolean,
    refinementData:
        | Zod.z.IssueData
        | (arg: Output, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Parameters
- check: (arg: Output) => boolean
- refinementData: Zod.z.IssueData | (arg: Output, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    Output,
    Input,
>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

required

required(): Zod.z.ZodObject<
    { [k in string
    | number
    | symbol]: Zod.z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        { [k in string
        | number
        | symbol]: Zod.z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        { [k in string
        | number
        | symbol]: Zod.z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
Returns Zod.z.ZodObject<
    { [k in string
    | number
    | symbol]: Zod.z.deoptional<T[k]> },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        { [k in string
        | number
        | symbol]: Zod.z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        { [k in string
        | number
        | symbol]: Zod.z.deoptional<T[k]> },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:539
required<Mask extends { [k in string | number | symbol]?: true }>(
    mask: Mask,
): Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? Zod.z.deoptional<T[k<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
Type Parameters
- Mask extends { [k in string | number | symbol]?: true }
Parameters
- mask: Mask
Returns Zod.z.ZodObject<
    {
        [k in string
        | number
        | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? Zod.z.deoptional<T[k<k>]>
                    : T[k]
            }[k<k>]
            : never
    },
    UnknownKeys,
    Catchall,
    Zod.z.objectOutputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
    Zod.z.objectInputType<
        {
            [k in string
            | number
            | symbol]: k extends keyof T
                ? {
                    [k in string | number | symbol]: k extends keyof Mask
                        ? Zod.z.deoptional<T[k<k>]>
                        : T[k]
                }[k<k>]
                : never
        },
        Catchall,
        UnknownKeys,
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:542

safeParse

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

safeParseAsync

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

setKey

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

strict

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

strip

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

superRefine

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

transform

transform<NewOut>(
    transform: (
        arg: Output,
        ctx: Zod.z.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    NewOut,
    Input,
>
Type Parameters
- NewOut
Parameters
- transform: (arg: Output, ctx: Zod.z.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.z.ZodEffects<
    Zod.z.ZodObject<T, UnknownKeys, Catchall, Output, Input>,
    NewOut,
    Input,
>
Inherited from ZodType.transform
- Defined in 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 Zod.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 Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<Output>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<Output>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<Output>

_processInputParams

Parameters

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

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

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

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

catchall

Type Parameters

Parameters

Returns Zod.z.ZodObject< T, UnknownKeys, Index, Zod.z.objectOutputType<T, Index, UnknownKeys>, Zod.z.objectInputType<T, Index, UnknownKeys>,>

deepPartial

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

Deprecated

default

Parameters

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

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`lazycreate

`Static`strictCreate

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

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

Returns Zod.z.ZodObject<
T,
UnknownKeys,
Index,
Zod.z.objectOutputType<T, Index, UnknownKeys>,
Zod.z.objectInputType<T, Index, UnknownKeys>,
>

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

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

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

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

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

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

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

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