Interface: ISettings#

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#

packages/settings/lib/tokens.d.ts:39

Methods#

get#

get(pluginId): Promise<undefined | IPlugin>

Get settings by plugin id

Parameters#

Name

Type

Description

pluginId

string

the id of the plugin

Returns#

Promise<undefined | IPlugin>

Defined in#

packages/settings/lib/tokens.d.ts:46


getAll#

getAll(): Promise<{ settings: IPlugin[] }>

Get all the settings

Returns#

Promise<{ settings: IPlugin[] }>

Defined in#

packages/settings/lib/tokens.d.ts:50


save#

save(pluginId, raw): Promise<void>

Save settings for a given plugin id

Parameters#

Name

Type

Description

pluginId

string

The id of the plugin

raw

string

The raw settings

Returns#

Promise<void>

Defined in#

packages/settings/lib/tokens.d.ts:60