Interface ServiceProvider

Interface allowing a service to be provided to the CLI.

interface ServiceProvider {
    serviceId: string;
    servicePriority: number;
    getServiceInfo(cliConfig: CLIConfig): Promise<ServiceInfo>;
    initService(context: Context): Promise<void>;
}

Index

Properties

serviceId servicePriority

Methods

getServiceInfo initService

Properties

`Readonly`serviceId

serviceId: string

The ID which identifies the service provided.

`Readonly`servicePriority

servicePriority: number

Used to determine the order in which multiple service instances will be initialised. Higher values will be initialised before lower values.

Methods

getServiceInfo

getServiceInfo(cliConfig: CLIConfig): Promise<ServiceInfo>
Return ServiceInfo containing the service and any commands it provides which should be registered in the CLI.
Parameters
- cliConfig: CLIConfig
  the CLIConfig for the CLI.
Returns Promise<ServiceInfo>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/ServiceProvider.ts:40

initService

initService(context: Context): Promise<void>
Initialise the service. This will be invoked AFTER any GlobalModifierCommand provided in the ServiceInfo have been invoked (if specified as CLI arguments or CLI configuration).

NOTE: Other services within the provided context will only have been initialised if they have a higher servicePriority value than the current service.
Parameters
- context: Context
  the Context in which the CLI is running.
Returns Promise<void>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/ServiceProvider.ts:51