Class BusIndexed<A, I, T, O>

A bus that indexes identified actors, so that actions with a corresponding identifier can be published more efficiently.

Multiple actors with the same identifier can be subscribed.

If actors or actions do not have a valid identifier, then this will fallback to the normal bus behaviour.

See

Bus

Type Parameters

  • A extends Actor<I, T, O, any>

    The actor type that can subscribe to the sub.

  • I extends IAction

    The input type of an actor.

  • T extends IActorTest

    The test type of an actor.

  • O extends IActorOutput

    The output type of an actor.

Hierarchy (View Summary)

Constructors

constructor

Properties

actionIdentifierFields actorIdentifierFields actors actorsIndex dependencyLinks failMessage name observers

Methods

addDependencies getActionIdentifier getActorIdentifiers onRun publish reorderForDependencies subscribe subscribeObserver unsubscribe unsubscribeObserver

Constructors

constructor

  • new BusIndexed<
        A extends Actor<I, T, O, any>,
        I extends IAction,
        T extends IActorTest,
        O extends IActorOutput,
    >(
        args: IBusIndexedArgs,
    ): BusIndexed<A, I, T, O>

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

    Type Parameters

    Parameters

    • args: IBusIndexedArgs

      Arguments object

      • actionIdentifierFields: string[]

        Keys to follow down from the action object. The value at the location following these keys should be a string or be undefined.

      • actorIdentifierFields: string[]

        Keys to follow down from the actor object. The value at the location following these keys should be a string, a string array, or undefined. If the value is a string array, all strings will be registered as keys that map to the actor.

      • name: string

        The name for this bus.

        Default

        {<rdf:subject>}

    Returns BusIndexed<A, I, T, O>

    Throws

    When required arguments are missing.

Properties

Protected ReadonlyactionIdentifierFields

actionIdentifierFields: string[]

Protected ReadonlyactorIdentifierFields

actorIdentifierFields: string[]

Protected Readonlyactors

actors: A[] = []

Protected ReadonlyactorsIndex

actorsIndex: Record<string, A[]> = {}

Protected ReadonlydependencyLinks

dependencyLinks: Map<A, A[]> = ...

failMessage

failMessage: string

Readonlyname

name: string

The name for this bus.

Default

{<rdf:subject>}

Protected Readonlyobservers

observers: ActionObserver<I, O, undefined>[] = []

Methods

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

ProtectedgetActionIdentifier

  • getActionIdentifier(action: I): string

  • Parameters

    • action: I

    Returns string

ProtectedgetActorIdentifiers

  • getActorIdentifiers(actor: A): undefined | string[]

  • Parameters

    • actor: A

    Returns undefined | string[]

onRun

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

  • Invoked when an action was run by an actor.

    Parameters

    • actor: Actor<I, T, O, undefined>

      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, undefined>[]

  • 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, undefined>[]

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

reorderForDependencies

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, undefined>): 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

    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, undefined>): boolean

  • Unsubscribe the given observer from the bus.

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

    Parameters

    Returns boolean

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods