optional | /src/schemas/optional/optional.ts | valibot@v0.19.0

Deno 2 is finally here 🎉️

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

function optional

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

optional<TWrapped extends BaseSchema, TDefault extends Input<TWrapped> | undefined = undefined>(wrapped: TWrapped, default_?: TDefault | (() => TDefault)): OptionalSchema<TWrapped, TDefault>

Creates a optional schema.

Type Parameters

TWrapped extends BaseSchema

optional

TDefault extends Input<TWrapped> | undefined = undefined

wrapped: TWrapped

The wrapped schema.

optional

default_: TDefault | (() => TDefault)

The default value.

OptionalSchema<TWrapped, TDefault>

A optional schema.