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

Module

x/valibot/src/index.ts>object

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function object

Re-export

import { object } from "https://deno.land/x/valibot@v0.5.0/src/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.