Class MediatorFunctionFactory`Abstract`

A mediator can mediate an action over a bus of actors.

It does the following:

Accepts an action in Mediator#mediate.
Sends the action to the bus to test its applicability on all actors.
It mediates over these test results.
It selects the best actor.
The action is run by the best actor, and the result if returned.

The mediates and best parts are filled in by subclasses of this abstract Mediator class.

Hierarchy (View Summary)

Mediator<
    Actor<IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput>,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
>
- MediatorFunctionFactory

Index

Constructors

`Protected`constructor

new MediatorFunctionFactory(
    args: IMediatorArgs<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >,
): MediatorFunctionFactory
All enumerable properties from the args object are inherited to this mediator.
Parameters
- args: IMediatorArgs<
      Actor<
          IActionFunctionFactory,
          IActorTest,
          IActorFunctionFactoryOutput,
          undefined,
      >,
      IActionFunctionFactory,
      IActorTest,
      IActorFunctionFactoryOutput,
      undefined,
  >
  Arguments object
  - bus: Bus<A, I, T, O, TS>
    The bus this mediator will mediate over.
  - name: string
    The name for this mediator.
    Default
    {<rdf:subject>}
Returns MediatorFunctionFactory
Throws
When required arguments are missing.
Inherited from Mediator.constructor
- Defined in core/lib/Mediator.ts:42

Properties

`Readonly`bus

bus: Bus<
    Actor<
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    undefined,
>

The bus this mediator will mediate over.

`Abstract`mediate

mediate: <T extends IActionFunctionFactory>(
    action: T,
) => Promise<
    T extends { requireTermExpression: true }
        ? IActorFunctionFactoryOutputTerm
        : IActorFunctionFactoryOutput,
>

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.

Type declaration

- <T extends IActionFunctionFactory>(
      action: T,
  ): Promise<
      T extends { requireTermExpression: true }
          ? IActorFunctionFactoryOutputTerm
          : IActorFunctionFactoryOutput,
  >
- Type Parameters
  - T extends IActionFunctionFactory
  Parameters
  - action: T
    The action to mediate for.
  Returns Promise<
      T extends { requireTermExpression: true }
          ? IActorFunctionFactoryOutputTerm
          : IActorFunctionFactoryOutput,
  >
  A promise that resolves to the mediation result.

`Readonly`name

name: string

The name for this mediator.

Default

{<rdf:subject>}

Methods

`Protected`constructFailureMessage

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

mediateActor

mediateActor(
    action: IActionFunctionFactory,
): Promise<
    TestResult<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        undefined,
    >,
>
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: IActionFunctionFactory
  The action to mediate for.
Returns Promise<
    TestResult<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        undefined,
    >,
>
A promise that resolves to the best actor.
Inherited from Mediator.mediateActor
- Defined in core/lib/Mediator.ts:74

mediateTestable

mediateTestable(
action: IActionFunctionFactory,
): Promise<TestResult<IActorFunctionFactoryOutput, undefined>>
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: IActionFunctionFactory
  The action to mediate for.
Returns Promise<TestResult<IActorFunctionFactoryOutput, undefined>>
A promise that resolves to the mediation result.
Inherited from Mediator.mediateTestable
- Defined in core/lib/Mediator.ts:89

`Protected` `Abstract`mediateWith

mediateWith(
    action: IActionFunctionFactory,
    testResults: IActorReply<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >[],
): Promise<
    TestResult<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        undefined,
    >,
>
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.
Parameters
- action: IActionFunctionFactory
  The action to mediate for.
- testResults: IActorReply<
      Actor<
          IActionFunctionFactory,
          IActorTest,
          IActorFunctionFactoryOutput,
          undefined,
      >,
      IActionFunctionFactory,
      IActorTest,
      IActorFunctionFactoryOutput,
      undefined,
  >[]
  The actor test results for the action.
Returns Promise<
    TestResult<
        Actor<
            IActionFunctionFactory,
            IActorTest,
            IActorFunctionFactoryOutput,
            undefined,
        >,
        undefined,
    >,
>
A promise that resolves to the best actor.
Inherited from Mediator.mediateWith
- Defined in core/lib/Mediator.ts:121

publish

publish(
    action: IActionFunctionFactory,
): IActorReply<
    Actor<
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    undefined,
>[]
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: IActionFunctionFactory
  The action to mediate for.
Returns IActorReply<
    Actor<
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    undefined,
>[]
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 MediatorFunctionFactoryAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

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

name: string

Default

Returns MediatorFunctionFactory

Throws

Properties

Readonlybus

Abstractmediate

Type declaration

Type Parameters

Parameters

Returns Promise< T extends { requireTermExpression: true } ? IActorFunctionFactoryOutputTerm : IActorFunctionFactoryOutput,>

Readonlyname

Default

Methods

ProtectedconstructFailureMessage

Parameters

Returns string

mediateActor

Parameters

Returns Promise< TestResult< Actor< IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput, undefined, >, undefined, >,>

mediateTestable

Parameters

Returns Promise<TestResult<IActorFunctionFactoryOutput, undefined>>

Protected AbstractmediateWith

Parameters

Returns Promise< TestResult< Actor< IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput, undefined, >, undefined, >,>

publish

Parameters

Returns IActorReply< Actor< IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput, undefined, >, IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput, undefined,>[]

Protected StaticgetObjectValue

Parameters

Returns any

Settings

On This Page

Class MediatorFunctionFactory`Abstract`

`Protected`constructor

`Readonly`bus

`Abstract`mediate

Returns Promise<
T extends { requireTermExpression: true }
? IActorFunctionFactoryOutputTerm
: IActorFunctionFactoryOutput,
>

`Readonly`name

`Protected`constructFailureMessage

Returns Promise<
TestResult<
Actor<
IActionFunctionFactory,
IActorTest,
IActorFunctionFactoryOutput,
undefined,
>,
undefined,
>,
>

`Protected` `Abstract`mediateWith

Returns Promise<
TestResult<
Actor<
IActionFunctionFactory,
IActorTest,
IActorFunctionFactoryOutput,
undefined,
>,
undefined,
>,
>

Returns IActorReply<
Actor<
IActionFunctionFactory,
IActorTest,
IActorFunctionFactoryOutput,
undefined,
>,
IActionFunctionFactory,
IActorTest,
IActorFunctionFactoryOutput,
undefined,
>[]

`Protected` `Static`getObjectValue