Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/src/schemas/variant/index.ts>variantAsync

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Go to Latest
function variantAsync
import { variantAsync } from "https://deno.land/x/valibot@v0.30.0/src/schemas/variant/index.ts";

Creates an async variant (aka discriminated union) schema.

Type Parameters

TKey extends string
TOptions extends VariantOptionsAsync<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

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

A validation and transformation pipe.

Returns

An async variant schema.

Creates an async variant (aka discriminated union) schema.

Type Parameters

TKey extends string
TOptions extends VariantOptionsAsync<TKey>

Parameters

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.

Returns

An async variant schema.