Interface ComponentInstance<InstanceType>

Components are instances of JavaScript objects that are created and managed by the app runtime as needed.

interface ComponentInstance<InstanceType extends ServiceInstance> {
dispose(): void;
getInstance(): undefined | InstanceType;
}

Type Parameters

InstanceType extends ServiceInstance

Index

Methods

dispose getInstance

Methods

dispose

dispose(): void
Dispose of the component configuration for this component instance. The component configuration will be deactivated. If the component configuration has already been deactivated, this method does nothing.

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

getInstance

getInstance(): undefined | InstanceType
Returns the component instance of the activated component configuration.

Returns undefined | InstanceType
The component instance or undefined if the component configuration has been deactivated.
- Defined in apprt/api/index.ts:1541