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.
Type Parameters
- Conditional extends UnionConditional<any>
Parameters
- conditionals: Conditional[]
Returns VineUnion<Conditional>
- Defined in src/schema/union/builder.ts:18

Index

Methods

Methods

if

if<Schema extends SchemaTypes>(
conditon: (value: Record<string, unknown>, field: FieldContext) => any,
schema: Schema,
): UnionConditional<Schema>
Wrap object properties inside a conditonal
Type Parameters
- Schema extends SchemaTypes
Parameters
- conditon: (value: Record<string, unknown>, field: FieldContext) => any
- schema: Schema
Returns UnionConditional<Schema>
- Defined in src/schema/union/builder.ts:25

else

else<Schema extends SchemaTypes>(schema: Schema): UnionConditional<Schema>
Wrap object properties inside an else conditon
Type Parameters
- Schema extends SchemaTypes
Parameters
- schema: Schema
Returns UnionConditional<Schema>
- Defined in src/schema/union/builder.ts:35