tupleAsync | /src/schemas/index.ts | valibot@v0.28.1

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

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

Extremely Popular

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)

NonNullableSchemaAsync

NonNullishInput

NonNullishOutput

NonNullishSchema

NonNullishSchemaAsync

NonOptionalInput

NonOptionalOutput

NonOptionalSchema

NonOptionalSchemaAsync

discriminatedUnionAsync

any

map

nan

set

function tupleAsync

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

tupleAsync<TItems extends TupleItemsAsync>(items: TItems, pipe?: PipeAsync<TupleOutput<TItems, undefined>>): TupleSchemaAsync<TItems>

Creates an async tuple schema.

tupleAsync<TItems extends TupleItemsAsync>(

items: TItems,

message?: ErrorMessage,

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

): TupleSchemaAsync<TItems>

Creates an async tuple schema.

tupleAsync<TItems extends TupleItemsAsync, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

items: TItems,

rest: TRest,

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

): TupleSchemaAsync<TItems, TRest>

Creates an async tuple schema.

tupleAsync<TItems extends TupleItemsAsync, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

items: TItems,

rest: TRest,

message?: ErrorMessage,

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

): TupleSchemaAsync<TItems, TRest>

Creates an async tuple schema.

Type Parameters

TItems extends TupleItemsAsync

Parameters

items: TItems

The items schema.

optional

pipe: PipeAsync<TupleOutput<TItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchemaAsync<TItems>

An async tuple schema.

Creates an async tuple schema.

Type Parameters

TItems extends TupleItemsAsync

Parameters

items: TItems

The items schema.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<TupleOutput<TItems, undefined>>

A validation and transformation pipe.

Returns

TupleSchemaAsync<TItems>

An async tuple schema.

Creates an async tuple schema.

Type Parameters

TItems extends TupleItemsAsync

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

items: TItems

The items schema.

rest: TRest

The rest schema.

optional

pipe: PipeAsync<TupleOutput<TItems, TRest>>

A validation and transformation pipe.

Returns

TupleSchemaAsync<TItems, TRest>

An async tuple schema.

Creates an async tuple schema.

Type Parameters

TItems extends TupleItemsAsync

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

items: TItems

The items schema.

rest: TRest

The rest schema.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<TupleOutput<TItems, TRest>>

A validation and transformation pipe.

Returns

TupleSchemaAsync<TItems, TRest>

An async tuple schema.