ServiceWrapper | Node Service Manager

A wrapper for a Service

Type parameters

T

Hierarchy

StatefulSystem
- ServiceWrapper

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ServiceWrapper(name: string, service: Service<T>): ServiceWrapper

Overrides StatefulSystem.constructor
- Defined in service-wrapper.ts:17
Construct a ServiceWrapper for a service and a name

Parameters
- name: string
  
  A unique descriptive name for the service
- service: Service<T>
  
  The service to wrap
Returns ServiceWrapper

Accessors

name

name:

The service name

previousState

previousState:

The previous state of the system

result

result:

The last transition's result

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(timeout: number): Promise<void>

- Defined in service-wrapper.ts:87
Destroy a service

throws

{TransitionError} if the transition is invalid

Parameters
- timeout: number
  
  The time to elapse in milliseconds before the destroy call is considered to have failed
Returns Promise<void>

start

start(timeout: number): Promise<void>

- Defined in service-wrapper.ts:46
Start the service

throws

{TransitionError} if the transition is invalid

Parameters
- timeout: number
  
  The time to elapse in milliseconds before the start call is considered to have failed
Returns Promise<void>

stop

stop(timeout: number): Promise<void>

- Defined in service-wrapper.ts:65
Stop a service

throws

{TransitionError} if the transition is invalid

Parameters
- timeout: number
  
  The time to elapse in milliseconds before the stop call is considered to have failed
Returns Promise<void>

Generated using TypeDoc