Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Discriminator extends string
Options extends Zod.z.ZodDiscriminatedUnionOption<Discriminator>[]

Hierarchy (View Summary)

Zod.z.ZodType<
    Zod.z.output<Options[number]>,
    Zod.z.ZodDiscriminatedUnionDef<Discriminator, Options>,
    Zod.z.input<Options[number]>,
>
- ZodDiscriminatedUnion

Index

Constructors

constructor

new ZodDiscriminatedUnion<
    Discriminator extends string,
    Options extends Zod.z.ZodDiscriminatedUnionOption<Discriminator>[],
>(
    def: Zod.z.ZodDiscriminatedUnionDef<Discriminator, Options>,
): Zod.z.ZodDiscriminatedUnion<Discriminator, Options>
Type Parameters
- Discriminator extends string
- Options extends Zod.z.ZodDiscriminatedUnionOption<Discriminator>[]
Parameters
- def: Zod.z.ZodDiscriminatedUnionDef<Discriminator, Options>
Returns Zod.z.ZodDiscriminatedUnion<Discriminator, Options>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly`_def

_def: Zod.z.ZodDiscriminatedUnionDef<Discriminator, Options>

`Readonly`_input

_input: Zod.z.input<Options[number]>

`Readonly`_output

_output: Zod.z.output<Options[number]>

`Readonly`_type

_type: Zod.z.output<Options[number]>

spa

spa: (
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
) => Promise<
    Zod.z.SafeParseReturnType<
        Zod.z.input<Options[number]>,
        Zod.z.output<Options[number]>,
    >,
>

Alias of safeParseAsync

Accessors

description

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

discriminator

get discriminator(): Discriminator
Returns Discriminator
- Defined in node_modules/zod/lib/types.d.ts:578

options

get options(): Options
Returns Options
- Defined in node_modules/zod/lib/types.d.ts:579

optionsMap

get optionsMap(): Map<Zod.z.Primitive, Zod.z.ZodDiscriminatedUnionOption<any>>
Returns Map<Zod.z.Primitive, Zod.z.ZodDiscriminatedUnionOption<any>>
- Defined in node_modules/zod/lib/types.d.ts:580

Methods

_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<Zod.z.output<Options[number]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<Zod.z.output<Options[number]>>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:577

_parseAsync

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

_parseSync

_parseSync(
input: Zod.z.ParseInput,
): Zod.z.SyncParseReturnType<Zod.z.output<Options[number]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.SyncParseReturnType<Zod.z.output<Options[number]>>
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: Zod.z.output<Options[number]>,
        ctx: Zod.z.RefinementCtx,
    ) => any,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Parameters
- refinement: (arg: Zod.z.output<Options[number]>, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
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.ZodDiscriminatedUnion<Discriminator, Options>,
    T,
>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- incoming: T
Returns Zod.z.ZodIntersection<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:80

array

array(): Zod.z.ZodArray<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
"many",
>
Returns Zod.z.ZodArray<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, "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.ZodDiscriminatedUnion<Discriminator, Options>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.z.ZodBranded<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

catch(
def: Zod.z.output<Options[number]>,
): Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: Zod.z.output<Options[number]>
Returns Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(
    def: (
        ctx: {
            error: Zod.z.ZodError<any>;
            input: Zod.z.input<Options[number]>;
        },
    ) => Zod.z.output<Options[number]>,
): Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: (
  ctx: { error: Zod.z.ZodError<any>; input: Zod.z.input<Options[number]> },
  ) => Zod.z.output<Options[number]>
Returns Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

default

default(
def: noUndefined<Zod.z.input<Options[number]>>,
): Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: noUndefined<Zod.z.input<Options[number]>>
Returns Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(
def: () => noUndefined<Zod.z.input<Options[number]>>,
): Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: () => noUndefined<Zod.z.input<Options[number]>>
Returns Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
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

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

or

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

parse

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

parseAsync

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

pipe

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

promise

promise(): Zod.z.ZodPromise<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.z.ZodPromise<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

readonly(): Zod.z.ZodReadonly<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
>
Returns Zod.z.ZodReadonly<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

refine<
    RefinedOutput extends
        {
            [k in string
            | number]: addQuestionMarks<
                Zod.z.baseObjectOutputType<
                    { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                >,
                requiredKeys<
                    Zod.z.baseObjectOutputType<
                        { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                    >,
                >,
            >[k]
        },
>(
    check: (arg: Zod.z.output<Options[number]>) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
        | (
            arg: Zod.z.output<Options[number]>,
        ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Type Parameters
- RefinedOutput extends {
      [k in string | number]: addQuestionMarks<
          Zod.z.baseObjectOutputType<
              { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
          >,
          requiredKeys<
              Zod.z.baseObjectOutputType<
                  { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
              >,
          >,
      >[k]
  }
Parameters
- check: (arg: Zod.z.output<Options[number]>) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
      | (
          arg: Zod.z.output<Options[number]>,
      ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:65
refine(
    check: (arg: Zod.z.output<Options[number]>) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
        | (
            arg: Zod.z.output<Options[number]>,
        ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Parameters
- check: (arg: Zod.z.output<Options[number]>) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
      | (
          arg: Zod.z.output<Options[number]>,
      ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<
    RefinedOutput extends
        {
            [k in string
            | number]: addQuestionMarks<
                Zod.z.baseObjectOutputType<
                    { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                >,
                requiredKeys<
                    Zod.z.baseObjectOutputType<
                        { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                    >,
                >,
            >[k]
        },
>(
    check: (arg: Zod.z.output<Options[number]>) => arg is RefinedOutput,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: Zod.z.output<Options[number]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Type Parameters
- RefinedOutput extends {
      [k in string | number]: addQuestionMarks<
          Zod.z.baseObjectOutputType<
              { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
          >,
          requiredKeys<
              Zod.z.baseObjectOutputType<
                  { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
              >,
          >,
      >[k]
  }
Parameters
- check: (arg: Zod.z.output<Options[number]>) => arg is RefinedOutput
- refinementData:
      | Zod.z.IssueData
      | (
          arg: Zod.z.output<Options[number]>,
          ctx: Zod.z.RefinementCtx,
      ) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(
    check: (arg: Zod.z.output<Options[number]>) => boolean,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: Zod.z.output<Options[number]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Parameters
- check: (arg: Zod.z.output<Options[number]>) => boolean
- refinementData:
      | Zod.z.IssueData
      | (
          arg: Zod.z.output<Options[number]>,
          ctx: Zod.z.RefinementCtx,
      ) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
): Zod.z.SafeParseReturnType<
    Zod.z.input<Options[number]>,
    Zod.z.output<Options[number]>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Zod.z.SafeParseReturnType<
Zod.z.input<Options[number]>,
Zod.z.output<Options[number]>,
>
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<
        Zod.z.input<Options[number]>,
        Zod.z.output<Options[number]>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<
    Zod.z.SafeParseReturnType<
        Zod.z.input<Options[number]>,
        Zod.z.output<Options[number]>,
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<
    RefinedOutput extends
        {
            [k in string
            | number]: addQuestionMarks<
                Zod.z.baseObjectOutputType<
                    { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                >,
                requiredKeys<
                    Zod.z.baseObjectOutputType<
                        { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
                    >,
                >,
            >[k]
        },
>(
    refinement: (
        arg: Zod.z.output<Options[number]>,
        ctx: Zod.z.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Type Parameters
- RefinedOutput extends {
      [k in string | number]: addQuestionMarks<
          Zod.z.baseObjectOutputType<
              { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
          >,
          requiredKeys<
              Zod.z.baseObjectOutputType<
                  { [key in string]: Zod.z.ZodTypeAny } & Zod.z.ZodRawShape,
              >,
          >,
      >[k]
  }
Parameters
- refinement: (
  arg: Zod.z.output<Options[number]>,
  ctx: Zod.z.RefinementCtx,
  ) => arg is RefinedOutput
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(
    refinement: (
        arg: Zod.z.output<Options[number]>,
        ctx: Zod.z.RefinementCtx,
    ) => void,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Parameters
- refinement: (arg: Zod.z.output<Options[number]>, ctx: Zod.z.RefinementCtx) => void
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71
superRefine(
    refinement: (
        arg: Zod.z.output<Options[number]>,
        ctx: Zod.z.RefinementCtx,
    ) => Promise<void>,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Parameters
- refinement: (arg: Zod.z.output<Options[number]>, ctx: Zod.z.RefinementCtx) => Promise<void>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.z.output<Options[number]>,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:72

transform

transform<NewOut>(
    transform: (
        arg: Zod.z.output<Options[number]>,
        ctx: Zod.z.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    NewOut,
    Zod.z.input<Options[number]>,
>
Type Parameters
- NewOut
Parameters
- transform: (
  arg: Zod.z.output<Options[number]>,
  ctx: Zod.z.RefinementCtx,
  ) => NewOut | Promise<NewOut>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
    NewOut,
    Zod.z.input<Options[number]>,
>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:81

`Static`create

create<
    Discriminator extends string,
    Types extends
        [
            Zod.z.ZodDiscriminatedUnionOption<Discriminator>,
            ...Zod.z.ZodDiscriminatedUnionOption<Discriminator>[],
        ],
>(
    discriminator: Discriminator,
    options: Types,
    params?: Zod.z.RawCreateParams,
): Zod.z.ZodDiscriminatedUnion<Discriminator, Types>
The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. However, it only allows a union of objects, all of which need to share a discriminator property. This property must have a different value for each object in the union.
Type Parameters
- Discriminator extends string
- Types extends [
  Zod.z.ZodDiscriminatedUnionOption<Discriminator>,
  ...Zod.z.ZodDiscriminatedUnionOption<Discriminator>[],
  ]
Parameters
- discriminator: Discriminator
  the name of the discriminator property
- options: Types
- Optionalparams: Zod.z.RawCreateParams
Returns Zod.z.ZodDiscriminatedUnion<Discriminator, Types>
- Defined in node_modules/zod/lib/types.d.ts:589

Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.ZodDiscriminatedUnion<Discriminator, Options>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Accessors

description

Returns undefined | string

discriminator

Returns Discriminator

options

Returns Options

optionsMap

Returns Map<Zod.z.Primitive, Zod.z.ZodDiscriminatedUnionOption<any>>

Methods

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<Zod.z.output<Options[number]>>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<Zod.z.output<Options[number]>>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<Zod.z.output<Options[number]>>

_processInputParams

Parameters

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

_refinement

Parameters

Returns Zod.z.ZodEffects< Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, Zod.z.output<Options[number]>, Zod.z.input<Options[number]>,>

and

Type Parameters

Parameters

Returns Zod.z.ZodIntersection<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, T>

array

Returns Zod.z.ZodArray<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, "many">

brand

Type Parameters

Parameters

Returns Zod.z.ZodBranded<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>, B>

catch

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>

default

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns Zod.z.ZodNullable<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>

nullish

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
Zod.z.output<Options[number]>,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodOptional<
Zod.z.ZodNullable<Zod.z.ZodDiscriminatedUnion<Discriminator, Options>>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
RefinedOutput,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
Zod.z.output<Options[number]>,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
RefinedOutput,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
Zod.z.output<Options[number]>,
Zod.z.input<Options[number]>,
>

Returns Zod.z.SafeParseReturnType<
Zod.z.input<Options[number]>,
Zod.z.output<Options[number]>,
>

Returns Promise<
Zod.z.SafeParseReturnType<
Zod.z.input<Options[number]>,
Zod.z.output<Options[number]>,
>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
RefinedOutput,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
Zod.z.output<Options[number]>,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
Zod.z.output<Options[number]>,
Zod.z.input<Options[number]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDiscriminatedUnion<Discriminator, Options>,
NewOut,
Zod.z.input<Options[number]>,
>

`Static`create