Interface IManager

ReadonlyserverSettings

fetch

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

• Fetch a plugin's settings.

  Parameters

  • id: string

    The plugin's ID.

  Returns Promise<ISettingRegistry.IPlugin>

  A promise that resolves if successful.

list

• list(
      query?: "ids",
  ): Promise<{ ids: string[]; values: ISettingRegistry.IPlugin[] }>

• Fetch the list of all plugin setting bundles.

  Parameters

  • Optionalquery: "ids"

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

  A promise that resolves if successful.

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.

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.