Interface IPublisher<Evt>

Publishers provide the interface between the underlying event system and the bus. This defines the interactions the bus has with the publisher.

Type Parameters

Evt = IEventLike

Hierarchy

IPublisher

Implemented by

MemoryPublisher

Index

Properties

Methods

awaitResponse listen publish subscribe unsubscribe

Properties

role

role: PublisherToken

Define the role of the publisher within the application. Set via the using class

Methods

awaitResponse

awaitResponse(responseKey: string): Promise<ResponseWrapper<unknown>>
Await the response from a remote system
Parameters
- responseKey: string
Returns Promise<ResponseWrapper<unknown>>
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:13

listen

listen(handlerFn: ((event: Evt) => void)): string
Listen to the bus asynchronously but without triggering event acknowledgement. Will only be called for events processed by this node.
Parameters
- handlerFn: ((event: Evt) => void)
  - - (event: Evt): void
    - Parameters
      
      event: Evt
      
      Returns void
Returns string
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:19

publish

publish(event: Evt): Promise<void>
Publish a new event to the bus and remote systems
Parameters
- event: Evt
Returns Promise<void>
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:23

subscribe

subscribe(handlerFn: ((event: Evt) => void)): string
Subscribe to the bus. Should only be called ONCE by the relevant bus as will trigger acknowledgements.
Parameters
- handlerFn: ((event: Evt) => void)
  - - (event: Evt): void
    - Parameters
      
      event: Evt
      
      Returns void
Returns string
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:32

unsubscribe

unsubscribe(key: string): void
Unsubscribe from the bus
Parameters
- key: string
Returns void
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:36

Generated using TypeDoc