JsonEntityStore

@tsed/schema

Usage

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

See /packages/specs/schema/src/types/domain/JsonEntityStore.ts.

Overview

abstract class JsonEntityStore implements JsonEntityStoreOptions {
    readonly propertyKey: string | symbol;
    readonly propertyName: string;
    readonly index: number;
    readonly descriptor: PropertyDescriptor;
    readonly decoratorType: DecoratorTypes;
    collectionType: Type<any>;
    token: Type<any>;
    readonly store: Store;
    readonly isStore = true;
    readonly parent: JsonEntityStore;
    readonly target: Type<any>;
    protected _type: Type<any>;
    protected _schema: JsonSchema;
    [key: string]: any;
    constructor(options: JsonEntityStoreOptions);
    get targetName(): string;
    get isCollection(): boolean;
    get isArray(): boolean;
    get discriminatorAncestor(): JsonEntityStore | undefined;
    get isPrimitive(): boolean;
    get isDate(): boolean;
    get isObject(): boolean;
    get isClass(): boolean;
    get schema(): JsonSchema;
    get nestedGenerics(): Type<any>[][];
    set nestedGenerics(nestedGenerics: Type<any>[][]);
    get type(): Type<any> | any;
    set type(value: Type<any> | any);
    get computedType(): any;
    get itemSchema(): JsonSchema;
    get parentSchema(): JsonSchema;
    get isDiscriminatorChild(): boolean;
    static from<T extends JsonClassStore = JsonClassStore>(target: Type<any>): T;
    static from<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, propertyKey: string | symbol): T;
    static from<T extends JsonParameterStore = JsonParameterStore>(target: Type<any> | any, propertyKey: string | symbol, index: number): T;
    static from<T extends JsonMethodStore = JsonMethodStore>(target: Type<any> | any, propertyKey: string | symbol, descriptor: PropertyDescriptor): T;
    static from<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): T;
    static fromMethod<T extends JsonMethodStore = JsonMethodStore>(target: any, propertyKey: string | symbol): T;
    static get(target: Type<any>, propertyKey: string | symbol, descriptor?: any): JsonEntityStore;
    isGetterOnly(): boolean | undefined;
    get<T = any>(key: string, defaultValue?: any): T;
    set(key: string, value?: any): Store;
    toString(): string;
    protected abstract build(): void;
    protected buildType(type: any): void;
    getBestType(): any;
}

readonly propertyKey

readonly propertyKey: string | symbol;

Original property key decorated by the decorator

readonly propertyName

readonly propertyName: string;

Alias of the property

readonly index

readonly index: number;

Parameter index

readonly descriptor

readonly descriptor: PropertyDescriptor;

Method's descriptor

readonly decoratorType

readonly decoratorType: DecoratorTypes;

Decorator type used to the JsonSchemaStore.

collectionType

collectionType: Type<any>;

Type of the collection (Array, Map, Set, etc...)

token

token: Type<any>;

readonly store

readonly store: Store;

readonly isStore

readonly isStore = true;

readonly parent

readonly parent: JsonEntityStore;

readonly target

readonly target: Type<any>;

protected _type

protected _type: Type<any>;

protected _schema

protected _schema: JsonSchema;

Ref to JsonSchema

[key: string]

[key: string]: any;

get targetName

get targetName(): string;

Return the class name of the entity.

get isCollection

get isCollection(): boolean;

get isArray

get isArray(): boolean;

get discriminatorAncestor

get discriminatorAncestor(): JsonEntityStore | undefined;

get isPrimitive

get isPrimitive(): boolean;

get isDate

get isDate(): boolean;

get isObject

get isObject(): boolean;

get isClass

get isClass(): boolean;

get schema

get schema(): JsonSchema;

Return the JsonSchema

get nestedGenerics

get nestedGenerics(): Type<any>[][];

set nestedGenerics

set nestedGenerics(nestedGenerics: Type<any>[][]);

get type

get type(): Type<any> | any;

set type

set type(value: Type<any> | any);

Get original type without transformation

get computedType

get computedType(): any;

Return the itemSchema computed type. if the type is a function used for recursive model, the function will be called to get the right type.

get itemSchema

get itemSchema(): JsonSchema;

get parentSchema

get parentSchema(): JsonSchema;

get isDiscriminatorChild

get isDiscriminatorChild(): boolean;

static from

static from<T extends JsonClassStore = JsonClassStore>(target: Type<any>): T;

static from

static from<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, propertyKey: string | symbol): T;

static from

static from<T extends JsonParameterStore = JsonParameterStore>(target: Type<any> | any, propertyKey: string | symbol, index: number): T;

static from

static from<T extends JsonMethodStore = JsonMethodStore>(target: Type<any> | any, propertyKey: string | symbol, descriptor: PropertyDescriptor): T;

static from

static from<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): T;

static fromMethod

static fromMethod<T extends JsonMethodStore = JsonMethodStore>(target: any, propertyKey: string | symbol): T;

static get

static get(target: Type<any>, propertyKey: string | symbol, descriptor?: any): JsonEntityStore;

isGetterOnly

isGetterOnly(): boolean | undefined;

get

get<T = any>(key: string, defaultValue?: any): T;

set

set(key: string, value?: any): Store;

toString

toString(): string;

protected abstract build

protected abstract build(): void;

protected buildType

protected buildType(type: any): void;

getBestType

getBestType(): any;