Interface ServiceManager

Service lifecycle manager produced by the factory.

interface ServiceManager {
    install(options?: ServiceManagerOptions): ServiceInstallResult;
    restart(options?: ServiceManagerOptions): void;
    start(options?: ServiceManagerOptions): void;
    status(options?: ServiceManagerOptions): ServiceState;
    statusDetail(options?: ServiceManagerOptions): ServiceStatus;
    stop(options?: ServiceManagerOptions): void;
    uninstall(options?: ServiceManagerOptions): void;
}

Index

Methods

install restart start status statusDetail stop uninstall

Methods

install

install(options?: ServiceManagerOptions): ServiceInstallResult
Install the service with the system service manager.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns ServiceInstallResult
- Defined in service/serviceTypes.ts:39

restart

restart(options?: ServiceManagerOptions): void
Restart the service (stop + start).
Parameters
- Optionaloptions: ServiceManagerOptions
Returns void
- Defined in service/serviceTypes.ts:47

start

start(options?: ServiceManagerOptions): void
Start the service.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns void
- Defined in service/serviceTypes.ts:43

status

status(options?: ServiceManagerOptions): ServiceState
Query the service state.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns ServiceState
- Defined in service/serviceTypes.ts:49

statusDetail

statusDetail(options?: ServiceManagerOptions): ServiceStatus
Query the service status, naming the unit and scope it was read from.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns ServiceStatus
- Defined in service/serviceTypes.ts:51

stop

stop(options?: ServiceManagerOptions): void
Stop the service.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns void
- Defined in service/serviceTypes.ts:45

uninstall

uninstall(options?: ServiceManagerOptions): void
Uninstall the service from the system service manager.
Parameters
- Optionaloptions: ServiceManagerOptions
Returns void
- Defined in service/serviceTypes.ts:41