tuple | /src/index.ts | valibot@v0.8.0

Module

x/valibot/src/index.ts>tuple

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

fabian-hiller/valibot

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function tuple

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

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

Creates a tuple schema.

tuple<TTupleItems extends TupleShape, TTupleRest extends BaseSchema | undefined = undefined>(

items: TTupleItems,

error?: string,

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

): TupleSchema<TTupleItems, TTupleRest>

Creates a tuple schema.

tuple<TTupleItems extends TupleShape, TTupleRest extends BaseSchema | undefined = undefined>(

items: TTupleItems,

rest: TTupleRest,

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

): TupleSchema<TTupleItems, TTupleRest>

Creates a tuple schema.

tuple<TTupleItems extends TupleShape, TTupleRest extends BaseSchema | undefined = undefined>(

items: TTupleItems,

rest: TTupleRest,

error?: string,

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

): TupleSchema<TTupleItems, TTupleRest>

Creates a tuple schema.

Type Parameters

TTupleItems extends TupleShape

optional

TTupleRest extends BaseSchema | undefined = undefined

Parameters

items: TTupleItems

The items 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

optional

TTupleRest extends BaseSchema | undefined = undefined

Parameters

items: TTupleItems

The items schema.

optional

error: string

The error message.

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

optional

TTupleRest extends BaseSchema | undefined = undefined

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

optional

TTupleRest extends BaseSchema | undefined = undefined

Parameters

items: TTupleItems

The items schema.

rest: TTupleRest

The rest schema.

optional

error: string

The error message.

optional

pipe: Pipe<TupleOutput<TTupleItems, TTupleRest>>

A validation and transformation pipe.

Returns

TupleSchema<TTupleItems, TTupleRest>

A tuple schema.