Module

x/zod/index.ts>ZodDiscriminatedUnion

TypeScript-first schema validation with static type inference
colinhacks/zod
Extremely Popular
Go to Latest
class ZodDiscriminatedUnion
extends ZodType<Option["_output"], ZodDiscriminatedUnionDef<Discriminator, DiscriminatorValue, Option>, Option["_input"]>
import { ZodDiscriminatedUnion } from "https://dotland.deno.dev/x/zod@v3.19.1/index.ts";

Type Parameters

Discriminator extends string
DiscriminatorValue extends Primitive
Option extends ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>

Properties

readonly
discriminator
readonly
options
readonly
validDiscriminatorValues

Methods

_parse(input: ParseInput): ParseReturnType<this["_output"]>

Static Methods

create<Discriminator extends string, DiscriminatorValue extends Primitive, Types extends [ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>, ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>, ...ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>[]]>(
discriminator: Discriminator,
types: Types,
params?: RawCreateParams,
): ZodDiscriminatedUnion<Discriminator, DiscriminatorValue, Types[number]>

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.