Interface $ZodDiscriminatedUnionDef<Options, Disc>

interface $ZodDiscriminatedUnionDef<
    Options extends readonly SomeType[] = readonly z.core.$ZodType[],
    Disc extends string = string,
> {
    discriminator: Disc;
    unionFallback?: boolean;
    type: "union";
    options: Options;
    error?: $ZodErrorMap<never>;
    checks?: z.core.$ZodCheck<never>[];
}

Type Parameters

Options extends readonly SomeType[] = readonly z.core.$ZodType[]
Disc extends string = string

Hierarchy (View Summary)

$ZodUnionDef<Options>
- $ZodDiscriminatedUnionDef

Index

Properties

discriminator unionFallback? type options error? checks?

Properties

discriminator

discriminator: Disc

`Optional`unionFallback

unionFallback?: boolean

type

type: "union"

options

options: Options

`Optional`error

error?: $ZodErrorMap<never>

`Optional`checks

checks?: z.core.$ZodCheck<never>[]