ServiceManager | Node Service Manager

A state manager for services

Hierarchy

StatefulSystem
- ServiceManager

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ServiceManager(options?: ServiceManagerOptions): ServiceManager

Overrides StatefulSystem.constructor
- Defined in service-manager.ts:16
Constrict a service manager

Parameters
- Default value options: ServiceManagerOptions = {}
  
  The options for the service manager. By default a timeout of 30 seconds is used.
Returns ServiceManager

Accessors

previousState

previousState:

The previous state of the system

services

services:

The registered services

state

state:

The current state of the system

Methods

Protected _transition

_transition(newState: State): void

Inherited from StatefulSystem._transition
- Defined in stateful-system.ts:84
Transition the system to a new state

throws

{TransitionError} if the transition is invalid

Parameters
- newState: State
  
  The new state
Returns void

destroy

destroy(): Promise<void>

- Defined in service-manager.ts:95
Destroy the services registered in the ServiceManager

throws

{TransitionError} if the transition is invalid

Returns Promise<void>

registerService

registerService<T>(name: string, service: Service<T>): void

- Defined in service-manager.ts:40
Register a service with the ServiceManager

throws

{RegisterError} if the service manager is not in a new state

Type parameters
- T
Parameters
- name: string
  
  A unique descriptive name for the service
- service: Service<T>
  
  The service to register
Returns void

start

start(): Promise<void>

- Defined in service-manager.ts:52
Start the services registered in the ServiceManager

throws

{TransitionError} if the transition is invalid

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in service-manager.ts:73
Stop the services registered in the ServiceManager

throws

{TransitionError} if the transition is invalid

Returns Promise<void>

Generated using TypeDoc