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

x/valibot/src/schemas/optional/optional.ts>OptionalSchema

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Latest
interface OptionalSchema
import { type OptionalSchema } from "https://deno.land/x/valibot@v1.0.0-beta.2-to-json-schema/src/schemas/optional/optional.ts";

Optional schema type.

Type Parameters

TWrapped extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
TDefault extends Default<TWrapped, undefined>

Properties

readonly
type: "optional"

The schema type.

readonly
reference: optional

The schema reference.

readonly
expects: `(${TWrapped["expects"]} | undefined)`

The expected property.

readonly
wrapped: TWrapped

The wrapped schema.

readonly
default: TDefault

The default value.