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): undefined | ConfigurationStoreEntry;
    getFactoryConfigs(factoryPid): ConfigurationStoreEntry[];
    on<Name>(name, callBack): Handle;
    removeConfig(pid): void;
    searchConfigs(filter): ConfigurationStoreEntry[];
    setConfig(pid, entry): void;
}

Hierarchy

EventSource<ConfigurationStoreEvents>
- ConfigurationStore

Index

Methods

getConfig getFactoryConfigs on removeConfig searchConfigs setConfig

Methods

getConfig

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

getFactoryConfigs

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

on

on<Name>(name, callBack): 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): void
Removes a configuration.
Parameters
- pid: string
Returns void
- Defined in apprt/api/index.ts:2441

searchConfigs

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

setConfig

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

Generated using TypeDoc