Interface $ZodUnionDef<Options>

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

Type Parameters

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

Hierarchy (View Summary)

$ZodTypeDef
- $ZodUnionDef
  - $ZodDiscriminatedUnionDef

Index

Properties

type options error? checks?

Properties

type

type: "union"

options

options: Options

`Optional`error

error?: $ZodErrorMap<never>

`Optional`checks

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