Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/src/schemas/union/index.ts>UnionSchema

The modular and type safe schema library for validating structural data 🤖
Go to Latest
interface UnionSchema
implements BaseSchema<InferInput<TOptions[number]>, InferOutput<TOptions[number]>, UnionIssue<InferIssue<TOptions[number]>> | InferIssue<TOptions[number]>>
import { type UnionSchema } from "https://deno.land/x/valibot@v0.41.0/src/schemas/union/index.ts";

Union schema type.

Type Parameters

TOptions extends UnionOptions
TMessage extends ErrorMessage<UnionIssue<InferIssue<TOptions[number]>>> | undefined

Properties

readonly
type: "union"

The schema type.

readonly
reference: union

The schema reference.

readonly
options: TOptions

The union options.

readonly
message: TMessage

The error message.