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

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 record

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

record<TValue extends BaseSchema>(value: TValue, pipe?: Pipe<RecordOutput<StringSchema, TValue>>): RecordSchema<StringSchema, TValue>

Creates a record schema.

record<TValue extends BaseSchema>(

value: TValue,

message?: ErrorMessage,

pipe?: Pipe<RecordOutput<StringSchema, TValue>>,

): RecordSchema<StringSchema, TValue>

Creates a record schema.

record<TKey extends RecordKey, TValue extends BaseSchema>(

key: TKey,

value: TValue,

pipe?: Pipe<RecordOutput<TKey, TValue>>,

): RecordSchema<TKey, TValue>

Creates a record schema.

record<TKey extends RecordKey, TValue extends BaseSchema>(

key: TKey,

value: TValue,

message?: ErrorMessage,

pipe?: Pipe<RecordOutput<TKey, TValue>>,

): RecordSchema<TKey, TValue>

Creates a record schema.

Type Parameters

TValue extends BaseSchema

Parameters

value: TValue

The value schema.

optional

pipe: Pipe<RecordOutput<StringSchema, TValue>>

A validation and transformation pipe.

Returns

RecordSchema<StringSchema, TValue>

A record schema.

Creates a record schema.

Type Parameters

TValue extends BaseSchema

Parameters

value: TValue

The value schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<RecordOutput<StringSchema, TValue>>

A validation and transformation pipe.

Returns

RecordSchema<StringSchema, TValue>

A record schema.

Creates a record schema.

Type Parameters

TKey extends RecordKey

TValue extends BaseSchema

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional

pipe: Pipe<RecordOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

RecordSchema<TKey, TValue>

A record schema.

Creates a record schema.

Type Parameters

TKey extends RecordKey

TValue extends BaseSchema

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<RecordOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

RecordSchema<TKey, TValue>

A record schema.