moderator-toolbox-nxg-for-reddit / background/handlers/keyedStore

background/handlers/keyedStore

Classes

KeyedStore

Defined in: extension/data/background/handlers/keyedStore.ts:16

Generic keyed storage helper for flat namespaced values in browser.storage. Each entry is stored under a key of the form ${prefix}-${id}, allowing a single logical “store” to hold many independent values without a nested object.

Example

const store = new KeyedStore<MyType>('session', 'mynamespace');
await store.set('abc', {foo: 'bar'});
const val = await store.get('abc'); // {foo: 'bar'}
await store.delete('abc');

Type Parameters

T

T

Constructors

Constructor

new KeyedStore<T>(area, prefix): KeyedStore<T>

Defined in: extension/data/background/handlers/keyedStore.ts:17

Parameters
area

"local" | "session"

prefix

string

Returns

KeyedStore<T>

Methods

delete()

delete(id): Promise<void>

Defined in: extension/data/background/handlers/keyedStore.ts:40

Removes the stored value for id.

Parameters
id

string

Returns

Promise<void>

get()

get(id): Promise<T | null>

Defined in: extension/data/background/handlers/keyedStore.ts:33

Returns the stored value for id, or null if not present.

Parameters
id

string

Returns

Promise<T | null>

set()

set(id, value): Promise<void>

Defined in: extension/data/background/handlers/keyedStore.ts:28

Persists value under the storage key for id.

Parameters
id

string

value

T

Returns

Promise<void>