Skeudenn / preload / SettingsApi

Interface: SettingsApi

Defined in: src/preload.ts:196

The user's settings, as window.tankobon.settings.

Methods

getAll()

getAll(): Promise<PublicSettings>

Defined in: src/preload.ts:198

Every setting except the API keys, with defaults for the ones never stored.

Returns

Promise<PublicSettings>

---

getApiKeys()

getApiKeys(): Promise<ApiKeys>

Defined in: src/preload.ts:200

The metadata sources' API keys, kept out of getAll() so only the page that edits them loads them.

Returns

Promise<ApiKeys>

---

set()

set<K>(key, value): Promise<void>

Defined in: src/preload.ts:202

Stores one setting; the main process refuses an unknown key or a value its validator rejects.

Type Parameters

K

K extends keyof AppSettings

Parameters

key

K

value

AppSettings[K]

Returns

Promise<void>