union | /src/schemas/index.ts | valibot@v0.19.0 | Deno

Skip to main content

Deno 2 is finally here 🎉️

x/valibot/src/schemas/index.ts>union

The modular and type safe schema library for validating structural data 🤖

fabian-hiller/valibot

Menu

any array bigint blob boolean date enumType instance intersection literal map nan nativeEnum never nonNullable nonNullish nonOptional nullType nullable nullish number object optional record recursive set special string symbol tuple undefinedType union unknown voidType

index.ts (default module)

ArraySchemaAsync

BigintSchemaAsync

BlobSchemaAsync

BooleanSchemaAsync

DateSchemaAsync

EnumSchemaAsync

InstanceSchemaAsync

IntersectionOptions

IntersectionOptionsAsync

IntersectionSchema

IntersectionSchemaAsync

LiteralSchemaAsync

NativeEnumSchema

NativeEnumSchemaAsync

NeverSchemaAsync

NonNullableSchema

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

NullableSchemaAsync

NullishSchemaAsync

NullSchemaAsync

NumberSchemaAsync

ObjectSchemaAsync

ObjectShapeAsync

OptionalSchemaAsync

RecordSchemaAsync

RecursiveSchema

RecursiveSchemaAsync

SpecialSchemaAsync

StringSchemaAsync

SymbolSchemaAsync

TupleSchemaAsync

TupleShapeAsync

UndefinedSchema

UndefinedSchemaAsync

UnionOptionsAsync

UnionSchemaAsync

UnknownSchemaAsync

VoidSchemaAsync

intersectionAsync

nativeEnumAsync

nonNullableAsync

nonNullishAsync

nonOptionalAsync

undefinedTypeAsync

function union

import { union } from "https://deno.land/x/valibot@v0.19.0/src/schemas/index.ts";

union<TUnionOptions extends UnionOptions>(union: TUnionOptions, error?: ErrorMessage): UnionSchema<TUnionOptions>

Creates a union schema.

Type Parameters

TUnionOptions extends UnionOptions

Parameters

union: TUnionOptions

The union schema.

optional

error: ErrorMessage

The error message.

Returns

UnionSchema<TUnionOptions>

A union schema.