OptionalSchema | /src/schemas/index.ts | valibot@v1.0.0-beta.4

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

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

Very Popular

any array bigint blob boolean custom date enum file function instance intersect lazy literal looseObject looseTuple map nan never nonNullable nonNullish nonOptional null nullable nullish number object objectWithRest optional picklist promise record set strictObject strictTuple string symbol tuple tupleWithRest undefined undefinedable union unknown variant void

index.ts (default module)

LooseObjectSchemaAsync

LooseTupleIssue

LooseTupleSchema

LooseTupleSchemaAsync

NonNullableSchemaAsync

NonNullishIssue

NonNullishSchema

NonNullishSchemaAsync

NonOptionalIssue

NonOptionalSchema

NonOptionalSchemaAsync

ObjectWithRestSchemaAsync

StrictObjectSchemaAsync

StrictTupleIssue

StrictTupleSchema

StrictTupleSchemaAsync

TupleWithRestSchemaAsync

UndefinedableSchema

UndefinedableSchemaAsync

VariantOptionSchemaAsync

InferNonNullableInput

InferNonNullableIssue

InferNonNullableOutput

InferNonNullishInput

InferNonNullishIssue

InferNonNullishOutput

InferNonOptionalInput

InferNonOptionalIssue

InferNonOptionalOutput

InferUndefinedableOutput

InferVariantIssue

IntersectOptions

IntersectOptionsAsync

any

map

nan

set

interface OptionalSchema

implements BaseSchema<InferInput<TWrapped> | undefined, InferOptionalOutput<TWrapped, TDefault>, InferIssue<TWrapped>>

import { type OptionalSchema } from "https://deno.land/x/valibot@v1.0.0-beta.4/src/schemas/index.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.