Class ImagePrinterServiceProvider

Interface allowing a service to be provided to the CLI.

Implements

ServiceProvider

Index

Constructors

Properties

serviceId servicePriority

Methods

getServiceInfo initService

Constructors

constructor

new ImagePrinterServiceProvider(
servicePriority: number,
terminal: Terminal,
): ImagePrinterServiceProvider
Parameters
- servicePriority: number
- terminal: Terminal
Returns ImagePrinterServiceProvider
- Defined in src/service/imagePrinter/ImagePrinterServiceProvider.ts:12

Properties

`Readonly`serviceId

serviceId: string = IMAGE_PRINTER_SERVICE_ID

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
Returns Promise<ServiceInfo>
Implementation of ServiceProvider.getServiceInfo
- Defined in src/service/imagePrinter/ImagePrinterServiceProvider.ts:19

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
Returns Promise<void>
Implementation of ServiceProvider.initService
- Defined in src/service/imagePrinter/ImagePrinterServiceProvider.ts:26