Tankōbon

Appearance

Tankōbon / preload / SettingsApi

Interface: SettingsApi ​

Defined in: preload.ts:158

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

Methods ​

getAll() ​

getAll(): Promise<PublicSettings>

Defined in: preload.ts:160

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

Returns ​

Promise<PublicSettings>

getApiKeys() ​

getApiKeys(): Promise<ApiKeys>

Defined in: preload.ts:162

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: preload.ts:164

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>