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

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

The modular and type safe schema library for validating structural data 🤖
Go to Latest
function variant
Re-export
import { variant } from "https://deno.land/x/valibot@v1.0.0-beta.4/src/schemas/variant/index.ts";

Creates a variant schema.

Type Parameters

TKey extends string
TOptions extends VariantOptions<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

Returns

A variant schema.

Creates a variant schema.

Type Parameters

TKey extends string
TOptions extends VariantOptions<TKey>
TMessage extends ErrorMessage<VariantIssue> | undefined

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

message: TMessage

The error message.