Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
method ZodDiscriminatedUnion.create
import { ZodDiscriminatedUnion } from "https://deno.land/x/netzo@0.3.66/deps/zod/mod.ts";

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

an array of object schemas

optional
params: RawCreateParams

Returns

ZodDiscriminatedUnion<Discriminator, Types>