JsonMap

@tsed/schema

Usage

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

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

Overview

class JsonMap<T> extends Map<string, any> {
    [key: string]: any;
    $kind: string;
    readonly $isJsonDocument = true;
    constructor(obj?: Partial<T>);
    assign(obj?: Partial<T> & any): this;
    toJSON(options?: JsonSchemaOptions): any;
}

Description

Base class for JSON document representations using a Map structure.

JsonMap provides a Map-based foundation for storing and manipulating JSON-compatible data structures. It extends the native Map with additional features for assignment, serialization, and mapper integration.

This class serves as the base for many Ts.ED schema classes including JsonOperation, JsonParameter, JsonResponse, and JsonRequestBody.

Usage

class MyJsonDoc extends JsonMap<{name: string; value: number}> {
  // Custom methods
}

const doc = new MyJsonDoc({name: "test", value: 42});
const json = doc.toJSON();

Key Features

• Map Interface: Full Map API support for key-value operations
• Fluent Assignment: Assign multiple properties via object
• Serialization: Convert to plain JSON via mapper system
• Type Safety: Generic type parameter for stored values

[key: string]

[key: string]: any;

$kind

$kind: string;

readonly $isJsonDocument

readonly $isJsonDocument = true;

assign

assign(obj?: Partial<T> & any): this;

toJSON

toJSON(options?: JsonSchemaOptions): any;