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

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

any array bigint blob boolean date enumType instance intersection literal map nan nativeEnum never nonNullable nonNullish nonOptional nullType nullable nullish number object optional record recursive set special string symbol tuple undefinedType union unknown voidType

index.ts (default module)

AnySchema

IntersectionOptionsAsync

IntersectionSchema

IntersectionSchemaAsync

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

function tuple

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

tuple<TTupleItems extends TupleShape>(items: TTupleItems, pipe?: Pipe<TupleOutput<TTupleItems, undefined>>): TupleSchema<TTupleItems>

Creates a tuple schema.

tuple<TTupleItems extends TupleShape>(

items: TTupleItems,

error?: ErrorMessage,

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

): TupleSchema<TTupleItems>

Creates a tuple schema.

tuple<TTupleItems extends TupleShape, TTupleRest extends BaseSchema>(

items: TTupleItems,

rest: TTupleRest,

pipe?: Pipe<TupleOutput<TTupleItems, TTupleRest>>,

): TupleSchema<TTupleItems, TTupleRest>

Creates a tuple schema.

tuple<TTupleItems extends TupleShape, TTupleRest extends BaseSchema>(

items: TTupleItems,

rest: TTupleRest,

error?: ErrorMessage,

pipe?: Pipe<TupleOutput<TTupleItems, TTupleRest>>,

): TupleSchema<TTupleItems, TTupleRest>

Creates a tuple schema.

Type Parameters

TTupleItems extends TupleShape

Parameters

items: TTupleItems

The items schema.

optional

pipe: Pipe<TupleOutput<TTupleItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchema<TTupleItems>

A tuple schema.

Creates a tuple schema.

Type Parameters

TTupleItems extends TupleShape

Parameters

items: TTupleItems

The items schema.

optional

error: ErrorMessage

The error message.

optional

pipe: Pipe<TupleOutput<TTupleItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchema<TTupleItems>

A tuple schema.

Creates a tuple schema.

Type Parameters

TTupleItems extends TupleShape

TTupleRest extends BaseSchema

Parameters

items: TTupleItems

The items schema.

rest: TTupleRest

The rest schema.

optional

pipe: Pipe<TupleOutput<TTupleItems, TTupleRest>>

A validation and transformation pipe.

Returns

TupleSchema<TTupleItems, TTupleRest>

A tuple schema.

Creates a tuple schema.

Type Parameters

TTupleItems extends TupleShape

TTupleRest extends BaseSchema

Parameters

items: TTupleItems

The items schema.

rest: TTupleRest

The rest schema.

optional

error: ErrorMessage

The error message.

optional

pipe: Pipe<TupleOutput<TTupleItems, TTupleRest>>

A validation and transformation pipe.

Returns

TupleSchema<TTupleItems, TTupleRest>

A tuple schema.