Class: Settings#

@jupyterlite/settings.Settings

A class to manage settings in the browser.

Hierarchy#

  • SettingManager

    ↳ Settings

Implements#

  • IManager

Constructors#

constructor#

new Settings(options)

Create a new settings service.

Parameters#

Name

Type

options

IOptions

Overrides#

SettingManager.constructor

Defined in#

packages/settings/src/settings.ts:30

Properties#

_localforage#

Private _localforage: LocalForage

Defined in#

packages/settings/src/settings.ts:184

_ready#

Private _ready: PromiseDelegate<void>

Defined in#

packages/settings/src/settings.ts:185

_storage#

Private _storage: undefined | LocalForage

Defined in#

packages/settings/src/settings.ts:183

_storageDrivers#

Private _storageDrivers: null | string[] = null

Defined in#

packages/settings/src/settings.ts:182

_storageName#

Private _storageName: string = DEFAULT_STORAGE_NAME

Defined in#

packages/settings/src/settings.ts:181

serverSettings#

Readonly serverSettings: ISettings

The server settings used to make API requests.

Implementation of#

Setting.IManager.serverSettings

Inherited from#

SettingManager.serverSettings

Defined in#

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

Accessors#

defaultStorageOptions#

Protected get defaultStorageOptions(): LocalForageOptions

Get default options for localForage instances

Returns#

LocalForageOptions

Defined in#

packages/settings/src/settings.ts:74

ready#

get ready(): Promise<void>

A promise that resolves when the settings storage is fully initialized

Returns#

Promise<void>

Defined in#

packages/settings/src/settings.ts:45

storage#

Protected get storage(): Promise<LocalForage>

A lazy reference to initialized storage

Returns#

Promise<LocalForage>

Defined in#

packages/settings/src/settings.ts:52

Methods#

_getAll#

Private _getAll(file): Promise<IPlugin[]>

Get all the settings for core or federated plugins

Parameters#

Name

Type

file

SettingsFile

Returns#

Promise<IPlugin[]>

Defined in#

packages/settings/src/settings.ts:173

defaultSettingsStorage#

Protected defaultSettingsStorage(): LocalForage

Create a settings store.

Returns#

LocalForage

Defined in#

packages/settings/src/settings.ts:86

fetch#

fetch(pluginId): Promise<IPlugin>

Get settings by plugin id

Parameters#

Name

Type

Description

pluginId

string

the id of the plugin

Returns#

Promise<IPlugin>

Implementation of#

Setting.IManager.fetch

Overrides#

SettingManager.fetch

Defined in#

packages/settings/src/settings.ts:100

initStorage#

Protected initStorage(): Promise<void>

Prepare the storage

Returns#

Promise<void>

Defined in#

packages/settings/src/settings.ts:67

initialize#

initialize(): Promise<void>

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

Returns#

Promise<void>

Defined in#

packages/settings/src/settings.ts:59

list#

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

Get all the settings

Parameters#

Name

Type

query?

"ids"

Returns#

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

Implementation of#

Setting.IManager.list

Overrides#

SettingManager.list

Defined in#

packages/settings/src/settings.ts:115

remove#

remove(id): Promise<any>

Remove a value using the data connector.

Parameters#

Name

Type

Description

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

Defined in#

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

save#

save(id, raw): Promise<void>

Save settings for a given plugin id

Parameters#

Name

Type

Description

id

string

-

raw

string

The raw settings

Returns#

Promise<void>

Implementation of#

Setting.IManager.save

Overrides#

SettingManager.save

Defined in#

packages/settings/src/settings.ts:166