schemas

Index

Functions

• array
• blueprint
• bool
• custom
• date
• func
• id
• instance
• lazy
• number
• object
• record
• regex
• schema
• shape
• string
• tuple
• union
• uuid

Functions

array

• array<T>(defaultValue?: DefaultValue<T[]>): ArraySchema<T[]>

• Create a schema that validates a value is an array, and optionally validate its items.

  ---

  Type parameters

  • T = unknown

blueprint

• blueprint(): ObjectSchema<Record<string, Required<AnySchema>>>

• Create a schema that validates a value is an indexed object of schemas.

bool

• bool(defaultValue?: DefaultValue<boolean>): BooleanSchema

• Create a schema that validates a value is a boolean.

custom

• custom<T>(validator: CriteriaValidator<T>, defaultValue: DefaultValue<T>): CustomSchema<T>

• Create a schema that validates a value based on a defined custom validator callback.

  ---

  Type parameters

  • T

date

• date(defaultValue?: DefaultValue<Date>): DateSchema<Date>

• Create a schema that validates a value is a date. Supports Date objects, an ISO-8601 string, or a UNIX timestamp

func

• func<T>(defaultValue?: DefaultValueInitializer<T>): FunctionSchema<T>

• Create a schema that validates a value is a function.

  ---

  Type parameters

  • T: AnyFunction = AnyFunction

id

• id(): NumberSchema<number>

• Create a schema that validates a value is an auto-incrementing ID.

instance

• instance<T>(): InstanceSchema<null | T>

• Create a schema that validates a value is an instance of a class.

  ---

  Type parameters

  • T = Object

lazy

• lazy<T>(factory: (value: unknown) => Schema<T>, defaultValue: DefaultValue<undefined | null | T>): LazySchema<T>

• Create a schema that defers evaluation of the schema until it’s needed. This is useful for recursive schemas.

  ---

  Type parameters

  • T

number

• number<T>(defaultValue?: DefaultValue<number>): NumberSchema<T>

• Create a schema that validates a value is a number.

  ---

  Type parameters

  • T: number

object

• object<V, K>(defaultValue?: DefaultValue<Record<K, V>>): ObjectSchema<Record<K, V>>

• Create a schema that validates a value is an indexed object (implicit keys).

  ---

  Type parameters

  • V = unknown
  • K: PropertyKey = string

constrecord

• record<V, K>(defaultValue?: DefaultValue<Record<K, V>>): ObjectSchema<Record<K, V>>

• Create a schema that validates a value is an indexed object (implicit keys).

  ---

  Type parameters

  • V = unknown
  • K: PropertyKey = string

regex

• regex(): InstanceSchema<null | RegExp>

• Create a schema that validates a value is a regex pattern (instance of RegExp).

schema

• schema<T>(): ShapeSchema<T>

• Create a schema that validates a value is a schema instance.

  ---

  Type parameters

  • T: Schema<any, T>

shape

• shape<T>(blueprint: Blueprint<T>): ShapeSchema<T>

• Create a schema that validates a value is a shaped object (explicit keys).

  ---

  Type parameters

  • T: object

string

• string<T>(defaultValue?: DefaultValue<string>): StringSchema<T>

• Create a schema that validates a value is a string.

  ---

  Type parameters

  • T: string = string

tuple

• tuple<T>(schemas: InferTupleItems<T>): TupleSchema<T>

• Create a schema that validates a value is a tuple; an explicit list of types.

  ---

  Type parameters

  • T: unknown[] = unknown[]

union

• union<T>(defaultValue: DefaultValue<T>): UnionSchema<T>

• Create a schema that validates a value against a list of possible values.

  ---

  Type parameters

  • T = unknown

uuid

• uuid(version?: 1 | 2 | 3 | 4 | 5): StringSchema<string>

• Create a schema that validates a value is a UUID (universally unique identifier).