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

Deno 2 is finally here 🎉️

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

function variant

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

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

key: TKey,

options: 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

message: ErrorMessage = [UNSUPPORTED]

The error message.

A variant schema.