Class KVStore

Persistent key-value storage backed by the browser.storage API.

Implemented by

NamespacedKVStore

Index

Constructors

Methods

clear get getKeys remove set

Constructors

constructor

new KVStore(): KVStore

Returns KVStore

Methods

clear

clear(prefix?: string, area?: "local" | "session"): Promise<void>
Clears all values whose key matches the specified prefix.
Parameters
- prefix: string = ""
  The prefix to match against.
- area: "local" | "session" = "local"
  The name of the storage area to use.
Returns Promise<void>
- Defined in browser/kvstore.ts:40

get

get(key: string, area?: "local" | "session"): Promise<any>
Reads a persisted value.
Parameters
- key: string
  The key to read.
- area: "local" | "session" = "local"
  The name of the storage area to read from.
Returns Promise<any>
A Promise that resolves to the value read.
- Defined in browser/kvstore.ts:16

getKeys

getKeys(prefix?: string, area?: "local" | "session"): Promise<string[]>
Retrieves a list of stored keys matching the specified prefix.
Parameters
- prefix: string = ""
  The prefix to match against.
- area: "local" | "session" = "local"
  The name of the storage area to read from.
Returns Promise<string[]>
A Promise that resolves to an array of matching keys.
- Defined in browser/kvstore.ts:52

remove

remove(key: string, area?: "local" | "session"): Promise<void>
Clears a single persisted value.
Parameters
- key: string
  The key to clear.
- area: "local" | "session" = "local"
  The name of the storage area to use.
Returns Promise<void>
- Defined in browser/kvstore.ts:68

set

set(
items: { [key: string]: unknown },
area?: "local" | "session",
): Promise<void>
Stores values.
Parameters
- items: { [key: string]: unknown }
  An object consisting of one or more key/value pairs to store.
- area: "local" | "session" = "local"
  The name of the storage area to use.
Returns Promise<void>
- Defined in browser/kvstore.ts:27