Class: CliService
Cross-platform lifecycle manager for one system-tray user service.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CliService(
definition,options?):CliService
Create a lifecycle manager from a serializable definition.
Parameters
Section titled “Parameters”definition
Section titled “definition”Product-owned service metadata, process, and menu.
options?
Section titled “options?”Host runtime overrides.
Returns
Section titled “Returns”CliService
Properties
Section titled “Properties”definition
Section titled “definition”
readonlydefinition:CliServiceDefinition
Methods
Section titled “Methods”install()
Section titled “install()”install(
options?):Promise<void>
Install the login entry and optionally start the service.
Parameters
Section titled “Parameters”options?
Section titled “options?”offline?
Section titled “offline?”boolean = ...
pythonProject?
Section titled “pythonProject?”string = ...
start?
Section titled “start?”boolean = ...
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”logPath()
Section titled “logPath()”logPath():
string
Return the managed service process log path.
Returns
Section titled “Returns”string
Implementation of
Section titled “Implementation of”restart()
Section titled “restart()”restart():
Promise<void>
Stop and start the installed service.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”start()
Section titled “start()”start():
Promise<void>
Start the installed service when it is not already running.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”status()
Section titled “status()”status():
Promise<CliServiceStatus>
Read the current installation and process state.
Returns
Section titled “Returns”Promise<CliServiceStatus>
Implementation of
Section titled “Implementation of”stop()
Section titled “stop()”stop():
Promise<void>
Stop the running tray host and its managed child process.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”uninstall()
Section titled “uninstall()”uninstall():
Promise<void>
Stop the service and remove its login entry and package-owned state.
Returns
Section titled “Returns”Promise<void>