# Store Class

Module
import { Store } from "@tsed/core"
Source/packages/core/src/class/Store.ts

# Overview

class Store extends Metadata {

<span class="token keyword">constructor</span><span class="token punctuation">(</span>args<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 * Return the size of the collection.
 * @returns <span class="token punctuation">{</span><span class="token keyword">number</span><span class="token punctuation">}</span>
 */
get <span class="token function">size</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>
/**
 * Create or get a Store <span class="token keyword">from</span> args <span class="token punctuation">{</span>target + methodName + descriptor<span class="token punctuation">}</span>
 * @param args
 * @returns <span class="token punctuation">{</span>Store<span class="token punctuation">}</span>
 */
<span class="token keyword">static</span> <span class="token keyword">from</span><span class="token punctuation">(</span>...args<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">:</span> Store<span class="token punctuation">;</span>
/**
 * Create store on the method.
 * @param target
 * @param <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span> propertyKey
 * @returns <span class="token punctuation">{</span>Store<span class="token punctuation">}</span>
 */
<span class="token keyword">static</span> <span class="token function">fromMethod</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> propertyKey<span class="token punctuation">:</span> <span class="token keyword">string</span> | symbol<span class="token punctuation">)</span><span class="token punctuation">:</span> Store<span class="token punctuation">;</span>
/**
 * Create a store correctly configured <span class="token keyword">from</span> the parameters given by the decorator.
 * The `fn` can return a decorator that will be initialized with the parameters <span class="token punctuation">(</span>target<span class="token punctuation">,</span> propertyKey<span class="token punctuation">,</span> descriptor<span class="token punctuation">)</span>.
 * @param <span class="token punctuation">{</span><span class="token punctuation">(</span>store<span class="token punctuation">:</span> Store<span class="token punctuation">,</span> parameters<span class="token punctuation">:</span> <a href="/api/core/interfaces/DecoratorParameters.html"><span class="token">DecoratorParameters</span></a><span class="token punctuation">)</span> =&gt; <span class="token keyword">void</span><span class="token punctuation">}</span> fn
 * @deprecated <a href="/api/common/mvc/decorators/method/Use.html"><span class="token">Use</span></a> <a href="/api/core/decorators/StoreFn.html"><span class="token">StoreFn</span></a>
 * @returns <span class="token punctuation">{</span>Function<span class="token punctuation">}</span>
 */
<span class="token keyword">static</span> <span class="token function">decorate</span><span class="token punctuation">(</span>fn<span class="token punctuation">:</span> <span class="token punctuation">(</span>store<span class="token punctuation">:</span> Store<span class="token punctuation">,</span> parameters<span class="token punctuation">:</span> <a href="/api/core/interfaces/DecoratorParameters.html"><span class="token">DecoratorParameters</span></a><span class="token punctuation">)</span> =&gt; <span class="token keyword">void</span><span class="token punctuation">)</span><span class="token punctuation">:</span> Function<span class="token punctuation">;</span>
/**
 * The <span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method returns a specified element <span class="token keyword">from</span> a Map object.
 * @param key <a href="/api/common/mvc/decorators/Required.html"><span class="token">Required</span></a>. The key of the element to return <span class="token keyword">from</span> the Map object.
 * @returns <span class="token punctuation">{</span>T<span class="token punctuation">}</span> <a href="/api/common/mvc/decorators/method/Returns.html"><span class="token">Returns</span></a> the element associated with the specified key or undefined if the key can't be found in the Map object.
 */
get&lt;T<span class="token punctuation"> = </span><span class="token keyword">any</span>&gt;<span class="token punctuation">(</span>key<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> T<span class="token punctuation">;</span>
/**
 * The <span class="token function">has</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method returns a <span class="token keyword">boolean</span> indicating whether an element with the specified key exists or not.
 * @param key
 * @returns <span class="token punctuation">{</span><span class="token keyword">boolean</span><span class="token punctuation">}</span>
 */
<span class="token function">has</span><span class="token punctuation">(</span>key<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
/**
 * The <span class="token function">set</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method adds or updates an element with a specified key and value to a Map object.
 * @param key <a href="/api/common/mvc/decorators/Required.html"><span class="token">Required</span></a>. The key of the element to add to the Map object.
 * @param metadata <a href="/api/common/mvc/decorators/Required.html"><span class="token">Required</span></a>. The value of the element to add to the Map object.
 * @returns <span class="token punctuation">{</span><a href="/api/core/class/Registry.html"><span class="token">Registry</span></a><span class="token punctuation">}</span>
 */
<span class="token function">set</span><span class="token punctuation">(</span>key<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> metadata<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> Store<span class="token punctuation">;</span>
/**
 * The <span class="token function">entries</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method returns a new Iterator object that contains the <span class="token punctuation">[</span>key<span class="token punctuation">,</span> value<span class="token punctuation">]</span> pairs for each element in the Map object in insertion order.
 * @returns <span class="token punctuation">{</span>IterableIterator<span class="token punctuation">}</span> A new Map iterator object.
 */
<span class="token function">entries</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> IterableIterator&lt;<span class="token punctuation">[</span><span class="token keyword">string</span><span class="token punctuation">,</span> <span class="token keyword">any</span><span class="token punctuation">]</span>&gt;<span class="token punctuation">;</span>
/**
 * The <span class="token function">keys</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method returns a new Iterator object that contains the keys for each element in the Map object in insertion order.
 * @returns <span class="token punctuation">{</span>IterableIterator<span class="token punctuation">}</span> A new Map iterator object.
 */
<span class="token function">keys</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> IterableIterator&lt;<span class="token keyword">string</span>&gt;<span class="token punctuation">;</span>
/**
 * The <span class="token function">clear</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method removes all elements <span class="token keyword">from</span> a Map object.
 */
<span class="token function">clear</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
/**
 * The <span class="token function">delete</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method removes the specified element <span class="token keyword">from</span> a Map object.
 * @param key <a href="/api/common/mvc/decorators/Required.html"><span class="token">Required</span></a>. The key of the element to remove <span class="token keyword">from</span> the Map object.
 * @returns <span class="token punctuation">{</span><span class="token keyword">boolean</span><span class="token punctuation">}</span> <a href="/api/common/mvc/decorators/method/Returns.html"><span class="token">Returns</span></a> true if an element in the Map object existed and has been removed<span class="token punctuation">,</span> or false if the element does not exist.
 */
<span class="token function">delete</span><span class="token punctuation">(</span>key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
/**
 * The <span class="token function">forEach</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method executes a provided function once per each key/value pair in the Map object<span class="token punctuation">,</span> in insertion order.
 *
 * @param callbackfn Function to execute for each element.
 * @param thisArg <a href="/api/di/decorators/Value.html"><span class="token">Value</span></a> to use <span class="token keyword">as</span> this when executing callback.
 * @description
 * The forEach method executes the provided callback once for each key of the map which actually exist. It is not invoked for keys which have been deleted. However<span class="token punctuation">,</span> it is executed for values which are present but have the value undefined.
 * callback is invoked with three arguments<span class="token punctuation">:</span>
 *
 * * the element value
 * * the element key
 * * the Map object being traversed
 *
 * If a thisArg parameter is provided to forEach<span class="token punctuation">,</span> it will be passed to callback when invoked<span class="token punctuation">,</span> for use <span class="token keyword">as</span> its this value.  Otherwise<span class="token punctuation">,</span> the value undefined will be passed for use <span class="token keyword">as</span> its this value.  The this value ultimately observable by callback is determined according to the usual rules for determining the this seen by a function.
 *
 * Each value is visited once<span class="token punctuation">,</span> except in the case when it was deleted and re-added before forEach has finished. callback is not invoked for values deleted before being visited. New values added before forEach has finished will be visited.
 * forEach executes the callback function once for each element in the Map object<span class="token punctuation">;</span> it does not return a value.
 *
 */
<span class="token function">forEach</span><span class="token punctuation">(</span>callbackfn<span class="token punctuation">:</span> <span class="token punctuation">(</span>value<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> map<span class="token punctuation">:</span> Map&lt;<span class="token keyword">string</span><span class="token punctuation">,</span> <span class="token keyword">any</span>&gt;<span class="token punctuation">)</span> =&gt; <span class="token keyword">void</span><span class="token punctuation">,</span> thisArg?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
/**
 * The <span class="token function">values</span><span class="token punctuation">(</span><span class="token punctuation">)</span> method returns a new Iterator object that contains the values for each element in the Map object in insertion order.
 * @returns <span class="token punctuation">{</span>IterableIterator<span class="token punctuation">}</span> A new Map iterator object.
 */
<span class="token function">values</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> IterableIterator&lt;<span class="token keyword">any</span>&gt;<span class="token punctuation">;</span>
/**
 * Merge given value with existing value.
 * @param key
 * @param value
 * @param inverse Change the merge order. <a href="/api/common/mvc/decorators/method/Get.html"><span class="token">Get</span></a> the existing value and apply over given value
 * @returns <span class="token punctuation">{</span>Store<span class="token punctuation">}</span>
 */
<span class="token function">merge</span><span class="token punctuation">(</span>key<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> value<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> inverse?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">)</span><span class="token punctuation">:</span> Store<span class="token punctuation">;</span>
/**
 * Store all keys contains in the options object.
 * @param options
 * @param args
 */
<span class="token function">storeValues</span><span class="token punctuation">(</span>options<span class="token punctuation">:</span> <span class="token punctuation">{</span>
    <span class="token punctuation">[</span>key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">]</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
/**
 *
 * @param key
 * @param args
 * @<span class="token keyword">private</span>
 */

}

# Members

get size(): number;

Return the size of the collection.

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

Create or get a Store from args {target + methodName + descriptor}

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

Create store on the method.

static decorate(fn: (store: Store, parameters: DecoratorParameters) => void): Function;

Create a store correctly configured from the parameters given by the decorator. The fn can return a decorator that will be initialized with the parameters (target, propertyKey, descriptor).

get<T = any>(key: any): T;
Param Type Description
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(key: any): boolean;

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

set(key: any, metadata: any): Store;
Param Type Description
key any Required. The key of the element to add to the Map object. metadata

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

entries(): IterableIterator<[string, any]>;

The entries() method returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order.

keys(): IterableIterator<string>;

The keys() method returns a new Iterator object that contains the keys for each element in the Map object in insertion order.

clear(): void;

The clear() method removes all elements from a Map object.

delete(key: string): boolean;
Param Type Description
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.

forEach(callbackfn: (value: any, key: string, map: Map<string, any>) => void, thisArg?: any): void;
Param Type Description
callbackfn (value: any Function to execute for each element. thisArg

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.

The forEach method executes the provided callback once for each key of the map which actually exist. It is not invoked for keys which have been deleted. However, it is executed for values which are present but have the value undefined. callback is invoked with three arguments:

  • the element value
  • the element key
  • the Map object being traversed

If a thisArg parameter is provided to forEach, it will be passed to callback when invoked, for use as its this value. Otherwise, the value undefined will be passed for use as its this value. The this value ultimately observable by callback is determined according to the usual rules for determining the this seen by a function.

Each value is visited once, except in the case when it was deleted and re-added before forEach has finished. callback is not invoked for values deleted before being visited. New values added before forEach has finished will be visited. forEach executes the callback function once for each element in the Map object; it does not return a value.

values(): IterableIterator<any>;

The values() method returns a new Iterator object that contains the values for each element in the Map object in insertion order.

merge(key: any, value: any, inverse?: boolean): Store;
Param Type Description
inverse boolean Optional. Change the merge order. Get the existing value and apply over given value

Merge given value with existing value.

storeValues(options: {
     [key: string]: any;
 }): void;

Store all keys contains in the options object.