instance | /src/schemas/index.ts | valibot@v0.30.0 | Deno

Skip to main content

Deno 2 is finally here 🎉️

x/valibot/src/schemas/index.ts>instance

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

fabian-hiller/valibot

Extremely Popular

Menu

any array bigint blob boolean date enum instance intersect lazy literal map nan never nonNullable nonNullish nonOptional null nullable nullish number object optional picklist record set special string symbol tuple undefined union unknown variant void

index.ts (default module)

ArraySchemaAsync

BigintSchemaAsync

BlobSchemaAsync

BooleanSchemaAsync

DateSchemaAsync

EnumSchemaAsync

InstanceSchemaAsync

IntersectSchema

IntersectSchemaAsync

LazySchemaAsync

LiteralSchemaAsync

NeverSchemaAsync

NonNullableSchema

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

NullableSchemaAsync

NullishSchemaAsync

NullSchemaAsync

NumberSchemaAsync

ObjectEntriesAsync

ObjectSchemaAsync

OptionalSchemaAsync

PicklistSchemaAsync

RecordSchemaAsync

SpecialSchemaAsync

StringSchemaAsync

SymbolSchemaAsync

TupleSchemaAsync

UndefinedSchema

UndefinedSchemaAsync

UnionSchemaAsync

UnknownSchemaAsync

VariantSchemaAsync

VoidSchemaAsync

IntersectOptions

IntersectOptionsAsync

NonNullableInput

NonNullableOutput

NonNullishInput

NonNullishOutput

NonOptionalInput

NonOptionalOutput

PicklistOptions

TupleItemsAsync

UnionOptionsAsync

VariantOptionAsync

VariantOptionsAsync

nonNullableAsync

nonNullishAsync

nonOptionalAsync

function instance

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

instance<TClass extends Class>(class_: TClass, pipe?: Pipe<InstanceType<TClass>>): InstanceSchema<TClass>

Creates an instance schema.

instance<TClass extends Class>(

class_: TClass,

message?: ErrorMessage,

pipe?: Pipe<InstanceType<TClass>>,

): InstanceSchema<TClass>

Creates an instance schema.

Creates an instance schema.

Type Parameters

TClass extends Class

Parameters

class_: TClass

The class of the instance.

optional

pipe: Pipe<InstanceType<TClass>>

A validation and transformation pipe.

Returns

InstanceSchema<TClass>

An instance schema.

Creates an instance schema.

Type Parameters

TClass extends Class

Parameters

class_: TClass

The class of the instance.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<InstanceType<TClass>>

A validation and transformation pipe.

Returns

InstanceSchema<TClass>

An instance schema.