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

x/valibot/src/schemas/optional/index.ts>OptionalSchemaAsync

The modular and type safe schema library for validating structural data 🤖
fabian-hiller/valibot
Popular
Latest
interface OptionalSchemaAsync
implements BaseSchemaAsync<InferInput<TWrapped> | undefined, InferOptionalOutput<TWrapped, TDefault>, InferIssue<TWrapped>>
import { type OptionalSchemaAsync } from "https://deno.land/x/valibot@v1.0.0-beta.7/src/schemas/optional/index.ts";

Optional schema async type.

Type Parameters

TWrapped extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
TDefault extends DefaultAsync<TWrapped, undefined>

Properties

readonly
type: "optional"

The schema type.

readonly
reference: optionalAsync

The schema reference.

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

The expected property.

readonly
wrapped: TWrapped

The wrapped schema.

readonly
default: TDefault

The default value.