array | /src/schemas/index.ts | valibot@v0.28.1 | Deno

Skip to main content

Deno 2 is finally here 🎉️

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

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

fabian-hiller/valibot

Extremely Popular

Menu

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)

ArraySchemaAsync

BigintSchemaAsync

BlobSchemaAsync

BooleanSchemaAsync

DateSchemaAsync

EnumSchemaAsync

InstanceSchemaAsync

IntersectOptions

IntersectSchema

LiteralSchemaAsync

NeverSchemaAsync

NonNullableInput

NonNullableOutput

NonNullableSchema

NonNullableSchemaAsync

NonNullishInput

NonNullishOutput

NonNullishSchema

NonNullishSchemaAsync

NonOptionalInput

NonOptionalOutput

NonOptionalSchema

NonOptionalSchemaAsync

NullableSchemaAsync

NullishSchemaAsync

NullSchemaAsync

NumberSchemaAsync

ObjectEntriesAsync

ObjectSchemaAsync

OptionalSchemaAsync

PicklistOptions

PicklistSchemaAsync

RecordSchemaAsync

RecursiveSchema

RecursiveSchemaAsync

SpecialSchemaAsync

StringSchemaAsync

SymbolSchemaAsync

TupleItemsAsync

TupleSchemaAsync

UndefinedSchema

UndefinedSchemaAsync

UnionOptionsAsync

UnionSchemaAsync

UnknownSchemaAsync

VariantOptionAsync

VariantOptionsAsync

VariantSchemaAsync

VoidSchemaAsync

discriminatedUnion

discriminatedUnionAsync

nativeEnumAsync

undefinedTypeAsync

nonNullableAsync

nonNullishAsync

nonOptionalAsync

function array

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

array<TItem extends BaseSchema>(item: TItem, pipe?: Pipe<Output<TItem>[]>): ArraySchema<TItem>

Creates a array schema.

array<TItem extends BaseSchema>(

item: TItem,

message?: ErrorMessage,

pipe?: Pipe<Output<TItem>[]>,

): ArraySchema<TItem>

Creates a array schema.

Creates a array schema.

Type Parameters

TItem extends BaseSchema

Parameters

item: TItem

The item schema.

optional

pipe: Pipe<Output<TItem>[]>

A validation and transformation pipe.

Returns

ArraySchema<TItem>

A array schema.

Creates a array schema.

Type Parameters

TItem extends BaseSchema

Parameters

item: TItem

The item schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<Output<TItem>[]>

A validation and transformation pipe.

Returns

ArraySchema<TItem>

A array schema.