Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/mod.ts>optional

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Go to Latest
function optional
Re-export
import { optional } from "https://deno.land/x/valibot@v0.28.1/mod.ts";

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 Input<TWrapped> | (() => Input<TWrapped> | undefined) | undefined

Parameters

wrapped: TWrapped

The wrapped schema.

default_: TDefault

The default value.

Returns

OptionalSchema<TWrapped, TDefault>

A optional schema.