Skip to main content

Class: IndexedDbSettingsStore

Defined in: src/lib/storage/index.ts:257

Keeps the user's app settings (see AppSettings) in the browser's IndexedDB database (DATABASE_NAME), under a name.

Example​

const store = new IndexedDbSettingsStore();
await store.save(collectSettings(canvas));

Implements​

Constructors​

Constructor​

new IndexedDbSettingsStore(name?, factory?): IndexedDbSettingsStore

Defined in: src/lib/storage/index.ts:266

Parameters​

name?​

string = DEFAULT_SETTINGS_NAME

the settings' name (DEFAULT_SETTINGS_NAME by default)

factory?​

IDBFactory = indexedDB

the IndexedDB to use (the browser's by default)

Returns​

IndexedDbSettingsStore

Properties​

name​

readonly name: string

Defined in: src/lib/storage/index.ts:258

The settings' name, e.g. to keep settings for different apps apart

Implementation of​

SettingsStoreLike.name

Methods​

load()​

load(): Promise<unknown>

Defined in: src/lib/storage/index.ts:274

The saved settings (untrusted: check them before using them), or undefined if none were saved

Returns​

Promise<unknown>

Implementation of​

SettingsStoreLike.load


save()​

save(settings): Promise<void>

Defined in: src/lib/storage/index.ts:284

Save the settings

Parameters​

settings​

AppSettings

Returns​

Promise<void>

Implementation of​

SettingsStoreLike.save