Store

@tsed/core

Usage

import { Store } from "@tsed/core";

See /packages/core/src/types/domain/Store.ts.

Overview

class Store {
    
    static from(...args: any[]): Store;
    static fromMethod(target: any, propertyKey: string | symbol): Store;
    static mergeStoreFrom(target: Type<any>, source: Type<any>, ...args: any[]): Store;
    static mergeStoreMethodFrom(target: Type<any>, source: Type<any>, propertyKey: string | symbol): Store;
    get<T = any>(key: any, defaultValue?: any): T;
    has(key: any): boolean;
    set(key: any, metadata: any): Store;
    delete(key: string): boolean;
    merge(key: any, value: any, inverse?: boolean): Store;
    toJson(): {};
}

static from

static from(...args: any[]): Store;

Create or get a Store from given args (target, property, descriptor).

static fromMethod

static fromMethod(target: any, propertyKey: string | symbol): Store;

Create store on the method.

static mergeStoreFrom

static mergeStoreFrom(target: Type<any>, source: Type<any>, ...args: any[]): Store;

static mergeStoreMethodFrom

static mergeStoreMethodFrom(target: Type<any>, source: Type<any>, propertyKey: string | symbol): Store;

get

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

• key (any): Required. The key of the element to return from the Map object.

The get() method returns a specified element from a Map object.

has

has(key: any): boolean;

The has() method returns a boolean indicating whether an element with the specified key exists or not.

set

set(key: any, metadata: any): Store;

• key (any): Required. The key of the element to add to the Map object.

• metadata (any): Required. The value of the element to add to the Map object.

The set() method adds or updates an element with a specified key and value to a Map object.

delete

delete(key: string): boolean;

• key (string): Required. The key of the element to remove from the Map object.

The delete() method removes the specified element from a Map object.

merge

merge(key: any, value: any, inverse?: boolean): Store;

• inverse (boolean): Optional. Change the merge order. Get the existing value and apply over given value

Merge given value with existing value.

toJson

toJson(): {};