Class SettingManager

constructor

• new SettingManager(options?): SettingManager

• Create a new setting manager.

  Parameters

  • options: SettingManager.IOptions = {}

  Returns SettingManager

Readonly serverSettings

fetch

• fetch(id): 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(query?): Promise<{
      ids: string[];
      values: IPlugin[];
  }>

• Fetch the list of all plugin setting bundles.

  Parameters

  • Optional query: "ids"

  Returns Promise<{
      ids: string[];
      values: IPlugin[];
  }>

  A promise that resolves if successful.

save

• save(id, raw): 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.