Class ActionObserver<I, O, TS>`Abstract`

An ActionObserver can passively listen to Actor#run inputs and outputs for all actors on a certain bus.

ActionObserver should not edit inputs and outputs, they should be considered immutable.

See

Actor
Bus

Type Parameters

I extends IAction
The input type of an actor.
O extends IActorOutput
The output type of an actor.
TS = undefined
The test side data type.

Hierarchy (View Summary)

ActionObserver
- ActionObserverHttp
- ActionObserverHttp

Index

Constructors

Properties

Methods

Constructors

`Protected`constructor

new ActionObserver<I extends IAction, O extends IActorOutput, TS = undefined>(
args: IActionObserverArgs<I, O>,
): ActionObserver<I, O, TS>
All enumerable properties from the args object are inherited to this observer.

The observer will NOT automatically subscribe to the given bus when this constructor is called.
Type Parameters
- I extends IAction
- O extends IActorOutput
- TS = undefined
Parameters
- args: IActionObserverArgs<I, O>
  Arguments object
Returns ActionObserver<I, O, TS>
Throws
When required arguments are missing.
- Defined in ActionObserver.ts:29

Properties

`Readonly`bus

bus: Bus<Actor<I, IActorTest, O, TS>, I, IActorTest, O, TS>

`Readonly`name

name: string

Methods

`Abstract`onRun

onRun(actor: Actor<I, IActorTest, O, TS>, action: I, output: Promise<O>): void
Invoked when an action was run by an actor.
Parameters
- actor: Actor<I, IActorTest, O, TS>
  The action on which the Actor#run method was invoked.
- action: I
  The original action input.
- output: Promise<O>
  A promise resolving to the final action output.
Returns void
- Defined in ActionObserver.ts:40