Skip to main content

Class: MapStorage<V>

Defined in: packages/core/src/storage/MapStorage.ts:8

Implementation of the link Storage interface that relies on the native Map for storage.

Extends

Type Parameters

V

Constructors

new MapStorage()

new MapStorage<V>(): MapStorage<V>

Returns

MapStorage<V>

Inherited from

Storage.constructor

Accessors

$dependencies

Get Signature

get static $dependencies(): Dependencies

Defined in: packages/core/src/storage/MapStorage.ts:14

Returns

Dependencies

Methods

clear()

clear(): this

Defined in: packages/core/src/storage/MapStorage.ts:60

Clears the storage of all entries.

Returns

this

This storage.

Overrides

Storage.clear


delete()

delete(key): this

Defined in: packages/core/src/storage/MapStorage.ts:51

Deletes the entry identified by the specified key from this storage.

Parameters

key

string

The key identifying the storage entry.

Returns

this

This storage.

Overrides

Storage.delete


get()

get(key): undefined | V

Defined in: packages/core/src/storage/MapStorage.ts:35

Retrieves the value of the entry identified by the specified . The method returns undefined if the entry does not exists.

Entries set to the undefined value can be tested for existence using the link has method.

Parameters

key

string

The key identifying the storage entry.

Returns

undefined | V

The value of the storage entry.

Overrides

Storage.get


has()

has(key): boolean

Defined in: packages/core/src/storage/MapStorage.ts:28

Returns true if the entry identified by the specified key exists in this storage.

Parameters

key

string

The key identifying the storage entry.

Returns

boolean

true if the storage entry exists.

Overrides

Storage.has


init()

init(): this

Defined in: packages/core/src/storage/MapStorage.ts:21

This method is used to finalize the initialization of the storage after the dependencies provided through the constructor have been prepared for use.

This method must be invoked only once and it must be the first method invoked on this instance.

Returns

this

This storage.

Overrides

Storage.init


keys()

keys(): Iterable<string>

Defined in: packages/core/src/storage/MapStorage.ts:69

Returns an iterator for traversing the keys in this storage. The order in which the keys are traversed is undefined.

Returns

Iterable<string>

An iterator for traversing the keys in this storage. The iterator also implements the iterable protocol, returning itself as its own iterator, allowing it to be used in a for..of loop.

Overrides

Storage.keys


set()

set(key, value): this

Defined in: packages/core/src/storage/MapStorage.ts:42

Sets the storage entry identified by the specified key to the provided value. The method creates the entry if it does not exist already.

Parameters

key

string

The key identifying the storage entry.

value

V

The storage entry value.

Returns

this

This storage.

Overrides

Storage.set


size()

size(): number

Defined in: packages/core/src/storage/MapStorage.ts:76

Returns the number of entries in this storage.

Returns

number

The number of entries in this storage.

Overrides

Storage.size