variant | /mod.ts | valibot@v0.28.1

function variant

import { variant } from "https://deno.land/x/valibot@v0.28.1/mod.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>

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

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

A validation and transformation pipe.

VariantSchema<TKey, TOptions>

A variant schema.

Creates a variant (aka discriminated union) schema.

TKey extends string

TOptions extends VariantOptions<TKey>

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.

VariantSchema<TKey, TOptions>

A variant schema.