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

EventSource<ConfigurationStoreEvents>
- ConfigurationStore

Index

Methods

getConfig getFactoryConfigs on removeConfig searchConfigs setConfig

Methods

getConfig

getConfig(pid: string): undefined | ConfigurationStoreEntry
Read a configuration.
Parameters
- pid: string
Returns undefined | ConfigurationStoreEntry
- Defined in apprt/api/index.ts:2432

getFactoryConfigs

getFactoryConfigs(factoryPid: string): ConfigurationStoreEntry[]
Read configurations by factory pid.
Parameters
- factoryPid: string
Returns ConfigurationStoreEntry[]
- Defined in apprt/api/index.ts:2437

on

on<Name extends "ConfigChanged">(
name: Name,
callBack: EventCallback<ConfigurationStoreEvents[Name]>,
): Handle
Registers event listener.
Type Parameters
- Name extends "ConfigChanged"
Parameters
- name: Name
- callBack: EventCallback<ConfigurationStoreEvents[Name]>
Returns Handle
Inherited from EventSource.on
- Defined in apprt-core/Types.ts:85

removeConfig

removeConfig(pid: string): void
Removes a configuration.
Parameters
- pid: string
Returns void
- Defined in apprt/api/index.ts:2442

searchConfigs

searchConfigs(
filter: (value: ConfigurationStoreEntry) => boolean,
): ConfigurationStoreEntry[]
Search available configs.
Parameters
- filter: (value: ConfigurationStoreEntry) => boolean
Returns ConfigurationStoreEntry[]
- Defined in apprt/api/index.ts:2427

setConfig

setConfig(pid: string, entry: Omit<ConfigurationStoreEntry, "pid">): void
Writes a new configuration.
Parameters
- pid: string
- entry: Omit<ConfigurationStoreEntry, "pid">
Returns void
- Defined in apprt/api/index.ts:2447