Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SettingRegistry

The default concrete implementation of a setting registry.

Hierarchy

  • SettingRegistry

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Create a new setting registry.

    Parameters

    Returns SettingRegistry

Properties

Private _load

_load: any

Load a plugin into the registry.

Private _pluginChanged

_pluginChanged: any

Private _preload

_preload: any

Preload a list of plugins and fail gracefully.

Private _ready

_ready: any

Private _save

_save: any

Save a plugin in the registry.

Private _timeout

_timeout: any

Private _transform

_transform: any

Transform the plugin if necessary.

Private _transformers

_transformers: any

Private _validate

_validate: any

Validate and preload a plugin, compose the composite data.

Readonly connector

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

The data connector used by the setting registry.

Readonly plugins

plugins: {}

The collection of setting registry plugins.

Type declaration

Readonly schema

schema: ISchema

The schema of the setting registry.

Readonly validator

validator: ISchemaValidator

The schema validator used by the setting registry.

Accessors

pluginChanged

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

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

    Returns ISignal<this, string>

Methods

get

  • get(plugin: string, key: string): Promise<{ composite: PartialJSONValue; user: 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: PartialJSONValue; user: PartialJSONValue }>

    A promise that resolves when the setting is retrieved.

load

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

    Parameters

    • plugin: string

      The name of the plugin whose settings are being loaded.

    Returns Promise<ISettings>

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

reload

  • 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<ISettings>

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

remove

  • remove(plugin: string, key: string): 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: string, key: string, value: JSONValue): 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: string, transforms: { compose: any; fetch: any }): 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: any; fetch: any }

      The transform functions applied to the plugin.

      • compose: function

        • Parameters

          Returns IPlugin

      • fetch: function

        • Parameters

          Returns IPlugin

    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: string, raw: string): 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.

Generated using TypeDoc