Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SettingManager<V>

The settings API service manager. A namespace for SettingManager statics.

Type parameters

  • V

Hierarchy

  • DataConnector<IPlugin, string>

Implements

  • IDataConnector<IPlugin, string, V>

Index

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Properties

serverSettings

serverSettings: ISettings

The server settings used to make API requests.

Methods

fetch

  • fetch(id: string): Promise<IPlugin>

  • Fetch a plugin's settings.

    Parameters

    • id: string

      The plugin's ID.

    Returns Promise<IPlugin>

    A promise that resolves if successful.

list

  • list(): Promise<object>

  • Fetch the list of all plugin setting bundles.

    Returns Promise<object>

    A promise that resolves if successful.

remove

  • remove(id: V): Promise<any>

  • Remove a value using the data connector.

    Parameters

    • id: V

      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.

save

  • save(id: string, raw: string): Promise<void>

  • Save a plugin's settings.

    Parameters

    • id: string

      The plugin's ID.

    • raw: string

      The user setting values as a raw string of JSON with comments.

    Returns Promise<void>

    A promise that resolves if successful.

Generated using TypeDoc