variantAsync | /src/index.ts | valibot@v0.30.0

Module

x/valibot/src/index.ts>variantAsync

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

error methods schemas storages transformations types utils validations

index.ts (default module)

BaseTransformationAsync

CustomValidationAsync

HexadecimalValidation

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

SafeIntegerValidation

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

IntersectOptionsAsync

PartialObjectEntriesAsync

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

ISO_TIME_SECOND_REGEX

any

bic

deleteSpecificMessage

mac

map

nan

set

url

ISO_TIME_SECOND_REGEX

function variantAsync

import { variantAsync } from "https://deno.land/x/valibot@v0.30.0/src/index.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>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

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

A validation and transformation pipe.

Returns

VariantSchemaAsync<TKey, TOptions>

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

VariantSchemaAsync<TKey, TOptions>

An async variant schema.