variant | /mod.ts | valibot@v0.25.0

Module

x/valibot/mod.ts>variant

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

src

mod.ts (default module)

BaseTransformationAsync

CustomValidationAsync

HexadecimalValidation

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

PartialObjectEntriesAsync

SafeIntegerValidation

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

discriminatedUnionAsync

ISO_TIME_SECOND_REGEX

any

bic

mac

map

nan

set

url

function variant

import { variant } from "https://deno.land/x/valibot@v0.25.0/mod.ts";

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

key: TKey,

options: TOptions,

pipe?: Pipe<Input<TOptions[number]>>,

): VariantSchema<TKey, TOptions>

Creates a variant (aka discriminated union) schema.

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

key: TKey,

options: TOptions,

message?: ErrorMessage,

pipe?: Pipe<Input<TOptions[number]>>,

): VariantSchema<TKey, TOptions>

Creates a variant (aka discriminated union) schema.

Type Parameters

TKey extends string

TOptions extends VariantOptions<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

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

A validation and transformation pipe.

Returns

VariantSchema<TKey, TOptions>

A variant schema.

Creates a variant (aka discriminated union) schema.

Type Parameters

TKey extends string

TOptions extends VariantOptions<TKey>

Parameters

key: TKey

The discriminator key.

options: TOptions

The variant options.

optional

message: ErrorMessage

The error message.

optional

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

A validation and transformation pipe.

Returns

VariantSchema<TKey, TOptions>

A variant schema.