Interface ISettingRegistry

The settings registry interface.

interface ISettingRegistry {
    connector: IDataConnector<IPlugin, string, string, string>;
    pluginChanged: ISignal<ISettingRegistry, string>;
    plugins: {
        [name: string]: IPlugin | undefined;
    };
    schema: ISchema;
    validator: ISchemaValidator;
    get(plugin, key): Promise<{
        composite: undefined | PartialJSONValue;
        user: undefined | PartialJSONValue;
    }>;
    load(plugin, forceTransform?): Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>;
    reload(plugin): Promise<ISettingRegistry.ISettings<ReadonlyPartialJSONObject>>;
    remove(plugin, key): Promise<void>;
    set(plugin, key, value): Promise<void>;
    transform(plugin, transforms): IDisposable;
    upload(plugin, raw): Promise<void>;
}

Implemented by

Properties

connector pluginChanged plugins schema validator

Methods

get load reload remove set transform upload

Properties

Readonly connector

connector: IDataConnector<IPlugin, string, string, string>

The data connector used by the setting registry.

Readonly pluginChanged

pluginChanged: ISignal<ISettingRegistry, string>

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

Readonly plugins

plugins: {
    [name: string]: IPlugin | undefined;
}

The collection of setting registry plugins.

Type declaration

  • [name: string]: IPlugin | undefined

Readonly schema

schema: ISchema

The schema of the setting registry.

Readonly validator

validator: ISchemaValidator

The schema validator used by the setting registry.

Methods

get

load

reload

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: PartialJSONValue

      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.

    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.

Settings

Member Visibility

Theme

On This Page

connectorpluginChangedpluginsschemavalidatorgetloadreloadremovesettransformupload