Abstract Class: Storage<V>
Defined in: packages/core/src/storage/Storage.ts:6
The Storage is an unordered collection of named values of any
type. Values in the storage are named using string keys. The storage
can be therefore thought of as a Map<string, *>.....
Extended by
Type Parameters
V
V
Constructors
Constructor
new Storage<
V>():Storage<V>
Returns
Storage<V>
Methods
clear()
clear():
this
Defined in: packages/core/src/storage/Storage.ts:73
Clears the storage of all entries.
Returns
this
This storage.
delete()
delete(
key):this
Defined in: packages/core/src/storage/Storage.ts:64
Deletes the entry identified by the specified key from this storage.
Parameters
key
string
The key identifying the storage entry.
Returns
this
This storage.
get()
get(
key):V|undefined
Defined in: packages/core/src/storage/Storage.ts:42
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
V | undefined
The value of the storage entry.
has()
has(
key):boolean
Defined in: packages/core/src/storage/Storage.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.
init()
init():
this
Defined in: packages/core/src/storage/Storage.ts:17
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.
keys()
keys():
Iterable<string>
Defined in: packages/core/src/storage/Storage.ts:86
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.
set()
set(
key,value):this
Defined in: packages/core/src/storage/Storage.ts:54
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.
size()
size():
number
Defined in: packages/core/src/storage/Storage.ts:95
Returns the number of entries in this storage.
Returns
number
The number of entries in this storage.