tuple | /src/schemas/index.ts | valibot@v0.24.0

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

any array bigint blob boolean date enum instance intersect literal map nan never nonNullable nonNullish nonOptional null nullable nullish number object optional picklist record recursive set special string symbol tuple undefined union unknown variant void

index.ts (default module)

AnySchema

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

discriminatedUnionAsync

any

map

nan

set

function tuple

import { tuple } from "https://deno.land/x/valibot@v0.24.0/src/schemas/index.ts";

tuple<TItems extends TupleItems>(items: TItems, pipe?: Pipe<TupleOutput<TItems, undefined>>): TupleSchema<TItems>

Creates a tuple schema.

tuple<TItems extends TupleItems>(

items: TItems,

message?: ErrorMessage,

pipe?: Pipe<TupleOutput<TItems, undefined>>,

): TupleSchema<TItems>

Creates a tuple schema.

tuple<TItems extends TupleItems, TRest extends BaseSchema | undefined>(

items: TItems,

rest: TRest,

pipe?: Pipe<TupleOutput<TItems, TRest>>,

): TupleSchema<TItems, TRest>

Creates a tuple schema.

tuple<TItems extends TupleItems, TRest extends BaseSchema | undefined>(

items: TItems,

rest: TRest,

message?: ErrorMessage,

pipe?: Pipe<TupleOutput<TItems, TRest>>,

): TupleSchema<TItems, TRest>

Creates a tuple schema.

Type Parameters

TItems extends TupleItems

Parameters

items: TItems

The items schema.

optional

pipe: Pipe<TupleOutput<TItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchema<TItems>

A tuple schema.

Creates a tuple schema.

Type Parameters

TItems extends TupleItems

Parameters

items: TItems

The items schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<TupleOutput<TItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchema<TItems>

A tuple schema.

Creates a tuple schema.

Type Parameters

TItems extends TupleItems

TRest extends BaseSchema | undefined

Parameters

items: TItems

The items schema.

rest: TRest

The rest schema.

optional

pipe: Pipe<TupleOutput<TItems, TRest>>

A validation and transformation pipe.

Returns

TupleSchema<TItems, TRest>

A tuple schema.

Creates a tuple schema.

Type Parameters

TItems extends TupleItems

TRest extends BaseSchema | undefined

Parameters

items: TItems

The items schema.

rest: TRest

The rest schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<TupleOutput<TItems, TRest>>

A validation and transformation pipe.

Returns

TupleSchema<TItems, TRest>

A tuple schema.