Class: Settings

settings.Settings

A class to handle requests to /api/settings

Constructors

constructor

new Settings(options?)

Parameters

Name

Type

options?

IOptions

Defined in

packages/settings/lib/settings.d.ts:5

Properties

_getFederated

Private _getFederated: any

Get the settings for a federated extension

param The id of a plugin

Defined in

packages/settings/lib/settings.d.ts:37


_settingsStorageName

Private _settingsStorageName: any

Defined in

packages/settings/lib/settings.d.ts:38


_storage

Private _storage: any

Defined in

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

Methods

defaultSettingsStorage

Protected defaultSettingsStorage(): any

Create a settings store.

Returns

any

Defined in

packages/settings/lib/settings.d.ts:10


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/settings.d.ts:17


getAll

getAll(): Promise<Object>

Get all the settings

Returns

Promise<Object>

Defined in

packages/settings/lib/settings.d.ts:21


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/settings.d.ts:31