object | /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 object

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

object<TEntries extends ObjectEntries>(entries: TEntries, pipe?: Pipe<ObjectOutput<TEntries, undefined>>): ObjectSchema<TEntries>

Creates an object schema.

object<TEntries extends ObjectEntries>(

entries: TEntries,

message?: ErrorMessage,

pipe?: Pipe<ObjectOutput<TEntries, undefined>>,

): ObjectSchema<TEntries>

Creates an object schema.

object<TEntries extends ObjectEntries, TRest extends BaseSchema | undefined>(

entries: TEntries,

rest: TRest,

pipe?: Pipe<ObjectOutput<TEntries, TRest>>,

): ObjectSchema<TEntries, TRest>

Creates an object schema.

object<TEntries extends ObjectEntries, TRest extends BaseSchema | undefined>(

entries: TEntries,

rest: TRest,

message?: ErrorMessage,

pipe?: Pipe<ObjectOutput<TEntries, TRest>>,

): ObjectSchema<TEntries, TRest>

Creates an object schema.

Type Parameters

TEntries extends ObjectEntries

Parameters

entries: TEntries

The object entries.

optional

pipe: Pipe<ObjectOutput<TEntries, undefined>>

A validation and transformation pipe.

Returns

ObjectSchema<TEntries>

An object schema.

Creates an object schema.

Type Parameters

TEntries extends ObjectEntries

Parameters

entries: TEntries

The object entries.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<ObjectOutput<TEntries, undefined>>

A validation and transformation pipe.

Returns

ObjectSchema<TEntries>

An object schema.

Creates an object schema.

Type Parameters

TEntries extends ObjectEntries

TRest extends BaseSchema | undefined

Parameters

entries: TEntries

The object entries.

rest: TRest

The object rest.

optional

pipe: Pipe<ObjectOutput<TEntries, TRest>>

A validation and transformation pipe.

Returns

ObjectSchema<TEntries, TRest>

An object schema.

Creates an object schema.

Type Parameters

TEntries extends ObjectEntries

TRest extends BaseSchema | undefined

Parameters

entries: TEntries

The object entries.

rest: TRest

The object rest.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<ObjectOutput<TEntries, TRest>>

A validation and transformation pipe.

Returns

ObjectSchema<TEntries, TRest>

An object schema.