variant | /mod.ts | valibot@v1.0.0-beta.2-to-json-schema

Module

x/valibot/mod.ts>variant

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

fabian-hiller/valibot

Extremely Popular

Latest

src

mod.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

SchemaWithFallbackAsync

SchemaWithOmit

SchemaWithPartial

SchemaWithPartialAsync

SchemaWithRequiredAsync

ISO_TIME_SECOND_REGEX

any

deleteSpecificMessage

map

nan

set

function variant

Re-export

import { variant } from "https://deno.land/x/valibot@v1.0.0-beta.2-to-json-schema/mod.ts";

variant<TKey extends string, TOptions extends VariantOptions<TKey>>(key: TKey, options: TOptions): VariantSchema<TKey, TOptions, undefined>

Creates a variant schema.

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

key: TKey,

options: TOptions,

message: TMessage,

): VariantSchema<TKey, TOptions, TMessage>

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

VariantSchema<TKey, TOptions, undefined>

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.

Returns

VariantSchema<TKey, TOptions, TMessage>

An variant schema.