Class Schema`Abstract`

Abstract base class for defining type-safe schemas.

Extend this class and define fields using the static type methods. Use static functions to create, parse, validate, and serialize instances.

Example

class Product extends Schema {
  name = Schema.String({ minLength: 1 });
  price = Schema.Number({ minimum: 0 });
  inStock = Schema.Boolean({ default: true });
}

Index

Constructors

constructor

new Schema(): Schema
Returns Schema

Properties

`Static`String

String: (options?: StringFieldOptions) => FieldDescriptor<string> = descriptors.String

Create a string field.

Type Declaration

- (options?: StringFieldOptions): FieldDescriptor<string>
- Create a string field descriptor.
  Parameters
  - options: StringFieldOptions = {}
    String field configuration
  Returns FieldDescriptor<string>
  Field descriptor for string values
  Example
```
class User extends Schema {
  name = String({ description: "User's name", minLength: 1 });
  email = String({ format: "email", optional: true });
}
```

See

StringFieldOptions for available options

`Static`Number

Number: (options?: NumberFieldOptions) => FieldDescriptor<number> = descriptors.Number

Create a number field (floating point).

Type Declaration

- (options?: NumberFieldOptions): FieldDescriptor<number>
- Create a number field descriptor.
  Parameters
  - options: NumberFieldOptions = {}
    Number field configuration
  Returns FieldDescriptor<number>
  Field descriptor for number values
  Example
```
class Product extends Schema {
  price = Number({ minimum: 0, description: "Price in cents" });
  rating = Number({ minimum: 0, maximum: 5, optional: true });
}
```

See

NumberFieldOptions for available options

`Static`Integer

Integer: (options?: IntegerFieldOptions) => FieldDescriptor<number> = descriptors.Integer

Create an integer field (whole numbers only).

Type Declaration

- (options?: IntegerFieldOptions): FieldDescriptor<number>
- Create an integer field descriptor. Integers are whole numbers (no decimal places).
  Parameters
  - options: IntegerFieldOptions = {}
    Integer field configuration
  Returns FieldDescriptor<number>
  Field descriptor for integer values
  Example
```
class User extends Schema {
  age = Integer({ minimum: 0, maximum: 150 });
  level = Integer({ minimum: 1, default: 1 });
}
```

See

IntegerFieldOptions for available options

`Static`Boolean

Boolean: (options?: BooleanFieldOptions) => FieldDescriptor<boolean> = descriptors.Boolean

Create a boolean field.

Type Declaration

- (options?: BooleanFieldOptions): FieldDescriptor<boolean>
- Create a boolean field descriptor.
  Parameters
  - options: BooleanFieldOptions = {}
    Boolean field configuration
  Returns FieldDescriptor<boolean>
  Field descriptor for boolean values
  Example
```
class Task extends Schema {
  completed = Boolean({ default: false });
  urgent = Boolean({ optional: true });
}
```

See

BooleanFieldOptions for available options

`Static`Null

Null: (options?: BaseFieldOptions) => FieldDescriptor<null> = descriptors.Null

Create a null field.

Type Declaration

- (options?: BaseFieldOptions): FieldDescriptor<null>
- Create a null field descriptor. Represents a field that can only be null.
  Parameters
  - options: BaseFieldOptions = {}
    Field configuration
  Returns FieldDescriptor<null>
  Field descriptor for null values
  Example
```
class DeleteRequest extends Schema {
  deletedAt = Null({ description: "Deletion marker" });
}
```

`Static`Array

Array: <T>(
items: FieldDescriptor<T>,
options?: ArrayFieldOptions,
) => FieldDescriptor<T[]> = descriptors.Array

Create an array field with typed items.

Type Declaration

- <T>(
  items: FieldDescriptor<T>,
  options?: ArrayFieldOptions,
  ): FieldDescriptor<T[]>
- Create an array field descriptor.
  Type Parameters
  - T
  Parameters
  - items: FieldDescriptor<T>
    Field descriptor for array items
  - options: ArrayFieldOptions = {}
    Array field configuration
  Returns FieldDescriptor<T[]>
  Field descriptor for array values
  Example
```
class Post extends Schema {
  tags = Array(String(), { minItems: 1, maxItems: 10 });
  scores = Array(Number(), { uniqueItems: true });
  authors = Array(Object(Author), { minItems: 1 });
}
```

See

ArrayFieldOptions for available options

`Static`Object

Object: <S extends SchemaConstructor<SchemaInstance>>(
schema: S,
options?: ObjectFieldOptions,
) => FieldDescriptor<InferSchemaType<S>> = descriptors.Object

Create a nested object field from another Schema class.

Type Declaration

- <S extends SchemaConstructor<SchemaInstance>>(
  schema: S,
  options?: ObjectFieldOptions,
  ): FieldDescriptor<InferSchemaType<S>>
- Create an object field descriptor for nested schemas.
  Type Parameters
  - S extends SchemaConstructor<SchemaInstance>
  Parameters
  - schema: S
    The nested Schema class constructor
  - options: ObjectFieldOptions = {}
    Object field configuration
  Returns FieldDescriptor<InferSchemaType<S>>
  Field descriptor for nested object values
  Example
```
class Address extends Schema {
  street = String();
  city = String();
}

class User extends Schema {
  name = String();
  address = Object(Address, { description: "Home address" });
}
```

See

ObjectFieldOptions for available options

`Static`Enum

Enum: <const T extends readonly unknown[]>(
values: T,
options?: EnumFieldOptions,
) => FieldDescriptor<T[number]> = descriptors.Enum

