Class IndexedDBStore

Interface class for simplified, promised-based interaction with in-browser IndexedDB data storage. This class is specialises for using only one data store as key-value backend.

Index

Constructors

Methods

get getMany set setMany open

Constructors

constructor

new IndexedDBStore(database: IDBDatabase, storeName: string): IndexedDBStore
Parameters
- database: IDBDatabase
  API connection to a database
- storeName: string
  name of the store to use
Returns IndexedDBStore
- Defined in common.js:433

Methods

get

get(key: string): Promise<any>
Get the value for a given key from the store.
Parameters
- key: string
  name to look up data for
Returns Promise<any>
- the looked up value
- Defined in common.js:444

getMany

getMany(keys: string[]): Promise<any[]>
Get multiple values for given keys in a single transaction.
Parameters
- keys: string[]
  names to look up data for
Returns Promise<any[]>
- the looked up value
- Defined in common.js:458

set

set(key: string, value: any): Promise<string>
Set a value for a given key in the store.
Parameters
- key: string
  the name to store data as
- value: any
  the data to store
Returns Promise<string>
- key to new or updated storage
- Defined in common.js:473

setMany

setMany(pairs: any[][]): Promise<string[]>
Set multiple values for given keys in a single transaction. The parameter must contain multiple 2-tuples for calls to set(), i.e. an array of key-value-pairs.
Parameters
- pairs: any[][]
  an array of key-value pairs
Returns Promise<string[]>
- keys to new or updated storage
- Defined in common.js:489

`Static`open

open(databaseName: string, storeName: string): Promise<IndexedDBStore>
Create a new connection to a data store for a given database.
Parameters
- databaseName: string
  name of the database
- storeName: string
  name of the store to connect to
Returns Promise<IndexedDBStore>
- new database connection
- Defined in common.js:417