Function discriminatedUnion

discriminatedUnion<Discriminator, DiscriminatorValue, Types>(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.
Type Parameters
Type Parameters
- Discriminator extends string
- DiscriminatorValue extends Primitive
- Types extends [ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>, ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>, ...ZodDiscriminatedUnionOption<Discriminator, DiscriminatorValue>[]]
Parameters
- discriminator: Discriminator
  
  the name of the discriminator property
- types: Types
  
  an array of object schemas
- Optional params: RawCreateParams
Returns ZodDiscriminatedUnion<Discriminator, DiscriminatorValue, Types[number]>
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:443