Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/zod/index.ts>z.ZodDiscriminatedUnion.create

TypeScript-first schema validation with static type inference
Extremely Popular
Go to Latest
method z.ZodDiscriminatedUnion.create
import { z } from "https://deno.land/x/zod@v3.23.0-beta.0/index.ts";
const { ZodDiscriminatedUnion } = z;

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.

Parameters

discriminator: Discriminator

the name of the discriminator property

options: Types

an array of object schemas

optional
params: RawCreateParams