LazySchema <T>

Type parameters

• T = boolean

Hierarchy

• Schema<T>
  • LazySchema

Index

Methods

• never
• notNullable
• notUndefinable
• nullable
• schema
• state
• type
• undefinable
• validate

Methods

never

• never(options?: Options): LazySchema<never>

• Mark that this field should never be used.

notNullable

• notNullable(options?: Options): LazySchema<NotNull<T>>

• Disallow null values.

notUndefinable

• notUndefinable(): LazySchema<NotUndefined<T>>

• Disallow undefined values. Will fallback to the default value.

nullable

• nullable(): LazySchema<null | T>

• Allow and return null values.

schema

• schema(): string

• Inherited from Schema.schema

  The type of schema.

state

• state(): SchemaState<Output>

• Inherited from Schema.state

  The internal state object. Contains useful metadata.

type

• type(): string

• Inherited from Schema.type

  The type of schema and it’s children (when applicable).

undefinable

• undefinable(): LazySchema<undefined | T>

• Allow and return undefined values. Will NOT fallback to the default value.

validate

• validate(value: unknown, path?: string, options?: SchemaValidateOptions<UnknownObject, UnknownObject>): Output

• Inherited from Schema.validate

  Run all validation checks that have been enqueued and return a type casted value. If a value is undefined, inherit the default value, otherwise throw if required. If nullable and the value is null, return early.