optional | /src/schemas/index.ts | valibot@v0.30.0

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

Extremely Popular

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)

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

IntersectOptionsAsync

any

map

nan

set

function optional

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

optional<TWrapped extends BaseSchema>(wrapped: TWrapped): OptionalSchema<TWrapped>

Creates a optional schema.

optional<TWrapped extends BaseSchema, TDefault extends Default<TWrapped>>(wrapped: TWrapped, default_: TDefault): OptionalSchema<TWrapped, TDefault>

Creates a optional schema.

Type Parameters

TWrapped extends BaseSchema

Parameters

wrapped: TWrapped

The wrapped schema.

Returns

OptionalSchema<TWrapped>

A optional schema.

Creates a optional schema.

Type Parameters

TWrapped extends BaseSchema

TDefault extends Default<TWrapped>

Parameters

wrapped: TWrapped

The wrapped schema.

default_: TDefault

The default value.

Returns

OptionalSchema<TWrapped, TDefault>

A optional schema.