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

x/valibot/mod.ts>OptionalSchema

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Go to Latest
interface OptionalSchema
implements BaseSchema<Input<TWrapped> | undefined, TOutput>
Re-export
import { type OptionalSchema } from "https://deno.land/x/valibot@v0.30.0/mod.ts";

Optional schema type.

Type Parameters

TWrapped extends BaseSchema
optional
TDefault extends Default<TWrapped> = undefined
optional
TOutput = TDefault extends Input<TWrapped> | (() => Input<TWrapped>) ? Output<TWrapped> : Output<TWrapped> | undefined

Properties

type: "optional"

The schema type.

wrapped: TWrapped

The wrapped schema.

default: TDefault

Returns the default value.