Class QueryBus

Hierarchy

  • QueryBus
    • QueryBus

Constructors

constructor

Properties

_handlerMap _observableFactory _publisher _status container

Methods

execute executeLocal handleInstanceImport onApplicationBootstrap publish

Constructors

constructor

  • Parameters

    • container: Container
    • observableFactory: ObservableFactory
    • publisher: IPublisher<IEventLike>

    Returns QueryBus

Properties

Protected _handlerMap

_handlerMap: Map<string, IHandler<IQuery, unknown>>

Protected Readonly _observableFactory

_observableFactory: ObservableFactory

Protected Readonly _publisher

_publisher: IPublisher<IEventLike>

Protected _status

_status: StateTracker<ESState>

Private Readonly container

container: Container

Methods

execute

  • Trigger processing of a given query in one of two ways:

    • If the current application can process the query, meaning the IQuery.$executionDomain property has been registered, the query will be processed synchronously to the main thread and returned.
    • If the current application cannot process the query, the query will be enqueued for processing via a publisher for processing externally and a the results awaited for return.

    Type Parameters

    • TRes

    Parameters

    • query: IQuery

      Query to be processed

    • Optional options: ExecuteOptions

    Returns Promise<TRes>

Protected executeLocal

  • Internal

    Should not be used outside of the context of the library

    Parameters

    • event: IQuery
    • options: Record<string, unknown>

    Returns Promise<unknown>

Protected handleInstanceImport

  • Parameters

    • instance: any

    Returns void

onApplicationBootstrap

publish

  • Parameters

    • event: IQuery

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc