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

function variantAsync

import { variantAsync } from "https://deno.land/x/valibot@v0.28.1/mod.ts";

variantAsync<TKey extends string, TOptions extends VariantOptionsAsync<TKey>>(

key: TKey,

options: TOptions,

pipe?: PipeAsync<Input<TOptions[number]>>,

): VariantSchemaAsync<TKey, TOptions>

Creates an async variant (aka discriminated union) schema.

variantAsync<TKey extends string, TOptions extends VariantOptionsAsync<TKey>>(

key: TKey,

options: TOptions,

message?: ErrorMessage,

pipe?: PipeAsync<Input<TOptions[number]>>,

): VariantSchemaAsync<TKey, TOptions>

Creates an async variant (aka discriminated union) schema.

Type Parameters

TKey extends string

TOptions extends VariantOptionsAsync<TKey>

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

pipe: PipeAsync<Input<TOptions[number]>>

A validation and transformation pipe.

VariantSchemaAsync<TKey, TOptions>

An async variant schema.

Creates an async variant (aka discriminated union) schema.

TKey extends string

TOptions extends VariantOptionsAsync<TKey>

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<Input<TOptions[number]>>

A validation and transformation pipe.

VariantSchemaAsync<TKey, TOptions>

An async variant schema.