object | /src/schemas/index.ts | valibot@v0.5.0

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

Extremely Popular

any array bigint blob boolean date enumType instance literal map nan nativeEnum never nonNullable nonNullish nonOptional nullType nullable nullish number object optional record recursive set special string symbol tuple undefinedType union unknown voidType

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

function object

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

object<TObjectShape extends ObjectShape>(object: TObjectShape, pipe?: Pipe<ObjectOutput<TObjectShape>>): ObjectSchema<TObjectShape>

Creates an object schema.

object<TObjectShape extends ObjectShape>(

object: TObjectShape,

error?: string,

pipe?: Pipe<ObjectOutput<TObjectShape>>,

): ObjectSchema<TObjectShape>

Creates an object schema.

Type Parameters

TObjectShape extends ObjectShape

Parameters

object: TObjectShape

The object schema.

optional

pipe: Pipe<ObjectOutput<TObjectShape>>

A validation and transformation pipe.

Returns

ObjectSchema<TObjectShape>

An object schema.

Creates an object schema.

Type Parameters

TObjectShape extends ObjectShape

Parameters

object: TObjectShape

The object schema.

optional

error: string

The error message.

optional

pipe: Pipe<ObjectOutput<TObjectShape>>

A validation and transformation pipe.

Returns

ObjectSchema<TObjectShape>

An object schema.