Class Runner

A Runner is used to instantiate a comunica workflow.

It is instantiated dynamically using a Components.js config file. A bus and a list of actors are injected into this runner dynamically.

The Runner#run function must be called to instantiate the workflow.

Index

Constructors

Properties

Methods

collectActors run

Constructors

constructor

new Runner(
    busInit: Bus<
        Actor<IAction, IActorTest, IActorOutput, any>,
        IAction,
        IActorTest,
        IActorOutput,
        any,
    >,
    actors: Actor<IAction, IActorTest, IActorOutput, any>[],
): Runner
Parameters
- busInit: Bus<
      Actor<IAction, IActorTest, IActorOutput, any>,
      IAction,
      IActorTest,
      IActorOutput,
      any,
  >
  The 'init' event bus.
- actors: Actor<IAction, IActorTest, IActorOutput, any>[]
  The list of all actors that are part of the comunica workflow.
Returns Runner
Default
```
{<npmd:@comunica/bus-init/^4.0.0/components/ActorInit.jsonld#ActorInit_default_bus>}
```
- Defined in Runner.ts:18

Properties

`Readonly`actors

actors: Actor<IAction, IActorTest, IActorOutput, any>[]

The list of all actors that are part of the comunica workflow.

`Readonly`busInit

busInit: Bus<
    Actor<IAction, IActorTest, IActorOutput, any>,
    IAction,
    IActorTest,
    IActorOutput,
    any,
>

The 'init' event bus.

Methods

collectActors

collectActors(
actorIdentifiers: Record<string, string>,
): Record<string, Actor<IAction, IActorTest, IActorOutput, any>>
Collect the given actors that are available in this runner.

Example:
```
  const { engine } = runner.collectActors({ engine: 'urn:comunica:default:init/actors#query' };
  // engine is an actor instance
```
An error will be thrown if any of the actors could not be found in the runner.
Parameters
- actorIdentifiers: Record<string, string>
  A mapping of keys to actor identifiers.
Returns Record<string, Actor<IAction, IActorTest, IActorOutput, any>>
A mapping of keys to actor instances.
- Defined in Runner.ts:58

run

run(action: IActionInit): Promise<IActorOutputInit[]>
Run a comunica workflow.
Parameters
- action: IActionInit
  An 'init' action.
Returns Promise<IActorOutputInit[]>
A promise that resolves when the init actors are triggered.
- Defined in Runner.ts:37