@jupyterlite

@jupyterlite / @jupyterlite/settings / Settings

Class: Settings#

Defined in: packages/services/lib/settings/settings.d.ts:12

A class to manage settings in the browser.

Extends#

  • SettingManager

Implements#

  • IManager

Constructors#

Constructor#

new Settings(options): Settings

Defined in: packages/services/lib/settings/settings.d.ts:16

Create a new settings service.

Parameters#

options#

IOptions

Returns#

Settings

Overrides#

SettingManager.constructor

Properties#

serverSettings#

readonly serverSettings: ISettings

Defined in: node_modules/@jupyterlab/services/lib/setting/index.d.ts:15

The server settings used to make API requests.

Implementation of#

Setting.IManager.serverSettings

Inherited from#

SettingManager.serverSettings

Accessors#

defaultStorageOptions#

Get Signature#

get protected defaultStorageOptions(): LocalForageOptions

Defined in: packages/services/lib/settings/settings.d.ts:36

Get default options for localForage instances

Returns#

LocalForageOptions

ready#

Get Signature#

get ready(): Promise<void>

Defined in: packages/services/lib/settings/settings.d.ts:20

A promise that resolves when the settings storage is fully initialized

Returns#

Promise<void>

storage#

Get Signature#

get protected storage(): Promise<LocalForage>

Defined in: packages/services/lib/settings/settings.d.ts:24

A lazy reference to initialized storage

Returns#

Promise<LocalForage>

Methods#

clear()#

clear(): Promise<void>

Defined in: packages/services/lib/settings/settings.d.ts:68

Clear all stored settings

Returns#

Promise<void>

A promise which resolves when the settings are cleared

defaultSettingsStorage()#

protected defaultSettingsStorage(): LocalForage

Defined in: packages/services/lib/settings/settings.d.ts:40

Create a settings store.

Returns#

LocalForage

fetch()#

fetch(pluginId): Promise<IPlugin>

Defined in: packages/services/lib/settings/settings.d.ts:47

Get settings by plugin id

Parameters#

pluginId#

string

the id of the plugin

Returns#

Promise<IPlugin>

Implementation of#

Setting.IManager.fetch

Overrides#

SettingManager.fetch

initialize()#

initialize(): Promise<void>

Defined in: packages/services/lib/settings/settings.d.ts:28

Finish any initialization after server has started and all extensions are applied.

Returns#

Promise<void>

initStorage()#

protected initStorage(): Promise<void>

Defined in: packages/services/lib/settings/settings.d.ts:32

Prepare the storage

Returns#

Promise<void>

list()#

list(query?): Promise<{ ids: string[]; values: IPlugin[]; }>

Defined in: packages/services/lib/settings/settings.d.ts:51

Get all the settings

Parameters#

query?#

"ids"

Returns#

Promise<{ ids: string[]; values: IPlugin[]; }>

Implementation of#

Setting.IManager.list

Overrides#

SettingManager.list

remove()#

remove(id): Promise<any>

Defined in: node_modules/@jupyterlab/statedb/lib/dataconnector.d.ts:61

Remove a value using the data connector.

Parameters#

id#

string

The identifier for the data being removed.

Returns#

Promise<any>

A promise that always rejects with an error.

Notes#

Subclasses should reimplement if they support a back-end that can remove.

Implementation of#

Setting.IManager.remove

Inherited from#

SettingManager.remove

save()#

save(id, raw): Promise<void>

Defined in: packages/services/lib/settings/settings.d.ts:62

Save settings for a given plugin id

Parameters#

id#

string

raw#

string

The raw settings

Returns#

Promise<void>

Implementation of#

Setting.IManager.save

Overrides#

SettingManager.save