Interface Configuration

Component configuration.

interface Configuration {
    factoryPid: undefined | string;
    get(key: string): any;
    pid: string;
    properties: ComponentProperties;
    remove(): void;
    update(properties: ComponentProperties): void;
}

Index

Properties

factoryPid pid properties

Methods

get remove update

Properties

`Readonly`factoryPid

factoryPid: undefined | string

Persistent identifier of a factory component.

`Readonly`pid

pid: string

Persistent identifier.

`Readonly`properties

properties: ComponentProperties

Configuration properties.

Methods

get

get(key: string): any
Parameters
- key: string
Returns any
Deprecated
use flat properties, e.g. pid or properties directly.
- Defined in apprt/api/index.ts:2337

remove

remove(): void
Removes this configuration.

Returns void
- Defined in apprt/api/index.ts:2347

update

update(properties: ComponentProperties): void
Used to update the configuration.
Parameters
- properties: ComponentProperties
Returns void
- Defined in apprt/api/index.ts:2342