Function union

union<Conditional extends UnionConditional<any>>(
conditionals: Conditional[],
): VineUnion<Conditional>
Create a new union schema type. A union is a collection of conditionals and schema associated with it.

Unions evaluate conditionals in order and apply the first matching schema. Use union.if() to define conditional branches and union.else() for the default fallback.
Type Parameters
- Conditional extends UnionConditional<any>
  The union conditional type
Parameters
- conditionals: Conditional[]
  Array of conditional branches to evaluate
Returns VineUnion<Conditional>
Example
```
const schema = vine.union([
  vine.union.if(
    (value) => typeof value === 'string',
    vine.string()
  ),
  vine.union.if(
    (value) => typeof value === 'number',
    vine.number()
  )
])
```
- Defined in src/schema/union/builder.ts:37

Index

Methods

Methods

if

if<Schema extends SchemaTypes>(
conditon: (value: Record<string, unknown>, field: FieldContext) => any,
schema: Schema,
): UnionConditional<Schema>
Wrap a schema inside a conditional branch. The condition is evaluated at runtime, and if it returns a truthy value, the associated schema is used for validation.
Type Parameters
- Schema extends SchemaTypes
  The schema type to apply when condition matches
Parameters
- conditon: (value: Record<string, unknown>, field: FieldContext) => any
  Function that evaluates whether this branch should be used
- schema: Schema
  The schema to apply if the condition is true
Returns UnionConditional<Schema>
Example
```
vine.union.if(
  (value) => value.type === 'email',
  vine.object({ email: vine.string().email() })
)
```
- Defined in src/schema/union/builder.ts:56

else

else<Schema extends SchemaTypes>(schema: Schema): UnionConditional<Schema>
Wrap a schema inside an else (default) conditional. This branch always matches and should be placed last in the union conditionals array.
Type Parameters
- Schema extends SchemaTypes
  The schema type to apply as default
Parameters
- schema: Schema
  The schema to apply when no other conditions match
Returns UnionConditional<Schema>
Example
```
vine.union([
  vine.union.if((value) => value.type === 'admin', adminSchema),
  vine.union.else(userSchema)
])
```
- Defined in src/schema/union/builder.ts:76