Class WaytaleDatabase

Thin wrapper for the IndexedDB storage using promises. Supports database migrations and handles blocked database (for example when multiple tabs are open).

Index

Constructors

Methods

close createStore get nuke put update open

Constructors

constructor

new WaytaleDatabase(database: IDBDatabase): WaytaleDatabase
Create a new connection to a named database.
Parameters
- database: IDBDatabase
Returns WaytaleDatabase
- Defined in src/js/util/database.ts:48

Methods

close

close(): void
Close database.

Returns void
- Defined in src/js/util/database.ts:153

createStore

createStore(storeName: string): void
Create new store.
Parameters
- storeName: string
Returns void
- Defined in src/js/util/database.ts:134

get

get(storeName: string, key: IDBValidKey): Promise<unknown>
Get value from store.
Parameters
- storeName: string
- key: IDBValidKey
Returns Promise<unknown>
- Defined in src/js/util/database.ts:108

nuke

nuke(): void
Delete everything.

Returns void
- Defined in src/js/util/database.ts:142

put

put(storeName: string, key: IDBValidKey, value: unknown): Promise<void>
Put value into store.
Parameters
- storeName: string
- key: IDBValidKey
- value: unknown
Returns Promise<void>
- Defined in src/js/util/database.ts:121

update

update(
    storeName: string,
    key: IDBValidKey,
    worker: (arg0: unknown) => unknown,
): Promise<void>
Update value in store.
Parameters
- storeName: string
- key: IDBValidKey
- worker: (arg0: unknown) => unknown
Returns Promise<void>
- Defined in src/js/util/database.ts:93

`Static`open

open(databaseName?: string): Promise<WaytaleDatabase>
Open database.
Parameters
- databaseName: string = "Waytale"
Returns Promise<WaytaleDatabase>
- Defined in src/js/util/database.ts:56