Class SettingRegistry

constructor

• new SettingRegistry(options): SettingRegistry

• Create a new setting registry.

  Parameters

  • options: SettingRegistry.IOptions

  Returns SettingRegistry

Readonly connector

Readonly plugins

Readonly schema

Readonly validator

pluginChanged

• get pluginChanged(): ISignal<this, string>

• A signal that emits the name of a plugin when its settings change.

  Returns ISignal<this, string>

get

• get(plugin, key): Promise<{
      composite: undefined | PartialJSONValue;
      user: undefined | PartialJSONValue;
  }>

• Get an individual setting.

  Parameters

  • plugin: string

    The name of the plugin whose settings are being retrieved.
  • key: string

    The name of the setting being retrieved.

  Returns Promise<{
      composite: undefined | PartialJSONValue;
      user: undefined | PartialJSONValue;
  }>

  A promise that resolves when the setting is retrieved.

load

• load(plugin, forceTransform?): Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>

• Load a plugin's settings into the setting registry.

  Parameters

  • plugin: string

    The name of the plugin whose settings are being loaded.
  • forceTransform: boolean = false

    An optional parameter to force replay the transforms methods.

  Returns Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>

  A promise that resolves with a plugin settings object or rejects if the plugin is not found.

reload

• reload(plugin): Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>

• Reload a plugin's settings into the registry even if they already exist.

  Parameters

  • plugin: string

    The name of the plugin whose settings are being reloaded.

  Returns Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>

  A promise that resolves with a plugin settings object or rejects with a list of ISchemaValidator.IError objects if it fails.

remove

• remove(plugin, key): Promise<void>

• Remove a single setting in the registry.

  Parameters

  • plugin: string

    The name of the plugin whose setting is being removed.
  • key: string

    The name of the setting being removed.

  Returns Promise<void>

  A promise that resolves when the setting is removed.

set

• set(plugin, key, value): Promise<void>

• Set a single setting in the registry.

  Parameters

  • plugin: string

    The name of the plugin whose setting is being set.
  • key: string

    The name of the setting being set.
  • value: JSONValue

    The value of the setting being set.

  Returns Promise<void>

  A promise that resolves when the setting has been saved.

transform

• transform(plugin, transforms): IDisposable

• Register a plugin transform function to act on a specific plugin.

  Parameters

  • plugin: string

    The name of the plugin whose settings are transformed.
  • transforms: {
        compose: undefined | Transform;
        fetch: undefined | Transform;
    }

    The transform functions applied to the plugin.

    • compose: undefined | Transform

    • fetch: undefined | Transform

  Returns IDisposable

  A disposable that removes the transforms from the registry.

  Notes

  • compose transformations: The registry automatically overwrites a plugin's default values with user overrides, but a plugin may instead wish to merge values. This behavior can be accomplished in a compose transformation.
  • fetch transformations: The registry uses the plugin data that is fetched from its connector. If a plugin wants to override, e.g. to update its schema with dynamic defaults, a fetch transformation can be applied.

upload

• upload(plugin, raw): Promise<void>

• Upload a plugin's settings.

  Parameters

  • plugin: string

    The name of the plugin whose settings are being set.
  • raw: string

    The raw plugin settings being uploaded.

  Returns Promise<void>

  A promise that resolves when the settings have been saved.