Interface ComponentInstanceFactory<ServiceType>

Interface which must be implemented by an component implementation when the flag instanceFactory is set to true. Then the component is a factory which creates a service implementation.

interface ComponentInstanceFactory<ServiceType> {
createInstance(): ServiceType;
destroyInstance?(instance): void | Promise<void>;
}

Type Parameters

ServiceType extends ServiceInstance = ServiceInstance

Index

Methods

createInstance destroyInstance?

Methods

createInstance

createInstance(): ServiceType
Creates a new service instance. The returned service instance is registered as a service at the app runtime.

Returns ServiceType
- Defined in apprt/api/index.ts:1715

`Optional` destroyInstance

destroyInstance(instance): void | Promise<void>
Cleans up the service instance during shutdown.
Parameters
- instance: ServiceType
Returns void | Promise<void>
- Defined in apprt/api/index.ts:1719

Generated using TypeDoc