Class MediatorCombineUnion<A, I, T, O, TS>

A comunica mediator that takes the union of all actor results.

The actors that are registered first will have priority on setting overlapping fields.

Type Parameters

A extends Actor<I, T, O, TS>
I extends IAction
T extends IActorTest
O extends IActorOutput
TS = undefined

Hierarchy (View Summary)

Mediator<A, I, T, O, TS>
- MediatorCombineUnion

Implements

IMediatorCombineUnionArgs<A, I, T, O, TS>

Index

Constructors

constructor

new MediatorCombineUnion<
    A extends Actor<I, T, O, TS>,
    I extends IAction,
    T extends IActorTest,
    O extends IActorOutput,
    TS = undefined,
>(
    args: IMediatorCombineUnionArgs<A, I, T, O, TS>,
): MediatorCombineUnion<A, I, T, O, TS>
Type Parameters
- A extends Actor<I, T, O, TS>
- I extends IAction
- T extends IActorTest
- O extends IActorOutput
- TS = undefined
Parameters
- args: IMediatorCombineUnionArgs<A, I, T, O, TS>
Returns MediatorCombineUnion<A, I, T, O, TS>
Overrides Mediator.constructor
- Defined in mediator-combine-union/lib/MediatorCombineUnion.ts:22

Properties

`Readonly`bus

bus: Bus<A, I, T, O, TS>

The bus this mediator will mediate over.

`Readonly`combiner

combiner: (results: O[]) => O

`Readonly`field

field: string

The field name of the test result field over which must be mediated.

`Readonly`filterFailures

filterFailures: undefined | boolean

If actors that throw test errors should be ignored

`Readonly`name

name: string

The name for this mediator.

Default

{<rdf:subject>}

Methods

`Protected`constructFailureMessage

constructFailureMessage(action: I, actorFailures: string[]): string
Protected
Construct a human-friendly failure message that accumulates the given actors's failure messages.
Parameters
- action: I
  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

`Protected`createCombiner

createCombiner(): (results: O[]) => O
Returns (results: O[]) => O
- Defined in mediator-combine-union/lib/MediatorCombineUnion.ts:67

mediate

mediate(action: I): Promise<O>
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: I
  The action to mediate for.
Returns Promise<O>
A promise that resolves to the mediation result.
Overrides Mediator.mediate
- Defined in mediator-combine-union/lib/MediatorCombineUnion.ts:27

mediateActor

mediateActor(action: I): 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: I
  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: I): Promise<TestResult<O, 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: I
  The action to mediate for.
Returns Promise<TestResult<O, 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<any, 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<any, TS>>
A promise that resolves to the best actor.
Overrides Mediator.mediateWith
- Defined in mediator-combine-union/lib/MediatorCombineUnion.ts:63

publish

publish(action: I): IActorReply<A, I, T, O, 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: I
  The action to mediate for.
Returns IActorReply<A, I, T, O, 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 MediatorCombineUnion<A, I, T, O, TS>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MediatorCombineUnion<A, I, T, O, TS>

Properties

Readonlybus

Readonlycombiner

Readonlyfield

ReadonlyfilterFailures

Readonlyname

Default

Methods

ProtectedconstructFailureMessage

Parameters

Returns string

ProtectedcreateCombiner

Returns (results: O[]) => O

mediate

Parameters

Returns Promise<O>

mediateActor

Parameters

Returns Promise<TestResult<A, TS>>

mediateTestable

Parameters

Returns Promise<TestResult<O, TS>>

ProtectedmediateWith

Returns Promise<TestResult<any, TS>>

publish

Parameters

Returns IActorReply<A, I, T, O, TS>[]

Protected StaticgetObjectValue

Parameters

Returns any

Settings

On This Page

`Readonly`bus

`Readonly`combiner

`Readonly`field

`Readonly`filterFailures

`Readonly`name

`Protected`constructFailureMessage

`Protected`createCombiner

`Protected`mediateWith

`Protected` `Static`getObjectValue