Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Discriminator extends string
Options extends ZodDiscriminatedUnionOption<Discriminator>[]

Hierarchy (view full)

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

Index

Constructors

constructor

new ZodDiscriminatedUnion<Discriminator, Options>(def): 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/zod/lib/types.d.ts:73

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, params?) => Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>)

Alias of safeParseAsync

Type declaration

- (data, params?): Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>
- 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/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<Primitive, ZodDiscriminatedUnionOption<any>>
Returns Map<Primitive, ZodDiscriminatedUnionOption<any>>
- Defined in node_modules/zod/lib/types.d.ts:580

Methods

_getOrReturnCtx

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

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

_refinement(refinement): ZodEffects<ZodDiscriminatedUnion<Discriminator, Options>, output<Options[number]>, input<Options[number]>>
Parameters
- refinement: ((arg, ctx) => any)
  - - (arg, ctx): 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/zod/lib/types.d.ts:69

and

and<T>(incoming): 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/lib/types.d.ts:80

array

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

brand

brand<B>(brand?): 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/zod/lib/types.d.ts:84

catch

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

default

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

describe

describe(description): 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>(option): 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/lib/types.d.ts:79

parse

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

parseAsync

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

pipe

pipe<T>(target): 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/lib/types.d.ts:91

promise

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

readonly

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

refine

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

refinement

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

safeParse

safeParse(data, params?): 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/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data, params?): 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/zod/lib/types.d.ts:62

superRefine

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

transform

transform<NewOut>(transform): ZodEffects<ZodDiscriminatedUnion<Discriminator, Options>, NewOut, input<Options[number]>>
Type Parameters
- NewOut
Parameters
- transform: ((arg, ctx) => NewOut | Promise<NewOut>)
  - - (arg, ctx): 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/zod/lib/types.d.ts:81

`Static` create

create<Discriminator, Types>(discriminator, options, params?): 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/zod/lib/types.d.ts:589

Class ZodDiscriminatedUnion<Discriminator, Options>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodDiscriminatedUnion<Discriminator, Options>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<output<Options[number]>>

_parseAsync

Parameters

Returns AsyncParseReturnType<output<Options[number]>>

_parseSync

Parameters

Returns SyncParseReturnType<output<Options[number]>>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

and

Type Parameters

Parameters

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

array

Returns ZodArray<ZodDiscriminatedUnion<Discriminator, Options>, "many">

brand

Type Parameters

Parameters

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

catch

Parameters

Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

Parameters

Parameters

error: ZodError<any>

input: input<Options[number]>

Returns output<Options[number]>

Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

default

Parameters

Returns ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>

Parameters

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

Returns {
ctx: ParseContext;
status: ParseStatus;
}