Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Discriminator extends string
Options extends readonly ZodDiscriminatedUnionOption<Discriminator>[]

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodDiscriminatedUnion<
    Discriminator extends string,
    Options extends readonly ZodDiscriminatedUnionOption<Discriminator>[],
>(
    def: ZodDiscriminatedUnionDef,
): ZodDiscriminatedUnion<Discriminator, Options>
Type Parameters
- Discriminator extends string
- Options extends readonly ZodDiscriminatedUnionOption<Discriminator>[]
Parameters
- def: ZodDiscriminatedUnionDef
Returns ZodDiscriminatedUnion<Discriminator, Options>
Inherited from ZodType.constructor
- Defined in node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_type

_type: output

`Readonly`_output

_output: output

`Readonly`_input

_input: input

`Readonly`_def

_def: ZodDiscriminatedUnionDef

~standard

"~standard": Props<input<Options[number]>, output<Options[number]>>

spa

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

Alias of safeParseAsync

Accessors

description

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

discriminator

get discriminator(): Discriminator
Returns Discriminator
- Defined in node_modules/zod/v3/types.d.cts:613

options

get options(): Options
Returns Options
- Defined in node_modules/zod/v3/types.d.cts:614

optionsMap

get optionsMap(): Map<Primitive, ZodDiscriminatedUnionOption<any>>
Returns Map<Primitive, ZodDiscriminatedUnionOption<any>>
- Defined in node_modules/zod/v3/types.d.cts:615

Methods

_getType

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

_getOrReturnCtx

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

_processInputParams

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

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<output<Options[number]>>
Parameters
- input: ParseInput
Returns SyncParseReturnType<output<Options[number]>>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/v3/types.d.cts:62

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<output<Options[number]>>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<output<Options[number]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/v3/types.d.cts:63

parse

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

safeParse

safeParse(
data: unknown,
params?: InexactPartial<ParseParams>,
): SafeParseReturnType<input<Options[number]>, output<Options[number]>>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns SafeParseReturnType<input<Options[number]>, output<Options[number]>>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/v3/types.d.cts:65

~validate

"~validate"(
    data: unknown,
):
    | Result<output<Options[number]>>
    | Promise<Result<output<Options[number]>>>
Parameters
- data: unknown
Returns Result<output<Options[number]>> | Promise<Result<output<Options[number]>>>
Inherited from ZodType.~validate
- Defined in node_modules/zod/v3/types.d.cts:66

parseAsync

parseAsync(
data: unknown,
params?: InexactPartial<ParseParams>,
): Promise<output<Options[number]>>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<output<Options[number]>>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/v3/types.d.cts:67

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: InexactPartial<ParseParams>,
): Promise<
    SafeParseReturnType<input<Options[number]>, output<Options[number]>>,
>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/v3/types.d.cts:68

refine

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

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

_refinement

_refinement(
    refinement: (arg: output, ctx: RefinementCtx) => any,
): ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Parameters
- refinement: (arg: output, ctx: RefinementCtx) => any
Returns ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Inherited from ZodType._refinement
- Defined in node_modules/zod/v3/types.d.cts:75

superRefine

superRefine<
    RefinedOutput extends
        {
            [k in string
            | number]: addQuestionMarks<
                baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
                any,
            >[k]
        },
>(
    refinement: (arg: output, ctx: RefinementCtx) => arg is RefinedOutput,
): ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    input<Options[number]>,
>
Type Parameters
- RefinedOutput extends {
      [k in string | number]: addQuestionMarks<
          baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
          any,
      >[k]
  }
Parameters
- refinement: (arg: output, ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    RefinedOutput,
    input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:76
superRefine(
    refinement: (arg: output, ctx: RefinementCtx) => void,
): ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Parameters
- refinement: (arg: output, ctx: RefinementCtx) => void
Returns ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:77
superRefine(
    refinement: (arg: output, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Parameters
- refinement: (arg: output, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<
    ZodDiscriminatedUnion<Discriminator, Options>,
    output<Options[number]>,
    input<Options[number]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:78

or

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

and

and<T extends ZodTypeAny>(
incoming: T,
): ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/v3/types.d.cts:86

transform

transform<NewOut>(
transform: (arg: output, ctx: RefinementCtx) => NewOut | Promise<NewOut>,
): ZodEffects<ZodDiscriminatedUnion<Discriminator, Options>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: output, ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodDiscriminatedUnion<Discriminator, Options>, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/zod/v3/types.d.cts:87

default

default(
def: noUndefined<input<Options[number]>>,
): ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: noUndefined<input<Options[number]>>
Returns ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:88
default(
def: () => noUndefined<input<Options[number]>>,
): ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: () => noUndefined<input<Options[number]>>
Returns ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:89

brand

brand<B extends string | number | symbol>(
brand?: B,
): ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/v3/types.d.cts:90

catch

catch(def: output): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: output
Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:91
catch(
def: (ctx: { error: ZodError; input: input }) => output,
): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: (ctx: { error: ZodError; input: input }) => output
Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:92

describe

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

pipe

pipe<T extends ZodTypeAny>(
target: T,
): ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/v3/types.d.cts:97

readonly

readonly(): ZodReadonly<ZodDiscriminatedUnion<Discriminator, Options>>
Returns ZodReadonly<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/v3/types.d.cts:98

isOptional

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

isNullable

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

_parse

_parse(input: ParseInput): ParseReturnType<output<Options[number]>>
Parameters
- input: ParseInput
Returns ParseReturnType<output<Options[number]>>
Overrides ZodType._parse
- Defined in node_modules/zod/v3/types.d.cts:612

`Static`create

create<
    Discriminator extends string,
    Types extends
        readonly [
            ZodDiscriminatedUnionOption<Discriminator>,
            ZodDiscriminatedUnionOption<Discriminator>,
        ],
>(
    discriminator: Discriminator,
    options: Types,
    params?: RawCreateParams,
): 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 readonly [
  ZodDiscriminatedUnionOption<Discriminator>,
  ZodDiscriminatedUnionOption<Discriminator>,
  ]
Parameters
- discriminator: Discriminator
  the name of the discriminator property
- options: Types
- Optionalparams: RawCreateParams
Returns ZodDiscriminatedUnion<Discriminator, Types>
- Defined in node_modules/zod/v3/types.d.cts:624

Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodDiscriminatedUnion<Discriminator, Options>

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

Accessors

description

Returns undefined | string

discriminator

Returns Discriminator

options

Returns Options

optionsMap

Returns Map<Primitive, ZodDiscriminatedUnionOption<any>>

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

Returns SyncParseReturnType<output<Options[number]>>

_parseAsync

Parameters

Returns AsyncParseReturnType<output<Options[number]>>

parse

Parameters

Returns output

safeParse

Parameters

Returns SafeParseReturnType<input<Options[number]>, output<Options[number]>>

~validate

Parameters

Returns Result<output<Options[number]>> | Promise<Result<output<Options[number]>>>

parseAsync

Parameters

Returns Promise<output<Options[number]>>

safeParseAsync

Parameters

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

refine

Type Parameters

Parameters

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

Parameters

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

refinement

Type Parameters

Parameters

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

Parameters

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

_refinement

Parameters

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

superRefine

Type Parameters

Parameters

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

Parameters

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

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

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

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

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

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

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

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

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

`Static`create