variant | /src/schemas/index.ts | valibot@v0.28.1

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

Extremely Popular

any array bigint blob boolean date enum instance intersect literal map nan never nonNullable nonNullish nonOptional null nullable nullish number object optional picklist record recursive set special string symbol tuple undefined union unknown variant void

index.ts (default module)

NonNullableSchemaAsync

NonNullishInput

NonNullishOutput

NonNullishSchema

NonNullishSchemaAsync

NonOptionalInput

NonOptionalOutput

NonOptionalSchema

NonOptionalSchemaAsync

discriminatedUnionAsync

any

map

nan

set

function variant

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

variant<TKey extends string, TOptions extends VariantOptions<TKey>>(

key: TKey,

options: TOptions,

pipe?: Pipe<Output<TOptions[number]>>,

): VariantSchema<TKey, TOptions>

Creates a variant (aka discriminated union) schema.

variant<TKey extends string, TOptions extends VariantOptions<TKey>>(

key: TKey,

options: TOptions,

message?: ErrorMessage,

pipe?: Pipe<Output<TOptions[number]>>,

): VariantSchema<TKey, TOptions>

Creates a variant (aka discriminated union) schema.

Type Parameters

TKey extends string

TOptions extends VariantOptions<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

pipe: Pipe<Output<TOptions[number]>>

A validation and transformation pipe.

Returns

VariantSchema<TKey, TOptions>

A variant schema.

Creates a variant (aka discriminated union) schema.

Type Parameters

TKey extends string

TOptions extends VariantOptions<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<Output<TOptions[number]>>

A validation and transformation pipe.

Returns

VariantSchema<TKey, TOptions>

A variant schema.