variantAsync | /src/schemas/index.ts | valibot@v1.0.0-beta.7

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

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

Popular

Latest

any array bigint blob boolean custom date enum file function instance intersect lazy literal looseObject looseTuple map nan never nonNullable nonNullish nonOptional null nullable nullish number object objectWithRest optional picklist promise record set strictObject strictTuple string symbol tuple tupleWithRest undefined undefinedable union unknown variant void

index.ts (default module)

LooseObjectSchemaAsync

LooseTupleIssue

LooseTupleSchema

LooseTupleSchemaAsync

NonNullableSchemaAsync

NonNullishIssue

NonNullishSchema

NonNullishSchemaAsync

NonOptionalIssue

NonOptionalSchema

NonOptionalSchemaAsync

ObjectWithRestSchemaAsync

StrictObjectSchemaAsync

StrictTupleIssue

StrictTupleSchema

StrictTupleSchemaAsync

TupleWithRestSchemaAsync

UndefinedableSchema

UndefinedableSchemaAsync

VariantOptionSchemaAsync

InferNonNullableInput

InferNonNullableIssue

InferNonNullableOutput

InferNonNullishInput

InferNonNullishIssue

InferNonNullishOutput

InferNonOptionalInput

InferNonOptionalIssue

InferNonOptionalOutput

InferUndefinedableOutput

InferVariantIssue

IntersectOptions

IntersectOptionsAsync

any

map

nan

set

function variantAsync

Re-export

import { variantAsync } from "https://deno.land/x/valibot@v1.0.0-beta.7/src/schemas/index.ts";

variantAsync<TKey extends string, TOptions extends VariantOptionsAsync<TKey>>(key: TKey, options: TOptions): VariantSchemaAsync<TKey, TOptions, undefined>

Creates a variant schema.

variantAsync<TKey extends string, TOptions extends VariantOptionsAsync<TKey>, TMessage extends ErrorMessage<VariantIssue> | undefined>(

key: TKey,

options: TOptions,

message: TMessage,

): VariantSchemaAsync<TKey, TOptions, TMessage>

Creates a variant schema.

Type Parameters

TKey extends string

TOptions extends VariantOptionsAsync<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

Returns

VariantSchemaAsync<TKey, TOptions, undefined>

A variant schema.

Creates a variant schema.

Type Parameters

TKey extends string

TOptions extends VariantOptionsAsync<TKey>

TMessage extends ErrorMessage<VariantIssue> | undefined

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

message: TMessage

The error message.

Returns

VariantSchemaAsync<TKey, TOptions, TMessage>

An variant schema.