Class Controller

Action controller

Hierarchy

Controller

Index

Methods

eventCanceled eventCompleted eventFailed eventPending eventRunning eventTerminated

Methods

eventCanceled

eventCanceled(action): Promise<void>
Notify the bus about action canceled event
Parameters
- action: Action
  action to notify about
Returns Promise<void>
- Defined in src/controller.ts:140

eventCompleted

eventCompleted(action, out?): Promise<void>
Notify the bus about action completed event
Parameters
- action: Action
  action to notify about
- Optional out: any
  output result
Returns Promise<void>
- Defined in src/controller.ts:98

eventFailed

eventFailed(action, out?, err?, exitcode?): Promise<void>
Notify the bus about action failed event
Parameters
- action: Action
  action to notify about
- Optional out: any
  output result
- Optional err: any
  error message
- Optional exitcode: number
  exit code (default: -1)
Returns Promise<void>
- Defined in src/controller.ts:118

eventPending

eventPending(action): Promise<void>
Notify the bus about action pending event
Parameters
- action: Action
  action to notify about
Returns Promise<void>
- Defined in src/controller.ts:75

eventRunning

eventRunning(action): Promise<void>
Notify the bus about action running event
Parameters
- action: Action
  action to notify about
Returns Promise<void>
- Defined in src/controller.ts:86

eventTerminated

eventTerminated(action): Promise<void>
Notify the bus about action terminated event
Parameters
- action: Action
  action to notify about
Returns Promise<void>
- Defined in src/controller.ts:151

Generated using TypeDoc