Interface ConfigurationStore

Store for configurations. It is available as service with interface system.config.ConfigurationStore.

WARNING: Please do not modify the configurations manually.

interface ConfigurationStore {
    getConfig(pid: string): undefined | ConfigurationStoreEntry;
    getFactoryConfigs(factoryPid: string): ConfigurationStoreEntry[];
    on<Name extends "ConfigChanged">(
        name: Name,
        callBack: EventCallback<ConfigurationStoreEvents[Name]>,
    ): Handle;
    removeConfig(pid: string): void;
    searchConfigs(
        filter: (value: ConfigurationStoreEntry) => boolean,
    ): ConfigurationStoreEntry[];
    setConfig(pid: string, entry: Omit<ConfigurationStoreEntry, "pid">): void;
}

Hierarchy

Methods

getConfig getFactoryConfigs on removeConfig searchConfigs setConfig

Methods

getConfig

getFactoryConfigs

on

  • on<Name extends "ConfigChanged">(
        name: Name,
        callBack: EventCallback<ConfigurationStoreEvents[Name]>,
    ): Handle

  • Registers event listener.

    Type Parameters

    • Name extends "ConfigChanged"

    Parameters

    Returns Handle

removeConfig

  • removeConfig(pid: string): void

  • Removes a configuration.

    Parameters

    • pid: string

    Returns void

searchConfigs

setConfig

Settings

Member Visibility

On This Page

Methods