Create an enum field with specific allowed values. Use as const for literal type inference.

Type Declaration

- <const T extends readonly unknown[]>(
  values: T,
  options?: EnumFieldOptions,
  ): FieldDescriptor<T[number]>
- Create an enum field descriptor. The value must be one of the specified allowed values.
  Type Parameters
  - const T extends readonly unknown[]
  Parameters
  - values: T
    Array of allowed values (use as const for literal types)
  - options: EnumFieldOptions = {}
    Enum field configuration
  Returns FieldDescriptor<T[number]>
  Field descriptor for enum values
  Example
```
class User extends Schema {
  role = Enum(["admin", "user", "guest"] as const);
  priority = Enum([1, 2, 3] as const, { default: 2 });
  status = Enum(["active", "inactive"] as const, { description: "Account status" });
}

const user = User.create();
user.role; // Type: "admin" | "user" | "guest"
```

See

EnumFieldOptions for available options

`Static`Literal

Literal: <const T>(
value: T,
options?: LiteralFieldOptions,
) => FieldDescriptor<T> = descriptors.Literal

Create a literal (const) field with an exact value.

Type Declaration

- <const T>(value: T, options?: LiteralFieldOptions): FieldDescriptor<T>
- Create a literal field descriptor. The value must be exactly the specified constant.
  Type Parameters
  - const T
  Parameters
  - value: T
    The exact value this field must have
  - options: LiteralFieldOptions = {}
    Literal field configuration
  Returns FieldDescriptor<T>
  Field descriptor for literal values
  Example
```
class APIResponse extends Schema {
  version = Literal("1.0");
  success = Literal(true);
}

const response = APIResponse.create();
response.version; // Type: "1.0" (literal)
response.success; // Type: true (literal)
```

See

LiteralFieldOptions for available options

Methods

`Static`create

create<T extends SchemaInstance>(SchemaClass: SchemaConstructor<T>): Proxied<T>
Create a new proxied schema instance.
Type Parameters
- T extends SchemaInstance
Parameters
- SchemaClass: SchemaConstructor<T>
  The Schema class to instantiate
Returns Proxied<T>
A proxied instance with clean property access
- Defined in schema/index.ts:163

`Static`parse

parse<T extends SchemaInstance>(instance: T | Proxied<T>, data: unknown): void
Validate and populate a schema instance with data. Throws SchemaError if validation fails.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
- data: unknown
  The data to parse
Returns void
- Defined in schema/index.ts:174

`Static`validate

validate<T extends SchemaInstance>(
instance: T | Proxied<T>,
data: unknown,
): boolean
Validate data against a schema without modifying the instance.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
- data: unknown
  The data to validate
Returns boolean
true if valid, false otherwise
- Defined in schema/index.ts:185

`Static`toJSON

toJSON<T extends SchemaInstance>(instance: T | Proxied<T>): JSONSchemaDocument
Generate a JSON Schema document from a schema instance.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
Returns JSONSchemaDocument
JSON Schema object conforming to draft 2020-12
- Defined in schema/index.ts:195

`Static`stringify

stringify<T extends SchemaInstance>(
instance: T | Proxied<T>,
pretty?: boolean,
): string
Generate a JSON Schema string from a schema instance.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
- pretty: boolean = true
  Whether to pretty-print (default: true)
Returns string
JSON Schema as a string
- Defined in schema/index.ts:206

`Static`toObject

toObject<T extends SchemaInstance>(instance: T | Proxied<T>): InferSchema<T>
Extract a plain JavaScript object from a schema instance.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
Returns InferSchema<T>
Plain object with field values
- Defined in schema/index.ts:216

`Static`clone

clone<T extends SchemaInstance>(instance: T | Proxied<T>): Proxied<T>
Create a deep clone of a schema instance.
Type Parameters
- T extends SchemaInstance
Parameters
- instance: T | Proxied<T>
  The schema instance (proxied or raw)
Returns Proxied<T>
A new proxied instance with cloned values
- Defined in schema/index.ts:226

Class SchemaAbstract

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Schema

Properties

StaticString

Type Declaration

Parameters

Returns FieldDescriptor<string>

Example

See

StaticNumber

Type Declaration

Parameters

Returns FieldDescriptor<number>

Example

See

StaticInteger

Type Declaration

Parameters

Returns FieldDescriptor<number>

Example

See

StaticBoolean

Type Declaration

Parameters

Returns FieldDescriptor<boolean>

Example

See

StaticNull

Type Declaration

Parameters

Returns FieldDescriptor<null>

Example

StaticArray

Type Declaration

Type Parameters

Parameters

Returns FieldDescriptor<T[]>

Example

See

StaticObject

Type Declaration

Type Parameters

Parameters

Returns FieldDescriptor<InferSchemaType<S>>

Example

See

StaticEnum

Type Declaration

Type Parameters

Parameters

Returns FieldDescriptor<T[number]>

Example

See

StaticLiteral

Type Declaration

Type Parameters

Parameters

Returns FieldDescriptor<T>

Example

See

Methods

Staticcreate

Type Parameters

Parameters

Returns Proxied<T>

Staticparse

Type Parameters

Parameters

Returns void

Staticvalidate

Type Parameters

Parameters

Returns boolean

Class Schema`Abstract`

`Static`String

`Static`Number

`Static`Integer

`Static`Boolean

`Static`Null

`Static`Array

`Static`Object

`Static`Enum

`Static`Literal

`Static`create

`Static`parse

`Static`validate

`Static`toJSON

`Static`stringify

`Static`toObject

`Static`clone