record | /src/index.ts | valibot@v0.19.0

Module

x/valibot/src/index.ts>record

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)

IntersectionOptionsAsync

IntersectionSchema

IntersectionSchemaAsync

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function record

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

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

Creates a record schema.

record<TRecordValue extends BaseSchema>(

value: TRecordValue,

error?: ErrorMessage,

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

): RecordSchema<StringSchema, TRecordValue>

Creates a record schema.

record<TRecordKey extends RecordKey, TRecordValue extends BaseSchema>(

key: TRecordKey,

value: TRecordValue,

pipe?: Pipe<RecordOutput<TRecordKey, TRecordValue>>,

): RecordSchema<TRecordKey, TRecordValue>

Creates a record schema.

record<TRecordKey extends RecordKey, TRecordValue extends BaseSchema>(

key: TRecordKey,

value: TRecordValue,

error?: ErrorMessage,

pipe?: Pipe<RecordOutput<TRecordKey, TRecordValue>>,

): RecordSchema<TRecordKey, TRecordValue>

Creates a record schema.

Type Parameters

TRecordValue extends BaseSchema

Parameters

value: TRecordValue

The value schema.

optional

pipe: Pipe<RecordOutput<StringSchema, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchema<StringSchema, TRecordValue>

A record schema.

Creates a record schema.

Type Parameters

TRecordValue extends BaseSchema

Parameters

value: TRecordValue

The value schema.

optional

error: ErrorMessage

The error message.

optional

pipe: Pipe<RecordOutput<StringSchema, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchema<StringSchema, TRecordValue>

A record schema.

Creates a record schema.

Type Parameters

TRecordKey extends RecordKey

TRecordValue extends BaseSchema

Parameters

key: TRecordKey

The key schema.

value: TRecordValue

The value schema.

optional

pipe: Pipe<RecordOutput<TRecordKey, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchema<TRecordKey, TRecordValue>

A record schema.

Creates a record schema.

Type Parameters

TRecordKey extends RecordKey

TRecordValue extends BaseSchema

Parameters

key: TRecordKey

The key schema.

value: TRecordValue

The value schema.

optional

error: ErrorMessage

The error message.

optional

pipe: Pipe<RecordOutput<TRecordKey, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchema<TRecordKey, TRecordValue>

A record schema.