Class ServiceService

System service service

Hierarchy (View Summary)

BaseService
- ServiceService

Index

Constructors

Properties

apiClient axiosInstance

Methods

disable enable getStatus list restart start stop

Constructors

constructor

new ServiceService(apiClient: Client): ServiceService
Constructor
Parameters
- apiClient: Client
  API client
Returns ServiceService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

disable

disable(name: string, stop?: undefined | boolean): Promise<void>
Disable the service
Parameters
- name: string
  Service name
- stop: undefined | boolean = undefined
  Stop service after disabling
Returns Promise<void>
- Defined in services/ServiceService.ts:69

enable

enable(name: string, start?: undefined | boolean): Promise<void>
Enable the service
Parameters
- name: string
  Service name
- start: undefined | boolean = undefined
  Start service after enabling
Returns Promise<void>
- Defined in services/ServiceService.ts:59

getStatus

getStatus(name: string): Promise<ServiceStatus>
Retrieve the service status
Parameters
- name: string
  Service name
Returns Promise<ServiceStatus>
Service status
- Defined in services/ServiceService.ts:48

list

list(withStatus?: boolean): Promise<ServiceState[]>
Retrieve the state of supported services
Parameters
- withStatus: boolean = false
  Include service status
Returns Promise<ServiceState[]>
State of supported services
- Defined in services/ServiceService.ts:33

restart

restart(name: string): Promise<void>
Restart the service
Parameters
- name: string
  Service name
Returns Promise<void>
- Defined in services/ServiceService.ts:94

start

start(name: string): Promise<void>
Start the service
Parameters
- name: string
  Service name
Returns Promise<void>
- Defined in services/ServiceService.ts:78

stop

stop(name: string): Promise<void>
Stop the service
Parameters
- name: string
  Service name
Returns Promise<void>
- Defined in services/ServiceService.ts:86