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

function optional

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

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

Creates a optional schema.

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

Creates a optional schema.

Type Parameters

TWrapped extends BaseSchema

wrapped: TWrapped

The wrapped schema.

A optional schema.

Creates a optional schema.

TWrapped extends BaseSchema

TDefault extends Input<TWrapped> | (() => Input<TWrapped> | undefined) | undefined

wrapped: TWrapped

The wrapped schema.

default_: TDefault

The default value.

A optional schema.