Schema <Output>

Type parameters

• Output

Hierarchy

• Schema
  • ArraySchema
  • BooleanSchema
  • CustomSchema
  • DateSchema
  • FunctionSchema
  • InstanceSchema
  • LazySchema
  • NumberSchema
  • ObjectSchema
  • ShapeSchema
  • StringSchema
  • TupleSchema
  • UnionSchema

Index

Methods

• schema
• state
• type
• validate

Methods

schema

• schema(): string

• The type of schema.

state

• state(): SchemaState<Output>

• The internal state object. Contains useful metadata.

type

• type(): string

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

validate

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

• 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.