Class MemoryStorageProvider<TKey, TValue>

A key/value storage system for local memory. This is essentially a wrapper of a Map

Type parameters

TKey
TValue

Hierarchy

MemoryStorageProvider

Implements

IStorageProvider<TKey, TValue>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MemoryStorageProvider<TKey, TValue>(): MemoryStorageProvider<TKey, TValue>

Type parameters
- TKey
- TValue
Returns MemoryStorageProvider<TKey, TValue>

Properties

Private Readonly data

data: Map<TKey, IAgedValue<TValue>> = ...

Readonly isPersistable

isPersistable: false = false

Methods

delete

delete(key: TKey): Promise<boolean | IAgedValue<TValue>>

Implementation of IStorageProvider.delete
- Defined in main/src/storage/MemoryStorageProvider.ts:36
Parameters
- key: TKey
  
  The key to the value to delete
Returns Promise<boolean | IAgedValue<TValue>>
The value deleted or boolean (value | true is success). A provider is not required to return a value

get

get(key: TKey): Promise<null | IAgedValue<TValue>>

Implementation of IStorageProvider.get
- Defined in main/src/storage/MemoryStorageProvider.ts:16
Parameters
- key: TKey
  
  The key to retrieve
Returns Promise<null | IAgedValue<TValue>>
The value if retreiving was successful or null

keys

keys(): Promise<TKey[]>

Implementation of IStorageProvider.keys
- Defined in main/src/storage/MemoryStorageProvider.ts:44
Returns Promise<TKey[]>
The keys that are currently available in the provider

set

set(key: TKey, agedValue: IAgedValue<TValue>): Promise<null | IAgedValue<TValue>>

Implementation of IStorageProvider.set
- Defined in main/src/storage/MemoryStorageProvider.ts:26
Parameters
- key: TKey
  
  The key to set
- agedValue: IAgedValue<TValue>
Returns Promise<null | IAgedValue<TValue>>
The value written if successful or null

size

size(): Promise<number>

Implementation of IStorageProvider.size
- Defined in main/src/storage/MemoryStorageProvider.ts:52
Returns Promise<number>
The number of elements in this storage system

Generated using TypeDoc