Class CommandBus

Provide the ability to run commands either locally or on remote systems given the correct publisher.

Hierarchy

BaseBus<ICommand>
- CommandBus

Index

Constructors

Properties

_errorHandlers _handlerMap _observableFactory _publisher _sagaManager _status

Methods

execute executeLocal handleInstanceImport onApplicationBootstrap publish

Constructors

constructor

new CommandBus(explorer: Explorer, observableFactory: ObservableFactory, publisher: IPublisher<IEventLike>, _sagaManager: SagaManager): CommandBus
Parameters
- explorer: Explorer
- observableFactory: ObservableFactory
- publisher: IPublisher<IEventLike>
- _sagaManager: SagaManager
Returns CommandBus
Overrides BaseBus<ICommand>.constructor
- Defined in moirae/core/lib/busses/command.bus.ts:28

Properties

`Private` `Readonly` _errorHandlers

_errorHandlers: Map<string, IMoiraeFilter<Error>>

`Protected` _handlerMap

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

`Protected` `Readonly` _observableFactory

_observableFactory: ObservableFactory

`Protected` `Readonly` _publisher

_publisher: IPublisher<IEventLike>

`Private` `Readonly` _sagaManager

_sagaManager: SagaManager

`Protected` _status

_status: StateTracker<ESState>

Methods

execute

execute(command: ICommand): Promise<CommandResponse>
Trigger processing of a given command in one of two ways:
- If the current application can process the command, meaning the ICommand.$executionDomain property has been registered, the command will be processed asynchronously to the main thread as a Promise without interacting with external systems.
- If the current application cannot process the command, the command will be enqueued for processing via a publisher for processing externally.
In either scenario, the response from this function will contain relevant information for subscribing to events emitted by the command processing.

Returns
An object containing information about the acknowledged execution
Parameters
- command: ICommand
  
  Command to process
Returns Promise<CommandResponse>
- Defined in moirae/core/lib/busses/command.bus.ts:52

`Protected` executeLocal

executeLocal(command: ICommand): Promise<void>
Parameters
- command: ICommand
Returns Promise<void>
Overrides BaseBus.executeLocal
- Defined in moirae/core/lib/busses/command.bus.ts:63

`Protected` handleInstanceImport

handleInstanceImport(instance: any): void
Parameters
- instance: any
Returns void
Overrides BaseBus.handleInstanceImport
- Defined in moirae/core/lib/busses/command.bus.ts:83

onApplicationBootstrap

onApplicationBootstrap(): void
Returns void
Inherited from BaseBus.onApplicationBootstrap
- Defined in moirae/core/lib/classes/base.bus.ts:60

publish

publish(event: ICommand): Promise<void>
Parameters
- event: ICommand
Returns Promise<void>
Inherited from BaseBus.publish
- Defined in moirae/core/lib/classes/base.bus.ts:78

Generated using TypeDoc