Class SettingConnector

A data connector for fetching settings.

Notes

This connector adds a query parameter to the base services setting manager.

Hierarchy (View Summary)

DataConnector<ISettingRegistry.IPlugin, string>
- SettingConnector

Implements

ISettingConnector

Index

Constructors

Methods

fetch list remove save

Constructors

constructor

new SettingConnector(
    connector: IDataConnector<
        ISettingRegistry.IPlugin,
        string,
        string,
        string,
    >,
): SettingConnector
Parameters
- connector: IDataConnector<ISettingRegistry.IPlugin, string, string, string>
Returns SettingConnector
Overrides DataConnector.constructor
- Defined in packages/settingregistry/src/settingconnector.ts:22

Methods

fetch

fetch(id: string): Promise<undefined | ISettingRegistry.IPlugin>
Fetch settings for a plugin.
Parameters
- id: string
  The plugin ID
  
  Notes
  The REST API requests are throttled at one request per plugin per 100ms.
Returns Promise<undefined | ISettingRegistry.IPlugin>
Implementation of ISettingConnector.fetch
Overrides DataConnector.fetch
- Defined in packages/settingregistry/src/settingconnector.ts:34

list

list(query: "ids"): Promise<{ ids: string[] }>
Retrieve the list of items available from the data connector.
Parameters
- query: "ids"
  The optional query filter to apply to the connector request.
Returns Promise<{ ids: string[] }>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can list.
Implementation of ISettingConnector.list
Overrides DataConnector.list
- Defined in packages/settingregistry/src/settingconnector.ts:42
list(
query: "all" | "active",
): Promise<{ ids: string[]; values: ISettingRegistry.IPlugin[] }>
Parameters
- query: "all" | "active"
Returns Promise<{ ids: string[]; values: ISettingRegistry.IPlugin[] }>
Implementation of ISettingConnector.list
Overrides DataConnector.list
- Defined in packages/settingregistry/src/settingconnector.ts:43

remove

remove(id: string): Promise<any>
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 ISettingConnector.remove
Inherited from DataConnector.remove
- Defined in packages/statedb/lib/dataconnector.d.ts:61

save

save(id: string, raw: string): Promise<void>
Save a value using the data connector.
Parameters
- id: string
  The identifier for the data being saved.
- raw: string
Returns Promise<void>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can save.
Implementation of ISettingConnector.save
Overrides DataConnector.save
- Defined in packages/settingregistry/src/settingconnector.ts:68