Interface KeyValueStorage<TKey, TValue>

A simple storage solution that can be used for internal values that need to be stored.

Type parameters

TKey
TValue

Hierarchy

KeyValueStorage
- ExpiringStorage

Implemented by

Index

Methods

Methods

delete

delete(key: TKey): Promise<boolean>

- Defined in src/storage/keyvalue/KeyValueStorage.ts:33
Deletes the value stored for the given key.

Parameters
- key: TKey
  Key to delete.
Returns Promise<boolean>
If there was a value to delete.

entries

entries(): AsyncIterableIterator<[TKey, TValue]>

- Defined in src/storage/keyvalue/KeyValueStorage.ts:38
An iterable of entries in the storage.

Returns AsyncIterableIterator<[TKey, TValue]>

get

get(key: TKey): Promise<undefined | TValue>

- Defined in src/storage/keyvalue/KeyValueStorage.ts:10
Returns the value stored for the given identifier. undefined if no value is stored.

Parameters
- key: TKey
Returns Promise<undefined | TValue>

has

has(key: TKey): Promise<boolean>

- Defined in src/storage/keyvalue/KeyValueStorage.ts:16
Checks if there is a value stored for the given key.

Parameters
- key: TKey
Returns Promise<boolean>

set

set(key: TKey, value: TValue): Promise<this>

- Defined in src/storage/keyvalue/KeyValueStorage.ts:25
Sets the value for the given key.

Parameters
- key: TKey
  Key to set/update.
- value: TValue
  Value to store.
Returns Promise<this>
The storage.