Class Schema

Minimal schema builder for typed validation and JSON-Schema emission.

Index

Constructors

Methods

array boolean enum enumNameToSnakeCase enumOf number object optional string

Constructors

constructor

new Schema(): Schema

Returns Schema

Methods

`Static`array

array<T>(inner: SchemaNode<T>, description?: string): SchemaNode<T[]>
Creates an array schema node.
Type Parameters
- T
Parameters
- inner: SchemaNode<T>
- Optionaldescription: string
Returns SchemaNode<T[]>

`Static`boolean

boolean(description?: string): SchemaNode<boolean>
Creates a boolean schema node.
Parameters
- Optionaldescription: string
Returns SchemaNode<boolean>

`Static`enum

enum<T extends Enum>(
enumType: EnumClassOf<T>,
descriptionOrOptions?: string | SchemaEnumOptions<T>,
): SchemaNode<EnumValueTyped<T, number>>
Creates a schema node bound to an engine Enum class.
Type Parameters
- T extends Enum
Parameters
- enumType: EnumClassOf<T>
- OptionaldescriptionOrOptions: string | SchemaEnumOptions<T>
Returns SchemaNode<EnumValueTyped<T, number>>

`Static`enumNameToSnakeCase

enumNameToSnakeCase(name: string): string
Converts one PascalCase or camelCase Enum name to snake_case.
Parameters
- name: string
Returns string

`Static`enumOf

enumOf<V extends string>(
values: readonly V[],
description?: string,
): SchemaNode<V>
Creates a string enum schema node.
Type Parameters
- V extends string
Parameters
- values: readonly V[]
- Optionaldescription: string
Returns SchemaNode<V>

`Static`number

number(description?: string): SchemaNode<number>
Creates a finite number schema node.
Parameters
- Optionaldescription: string
Returns SchemaNode<number>
number(options?: SchemaNumberOptions): SchemaNode<number>
Creates a finite number schema node with range options.
Parameters
- Optionaloptions: SchemaNumberOptions
Returns SchemaNode<number>

`Static`object

object<P extends SchemaObjectProperties>(
properties: P,
description?: string,
): SchemaNode<SchemaObjectValue<P>>
Creates an object schema node.
Type Parameters
- P extends SchemaObjectProperties
Parameters
- properties: P
- Optionaldescription: string
Returns SchemaNode<SchemaObjectValue<P>>

`Static`optional

optional<T>(inner: SchemaNode<T>): SchemaNode<T>
Creates an optional schema node for object properties.
Type Parameters
- T
Parameters
- inner: SchemaNode<T>
Returns SchemaNode<T>

`Static`string

string(description?: string): SchemaNode<string>
Creates a string schema node.
Parameters
- Optionaldescription: string
Returns SchemaNode<string>