z.ZodDiscriminatedUnion | /deps.ts | deno_books@v1.2.0

method z.ZodDiscriminatedUnion.create

import { z } from "https://deno.land/x/deno_books@v1.2.0/deps.ts";
const { ZodDiscriminatedUnion } = z;

create<Discriminator extends string, Types extends [ZodDiscriminatedUnionOption<Discriminator>, ...ZodDiscriminatedUnionOption<Discriminator>[]]>(

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

an array of object schemas

optional

params: RawCreateParams

Returns

ZodDiscriminatedUnion<Discriminator, Types>