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

constructor

• new Bus<
      A extends Actor<I, T, O, TS>,
      I extends IAction,
      T extends IActorTest,
      O extends IActorOutput,
      TS = undefined,
  >(
      args: IBusArgs,
  ): Bus<A, I, T, O, TS>

• All enumerable properties from the args object are inherited to this bus.

  Type Parameters

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

  Parameters

  • args: IBusArgs

    Arguments object

    • name: string

      The name for this bus.

      Default

      {<rdf:subject>}
      Copy

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

  Throws

  When required arguments are missing.

failMessage

Readonlyname

{<rdf:subject>}
Copy

addDependencies

• addDependencies(dependent: A, dependencies: A[]): void

• Indicate that the given actor has the given actor dependencies.

  This will ensure that the given actor will be present in the bus before the given dependencies.

  Parameters

  • dependent: A

    A dependent actor that will be placed before the given actors.
  • dependencies: A[]

    Actor dependencies that will be placed after the given actor.

  Returns void

onRun

• onRun(actor: Actor<I, T, O, TS>, action: I, output: Promise<O>): void

• Invoked when an action was run by an actor.

  Parameters

  • actor: Actor<I, T, 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

publish

• publish(action: I): IActorReply<A, I, T, O, TS>[]

• Publish an action to all actors in the bus to test if they can run the action.

  Parameters

  • action: I

    An action to publish

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

  An array of reply objects. Each object contains a reference to the actor, and a promise to its Actor#test result.

reorderForDependencies

• reorderForDependencies(): void

• Reorder the bus based on all present dependencies.

  Returns void

subscribe

• subscribe(actor: A): void

• Subscribe the given actor to the bus. After this, the given actor can be unsubscribed from the bus by calling Bus#unsubscribe.

  An actor that is subscribed multiple times will exist that amount of times in the bus.

  Parameters

  • actor: A

    The actor to subscribe.

  Returns void

subscribeObserver

• subscribeObserver(observer: ActionObserver<I, O, TS>): void

• Subscribe the given observer to the bus. After this, the given observer can be unsubscribed from the bus by calling Bus#unsubscribeObserver.

  An observer that is subscribed multiple times will exist that amount of times in the bus.

  Parameters

  • observer: ActionObserver<I, O, TS>

    The observer to subscribe.

  Returns void

unsubscribe

• unsubscribe(actor: A): boolean

• Unsubscribe the given actor from the bus.

  An actor that is subscribed multiple times will be unsubscribed only once.

  Parameters

  • actor: A

    The actor to unsubscribe

  Returns boolean

  If the given actor was successfully unsubscribed, otherwise it was not subscribed before.

unsubscribeObserver

• unsubscribeObserver(observer: ActionObserver<I, O, TS>): boolean

• Unsubscribe the given observer from the bus.

  An observer that is subscribed multiple times will be unsubscribed only once.

  Parameters

  • observer: ActionObserver<I, O, TS>

    The observer to unsubscribe.

  Returns boolean

  If the given observer was successfully unsubscribed, otherwise it was not subscribed before.