Class PassthroughKeyValueStorage<TVal>`Abstract`

Abstract class to create a KeyValueStorage by wrapping around another one.

Exposes abstract functions to modify the key before passing it to the the source storage.

Type Parameters

TVal

Hierarchy

PassthroughKeyValueStorage

Implements

KeyValueStorage<string, TVal>

Index

Constructors

Properties

Methods

delete entries get has set toNewKey toOriginalKey

Constructors

`Protected` constructor

new PassthroughKeyValueStorage<TVal>(source): PassthroughKeyValueStorage<TVal>
Type Parameters
- TVal
Parameters
- source: KeyValueStorage<string, TVal>
Returns PassthroughKeyValueStorage<TVal>
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:11

Properties

`Protected` `Readonly` source

source: KeyValueStorage<string, TVal>

Methods

delete

delete(key): Promise<boolean>
Deletes the value stored for the given key.
Parameters
- key: string
  
  Key to delete.
Returns Promise<boolean>
If there was a value to delete.
Implementation of KeyValueStorage.delete
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:31

entries

entries(): AsyncIterableIterator<[string, TVal]>
An iterable of entries in the storage.

Returns AsyncIterableIterator<[string, TVal]>
Implementation of KeyValueStorage.entries
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:36

get

get(key): Promise<undefined | TVal>
Returns the value stored for the given identifier. undefined if no value is stored.
Parameters
- key: string
Returns Promise<undefined | TVal>
Implementation of KeyValueStorage.get
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:15

has

has(key): Promise<boolean>
Checks whether there is a value stored for the given key.
Parameters
- key: string
Returns Promise<boolean>
Implementation of KeyValueStorage.has
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:20

set

set(key, value): Promise<PassthroughKeyValueStorage<TVal>>
Sets the value for the given key.
Parameters
- key: string
  
  Key to set/update.
- value: TVal
  
  Value to store.
Returns Promise<PassthroughKeyValueStorage<TVal>>
The storage.
Implementation of KeyValueStorage.set
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:25

`Protected` `Abstract` toNewKey

toNewKey(key): string
This function will be called on the input key and used as a new key when calling the source.
Parameters
- key: string
  
  Original input key.
Returns string
A new key to use with the source storage.
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:50

`Protected` `Abstract` toOriginalKey

toOriginalKey(key): string
This function is used when calling entries() to revert the key generated by toNewKey().
Parameters
- key: string
  
  A key generated by toNewKey()
Returns string
The original key.
- Defined in src/storage/keyvalue/PassthroughKeyValueStorage.ts:59