Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

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

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodDiscriminatedUnion<
    Discriminator extends string,
    Options extends Zod.ZodDiscriminatedUnionOption<Discriminator>[],
>(
    def: Zod.ZodDiscriminatedUnionDef,
): Zod.ZodDiscriminatedUnion<Discriminator, Options>
Type Parameters
- Discriminator extends string
- Options extends Zod.ZodDiscriminatedUnionOption<Discriminator>[]
Parameters
- def: Zod.ZodDiscriminatedUnionDef
Returns Zod.ZodDiscriminatedUnion<Discriminator, Options>
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodDiscriminatedUnionDef

`Readonly`_input

_input: Zod.input

`Readonly`_output

_output: Zod.output

`Readonly`_type

_type: Zod.output

spa

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

Alias of safeParseAsync

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

discriminator

get discriminator(): Discriminator
Returns Discriminator

options

get options(): Options
Returns Options

optionsMap

get optionsMap(): Map<Zod.Primitive, Zod.ZodDiscriminatedUnionOption<any>>
Returns Map<Zod.Primitive, Zod.ZodDiscriminatedUnionOption<any>>

Methods

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
    refinement: (arg: Zod.output, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<
    Zod.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.output<Options[number]>,
    Zod.input<Options[number]>,
>
Parameters
- refinement: (arg: Zod.output, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<
    Zod.ZodDiscriminatedUnion<Discriminator, Options>,
    Zod.output<Options[number]>,
    Zod.input<Options[number]>,
>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.ZodArray<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodDiscriminatedUnion<Discriminator, Options>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodDiscriminatedUnion<Discriminator, Options>, B>
Inherited from ZodType.brand

catch

catch(
def: Zod.output,
): Zod.ZodCatch<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: Zod.output
Returns Zod.ZodCatch<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: Zod.input }) => Zod.output,
): Zod.ZodCatch<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: (ctx: { error: Zod.ZodError; input: Zod.input }) => Zod.output
Returns Zod.ZodCatch<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch

default

default(
def: noUndefined<Zod.input<Options[number]>>,
): Zod.ZodDefault<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: noUndefined<Zod.input<Options[number]>>
Returns Zod.ZodDefault<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.default
default(
def: () => noUndefined<Zod.input<Options[number]>>,
): Zod.ZodDefault<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: () => noUndefined<Zod.input<Options[number]>>
Returns Zod.ZodDefault<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

nullable

nullable(): Zod.ZodNullable<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.ZodNullable<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<
Zod.ZodNullable<Zod.ZodDiscriminatedUnion<Discriminator, Options>>,
>
Returns Zod.ZodOptional<
Zod.ZodNullable<Zod.ZodDiscriminatedUnion<Discriminator, Options>>,
>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.ZodOptional<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.optional

or

or<T extends Zod.ZodTypeAny>(
option: T,
): Zod.ZodUnion<[Zod.ZodDiscriminatedUnion<Discriminator, Options>, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodDiscriminatedUnion<Discriminator, Options>, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): Zod.output
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.output
Inherited from ZodType.parse

parseAsync

parseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.output<Options[number]>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.output<Options[number]>>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(
target: T,
): Zod.ZodPipeline<Zod.ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.ZodPromise<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Returns Zod.ZodReadonly<Zod.ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.readonly

refine

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

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

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<
    Zod.input<Options[number]>,
    Zod.output<Options[number]>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<Zod.input<Options[number]>, Zod.output<Options[number]>>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Promise<
    Zod.SafeParseReturnType<
        Zod.input<Options[number]>,
        Zod.output<Options[number]>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<
    Zod.SafeParseReturnType<
        Zod.input<Options[number]>,
        Zod.output<Options[number]>,
    >,
>
Inherited from ZodType.safeParseAsync

superRefine

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

transform

transform<NewOut>(
    transform: (
        arg: Zod.output,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodDiscriminatedUnion<Discriminator, Options>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Zod.output, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodDiscriminatedUnion<Discriminator, Options>, NewOut>
Inherited from ZodType.transform

`Static`create

create<
    Discriminator extends string,
    Types extends
        [
            Zod.ZodDiscriminatedUnionOption<Discriminator>,
            ...Zod.ZodDiscriminatedUnionOption<Discriminator>[],
        ],
>(
    discriminator: Discriminator,
    options: Types,
    params?: Zod.RawCreateParams,
): Zod.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.ZodDiscriminatedUnionOption<Discriminator>,
  ...Zod.ZodDiscriminatedUnionOption<Discriminator>[],
  ]
Parameters
- discriminator: Discriminator
  the name of the discriminator property
- options: Types
- Optionalparams: Zod.RawCreateParams
Returns Zod.ZodDiscriminatedUnion<Discriminator, Types>

Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.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.Primitive, Zod.ZodDiscriminatedUnionOption<any>>

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

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

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

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

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

Returns Zod.ZodArray<Zod.ZodDiscriminatedUnion<Discriminator, Options>>

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

default

Parameters

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

Parameters

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

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

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

nullish

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

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

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

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

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

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

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

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

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

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

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

`Static`create