Class VineUnionOfTypes<Schema>

Vine union of types represents a union data type that automatically determines which schema to apply based on the value's type.

Unlike regular unions that require explicit conditionals, unionOfTypes uses each schema's IS_OF_TYPE method to automatically detect the appropriate schema based on the input value's type.

Example

const schema = vine.unionOfTypes([
  vine.string(),
  vine.number(),
  vine.boolean()
])

Example

const schema = vine.unionOfTypes([
  vine.object({ type: vine.literal('user'), name: vine.string() }),
  vine.object({ type: vine.literal('admin'), permissions: vine.array(vine.string()) })
])

Type Parameters

Schema extends SchemaTypes
The schema types that make up this union

Implements

ConstructableSchema<
    Schema[typeof ITYPE],
    Schema[typeof OTYPE],
    Schema[typeof COTYPE],
>
WithJSONSchema

Index

Constructors

constructor

new VineUnionOfTypes<Schema extends SchemaTypes>(
schemas: Schema[],
): VineUnionOfTypes<Schema>
Creates a new VineUnionOfTypes instance with the specified schemas.
Type Parameters
- Schema extends SchemaTypes
  The schema types that make up this union
Parameters
- schemas: Schema[]
  Array of schemas to match against input values
Returns VineUnionOfTypes<Schema>
- Defined in src/schema/union_of_types/main.ts:86

Properties

[ITYPE]

"[ITYPE]": Schema[typeof ITYPE]

The input type of the schema

[OTYPE]

"[OTYPE]": Schema[typeof OTYPE]

The output type of the schema

[COTYPE]

"[COTYPE]": Schema[typeof COTYPE]

The camelCase output type of the schema

Methods

otherwise

otherwise(callback: UnionNoMatchCallback<Record<string, unknown>>): this
Define a fallback method to invoke when all of the union conditions fail. You may use this method to report an error.
Parameters
- callback: UnionNoMatchCallback<Record<string, unknown>>
Returns this
- Defined in src/schema/union_of_types/main.ts:94

clone

clone(): this
Clones the VineUnionOfTypes schema type.

Returns this
Implementation of ConstructableSchema.clone
- Defined in src/schema/union_of_types/main.ts:102

optional

optional(): VineUnionOfTypes<VineOptional<undefined> | Schema>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns VineUnionOfTypes<VineOptional<undefined> | Schema>
- Defined in src/schema/union_of_types/main.ts:113

nullable

nullable(): VineUnionOfTypes<VineNull | Schema>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns VineUnionOfTypes<VineNull | Schema>
- Defined in src/schema/union_of_types/main.ts:127

toJSONSchema

toJSONSchema(): JSONSchema7
Transforms into JSONSchema.

Returns JSONSchema7
Implementation of WithJSONSchema.toJSONSchema
- Defined in src/schema/union_of_types/main.ts:134

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): UnionNode
Compiles the union of types schema to a compiler node.

Creates conditional branches for each schema using their IS_OF_TYPE methods to determine which schema matches the input value.
Parameters
- propertyName: string
  The name of the property being validated
- refs: RefsStore
  Reference store for tracking validators and conditionals
- options: ParserOptions
  Parser options including camelCase transformation
Returns UnionNode
Implementation of ConstructableSchema.[PARSE]
- Defined in src/schema/union_of_types/main.ts:150

Class VineUnionOfTypes<Schema>

Example

Example

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineUnionOfTypes<Schema>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Methods

otherwise

Parameters

Returns this

clone

Returns this

optional

Returns VineUnionOfTypes<VineOptional<undefined> | Schema>

nullable

Returns VineUnionOfTypes<VineNull | Schema>

toJSONSchema

Returns JSONSchema7

[PARSE]

Parameters

Returns UnionNode

Settings

On This Page