JsonClassStore

@tsed/schema

Usage

import { JsonClassStore } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonClassStore.ts.

Overview

class JsonClassStore extends JsonEntityStore {
    readonly children: Map<string | number, JsonMethodStore | JsonPropertyStore>;
    get path(): string;
    set path(path: string);
    protected build(): void;
}

Description

Store for class-level metadata and schema information.

JsonClassStore manages metadata for classes decorated with schema decorators like @Model(), @Generics(), @DiscriminatorKey(), etc. It serves as the root container for all class-level schema information and coordinates child stores for properties and methods.

Responsibilities

• Schema Generation: Creates and maintains the JsonSchema for the class
• Children Coordination: Manages child PropertyStore and MethodStore instances
• Route Configuration: Stores base path for controller classes
• Inheritance: Handles schema inheritance from parent classes
• OpenAPI Integration: Generates component schemas for OpenAPI specifications

Usage

// Get class store
const classStore = JsonEntityStore.from(MyClass);

// Access class schema
const schema = classStore.schema;

// Get all properties
const properties = classStore.children;

// Check if it's a controller with a path
const path = classStore.path;

Class Store Hierarchy

The class store acts as the root of the store hierarchy:

JsonClassStore (User class)
├─ JsonPropertyStore (name property)
├─ JsonPropertyStore (email property)
└─ JsonMethodStore (validate method)
   ├─ JsonParameterStore (param 0)
   └─ JsonParameterStore (param 1)

Schema Structure

For a class like:

class User {
  @Property()
  name: string;

  @Property()
  email: string;
}

The class store generates:

{
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "email": {"type": "string"}
  }
}

Controller Path

For controller classes decorated with @Controller("/users"), the store maintains the base path which is used for route generation.

readonly children

readonly children: Map<string | number, JsonMethodStore | JsonPropertyStore>;

List of children JsonEntityStore (properties or methods or params)

get path

get path(): string;

set path

set path(path: string);

protected build

protected build(): void;