Interface: ISettings
#
@jupyterlite/settings.ISettings
The interface for the Settings service.
Properties#
ready
#
ready
:Promise
<void
>
A promise that resolves after the settings have been full initialized
Defined in#
Methods#
get
#
get
(pluginId
):Promise
<undefined
|IPlugin
>
Get settings by plugin id
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
the id of the plugin |
Returns#
Promise
<undefined
| IPlugin
>
Defined in#
getAll
#
getAll
():Promise
<{settings
:IPlugin
[] }>
Get all the settings
Returns#
Promise
<{ settings
: IPlugin
[] }>
Defined in#
save
#
save
(pluginId
,raw
):Promise
<void
>
Save settings for a given plugin id
Parameters#
Name |
Type |
Description |
---|---|---|
|
|
The id of the plugin |
|
|
The raw settings |
Returns#
Promise
<void
>