Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Discriminator extends string
Options extends ZodDiscriminatedUnionOption<Discriminator>[]

Hierarchy

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

Index

Constructors

constructor

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

Properties

`Readonly` _def

_def: ZodDiscriminatedUnionDef<Discriminator, Options>

`Readonly` _input

_input: input<Options[number]>

`Readonly` _output

_output: output<Options[number]>

`Readonly` _type

_type: output<Options[number]>

spa

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

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>
- Alias of safeParseAsync
  Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>

Accessors

description

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

discriminator

get discriminator(): Discriminator
Returns Discriminator
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:506

options

get options(): Options
Returns Options
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:507

optionsMap

get optionsMap(): Map<Primitive, ZodDiscriminatedUnionOption<any>>
Returns Map<Primitive, ZodDiscriminatedUnionOption<any>>
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:508

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:52

_getType

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

_parse

_parse(input: ParseInput): ParseReturnType<output<Options[number]>>
Parameters
- input: ParseInput
Returns ParseReturnType<output<Options[number]>>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:505

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<output<Options[number]>>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<output<Options[number]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts: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/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:57

_processInputParams

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

_refinement

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

and

and<T>(incoming: T): ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:79

array

array(): ZodArray<ZodDiscriminatedUnion<Discriminator, Options>, "many">
Returns ZodArray<ZodDiscriminatedUnion<Discriminator, Options>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:76

brand

brand<B>(brand?: B): ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:83

catch

catch(def: input<Options[number]>): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: input<Options[number]>
Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:84
catch(def: (() => input<Options[number]>)): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Parameters
- def: (() => input<Options[number]>)
  - - (): input<Options[number]>
    - Returns input<Options[number]>
Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:85

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

describe

describe(description: string): ZodDiscriminatedUnion<Discriminator, Options>
Parameters
- description: string
Returns ZodDiscriminatedUnion<Discriminator, Options>
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:86

isNullable

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

isOptional

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

nullable

nullable(): ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>
Returns ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:74

nullish

nullish(): ZodNullable<ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>>
Returns ZodNullable<ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:75

optional

optional(): ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>
Returns ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:73

or

or<T>(option: T): ZodUnion<[ZodDiscriminatedUnion<Discriminator, Options>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodDiscriminatedUnion<Discriminator, Options>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:78

parse

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

parseAsync

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

pipe

pipe<T>(target: T): ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:87

promise

promise(): ZodPromise<ZodDiscriminatedUnion<Discriminator, Options>>
Returns ZodPromise<ZodDiscriminatedUnion<Discriminator, Options>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:77

refine

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

refinement

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

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<input<Options[number]>, output<Options[number]>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<input<Options[number]>, output<Options[number]>>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:62

superRefine

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

transform

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

`Static` create

create<Discriminator, Types>(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 [ZodDiscriminatedUnionOption<Discriminator>, ...ZodDiscriminatedUnionOption<Discriminator>[]]
Parameters
- discriminator: Discriminator
  
  the name of the discriminator property
- options: Types
- Optional params: RawCreateParams
Returns ZodDiscriminatedUnion<Discriminator, Types>
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:517

Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Discriminator extends string

Options extends ZodDiscriminatedUnionOption<Discriminator>[]

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Discriminator extends string

Options extends ZodDiscriminatedUnionOption<Discriminator>[]

Parameters

def: ZodDiscriminatedUnionDef<Discriminator, Options>

Returns ZodDiscriminatedUnion<Discriminator, Options>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

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

Accessors

description

Returns undefined | string

discriminator

Returns Discriminator

options

Returns Options

optionsMap

Returns Map<Primitive, ZodDiscriminatedUnionOption<any>>

Methods

_getOrReturnCtx

Parameters

input: ParseInput

Optional ctx: ParseContext

Returns ParseContext

_getType

Parameters

input: ParseInput

Returns string

_parse

Parameters

input: ParseInput

Returns ParseReturnType<output<Options[number]>>

_parseAsync

Parameters

input: ParseInput

Returns AsyncParseReturnType<output<Options[number]>>

_parseSync

Parameters

input: ParseInput

Returns SyncParseReturnType<output<Options[number]>>

_processInputParams

Parameters

input: ParseInput

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

refinement: ((arg: output<Options[number]>, ctx: RefinementCtx) => any)

Parameters

arg: output<Options[number]>

ctx: RefinementCtx

Returns any

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

and

Type Parameters

T extends ZodType<any, any, any, T>

Parameters

incoming: T

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

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Optional` params: Partial<ParseParams>

`Optional` ctx: ParseContext

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B

`Optional` params: Partial<ParseParams>

`Optional` params: Partial<ParseParams>