Class MediatorCombinePipeline<A, H, T, TS>

A comunica mediator that goes over all actors in sequence and forwards I/O. This required the action input and the actor output to be of the same type.

Type Parameters

A extends Actor<H, T, H, TS>
H extends IAction | IActorOutput & { context: IActionContext }
T extends IActorTest
TS = undefined

Hierarchy (View Summary)

Mediator<A, H, T, H, TS>
- MediatorCombinePipeline

Index

Constructors

constructor

new MediatorCombinePipeline<
    A extends Actor<H, T, H, TS>,
    H extends IAction | IActorOutput & { context: IActionContext },
    T extends IActorTest,
    TS = undefined,
>(
    args: IMediatorCombinePipelineArgs<A, H, T, H, TS>,
): MediatorCombinePipeline<A, H, T, TS>
Type Parameters
- A extends Actor<H, T, H, TS>
- H extends IAction | IActorOutput & { context: IActionContext }
- T extends IActorTest
- TS = undefined
Parameters
- args: IMediatorCombinePipelineArgs<A, H, T, H, TS>
Returns MediatorCombinePipeline<A, H, T, TS>
Overrides Mediator.constructor
- Defined in mediator-combine-pipeline/lib/MediatorCombinePipeline.ts:20

Properties

`Readonly`bus

bus: Bus<A, H, T, H, TS>

The bus this mediator will mediate over.

`Readonly`field

field: undefined | string

`Readonly`filterFailures

filterFailures: undefined | boolean

`Readonly`name

name: string

The name for this mediator.

Default

{<rdf:subject>}

`Readonly`order

order: undefined | "increasing" | "decreasing"

Methods

`Protected`constructFailureMessage

constructFailureMessage(action: H, actorFailures: string[]): string
Protected
Construct a human-friendly failure message that accumulates the given actors's failure messages.
Parameters
- action: H
  The action that was executed.
- actorFailures: string[]
  The failure messages that were collected from actor tests based on the given executed action.
Returns string
Inherited from Mediator.constructFailureMessage
- Defined in core/lib/Mediator.ts:129

mediate

mediate(action: H): Promise<H>
Mediate for the given action.

This will send the test action on all actors in the bus. The action will be run on the actor that tests best, of which the result will be returned.
Parameters
- action: H
  The action to mediate for.
Returns Promise<H>
A promise that resolves to the mediation result.
Overrides Mediator.mediate
- Defined in mediator-combine-pipeline/lib/MediatorCombinePipeline.ts:24

mediateActor

mediateActor(action: H): Promise<TestResult<A, TS>>
Mediate for the given action to get an actor.

This will send the test action on all actors in the bus. The actor that tests best will be returned.
Parameters
- action: H
  The action to mediate for.
Returns Promise<TestResult<A, TS>>
A promise that resolves to the best actor.
Inherited from Mediator.mediateActor
- Defined in core/lib/Mediator.ts:74

mediateTestable

mediateTestable(action: H): Promise<TestResult<H, TS>>
Mediate for the given action.

This will send the test action on all actors in the bus. The action will be run on the actor that tests best, of which the result will be returned.
Parameters
- action: H
  The action to mediate for.
Returns Promise<TestResult<H, TS>>
A promise that resolves to the mediation result.
Inherited from Mediator.mediateTestable
- Defined in core/lib/Mediator.ts:89

`Protected`mediateWith

mediateWith(): Promise<TestResult<A, TS>>
Mediate for the given action with the given actor test results for the action.

One actor must be returned that provided the best test result. How 'best' is interpreted, depends on the implementation of the Mediator.

Returns Promise<TestResult<A, TS>>
A promise that resolves to the best actor.
Overrides Mediator.mediateWith
- Defined in mediator-combine-pipeline/lib/MediatorCombinePipeline.ts:90

publish

publish(action: H): IActorReply<A, H, T, H, TS>[]
Publish the given action in the bus.

This will send the test action on all actors in the bus. All actor replies will be returned.
Parameters
- action: H
  The action to mediate for.
Returns IActorReply<A, H, T, H, TS>[]
The list of actor replies.
Inherited from Mediator.publish
- Defined in core/lib/Mediator.ts:56

`Protected` `Static`getObjectValue

getObjectValue(obj: any, path: string[]): any
Parameters
- obj: any
- path: string[]
Returns any
Inherited from Mediator.getObjectValue
- Defined in core/lib/Mediator.ts:137

Class MediatorCombinePipeline<A, H, T, TS>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MediatorCombinePipeline<A, H, T, TS>

Properties

Readonlybus

Readonlyfield

ReadonlyfilterFailures

Readonlyname

Default

Readonlyorder

Methods

ProtectedconstructFailureMessage

Parameters

Returns string

mediate

Parameters

Returns Promise<H>

mediateActor

Parameters

Returns Promise<TestResult<A, TS>>

mediateTestable

Parameters

Returns Promise<TestResult<H, TS>>

ProtectedmediateWith

Returns Promise<TestResult<A, TS>>

publish

Parameters

Returns IActorReply<A, H, T, H, TS>[]

Protected StaticgetObjectValue

Parameters

Returns any

Settings

On This Page

`Readonly`bus

`Readonly`field

`Readonly`filterFailures

`Readonly`name

`Readonly`order

`Protected`constructFailureMessage

`Protected`mediateWith

`Protected` `Static`getObjectValue