JsonMapperCompiler

@tsed/json-mapper

Usage

import { JsonMapperCompiler } from "@tsed/json-mapper";

See /packages/specs/json-mapper/src/types/domain/JsonMapperCompiler.ts.

Overview

abstract class JsonMapperCompiler<Options extends Record<string, any> = any> {
    protected cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;
    protected mappers: Record<string, JsonMapperCallback<Options>>;
    protected schemes: Record<string, any>;
    protected constructors: Record<string, Type<any>>;
    protected globals: Record<string, any>;
    constructor();
    addTypeMapper(model: Type<any> | string, fn: any): this;
    removeTypeMapper(model: Type<any> | string): void;
    addGlobal(key: string, value: any): this;
    eval(mapper: string, { id, groupsId, model }: {
        id: string;
        model: Type<any> | string;
        groupsId: string;
    }): CachedJsonMapper<Options>;
    createContext(options: Options): Options & {
        cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;
    };
    compile(model: Type<any> | string, groups: false | string[], opts?: {
        mapper?: any;
    }): CachedJsonMapper<Options>;
    protected execMapper(id: string, value: any, options: Options): any;
    protected abstract map(input: any, options: Options): any;
    protected abstract alterValue(schemaId: string, value: any, options: Options): any;
    protected abstract createMapper(model: Type<any>, id: string, groups: false | string[]): string;
    protected getType(model: Type<any>): Type<any> | MapConstructor | ObjectConstructor | ArrayConstructor | SetConstructor;
    protected alterIgnore(id: string, options: Options): any;
    protected alterGroups(schema: JsonSchema, groups: false | string[]): boolean;
    protected getGroupsId(groups: false | string[]): string;
    protected getId(model: Type<any> | string, groupsId: string): string;
    protected getSchemaId(id: string, propertyKey: string): string;
}

Constructor

protected constructors: Record<string, Type<any>>;

Cached classes by his id

protected cache

protected cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;

Cached mappers metadata

protected mappers

protected mappers: Record<string, JsonMapperCallback<Options>>;

Cached executable mappers by his id

protected schemes

protected schemes: Record<string, any>;

Cached schemas

protected globals

protected globals: Record<string, any>;

Global variables available in the mapper

addTypeMapper

addTypeMapper(model: Type<any> | string, fn: any): this;

removeTypeMapper

removeTypeMapper(model: Type<any> | string): void;

addGlobal

addGlobal(key: string, value: any): this;

eval

eval(mapper: string, { id, groupsId, model }: {
     id: string;
     model: Type<any> | string;
     groupsId: string;
 }): CachedJsonMapper<Options>;

createContext

createContext(options: Options): Options & {
     cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;
 };

compile

compile(model: Type<any> | string, groups: false | string[], opts?: {
     mapper?: any;
 }): CachedJsonMapper<Options>;

protected execMapper

protected execMapper(id: string, value: any, options: Options): any;

protected abstract map

protected abstract map(input: any, options: Options): any;

protected abstract alterValue

protected abstract alterValue(schemaId: string, value: any, options: Options): any;

protected abstract createMapper

protected abstract createMapper(model: Type<any>, id: string, groups: false | string[]): string;

protected getType

protected getType(model: Type<any>): Type<any> | MapConstructor | ObjectConstructor | ArrayConstructor | SetConstructor;

protected alterIgnore

protected alterIgnore(id: string, options: Options): any;

protected alterGroups

protected alterGroups(schema: JsonSchema, groups: false | string[]): boolean;

protected getGroupsId

protected getGroupsId(groups: false | string[]): string;

protected getId

protected getId(model: Type<any> | string, groupsId: string): string;

protected getSchemaId

protected getSchemaId(id: string, propertyKey: string): string;