VariantSchema | /src/schemas/index.ts | valibot@v1.0.0-beta.2-to-json-schema

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

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

Extremely 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

interface VariantSchema

implements BaseSchema<InferInput<TOptions[number]>, InferOutput<TOptions[number]>, VariantIssue | InferVariantIssue<TOptions>>

import { type VariantSchema } from "https://deno.land/x/valibot@v1.0.0-beta.2-to-json-schema/src/schemas/index.ts";

Variant schema type.

Type Parameters

TKey extends string

TOptions extends VariantOptions<TKey>

TMessage extends ErrorMessage<VariantIssue> | undefined

Properties

readonly

type: "variant"

The schema type.

readonly

reference: variant

The schema reference.

readonly

expects: "Object"

The expected property.

readonly

key: TKey

The discriminator key.

readonly

options: TOptions

The variant options.

readonly

message: TMessage

The error message.