Interface MessageBus<OutMsg, InMsg, SubHandlerOpts>

A generalized message bus service interface, which can represent publish/subscribe service, message queue or any producer-consumer model.

interface MessageBus {
dispatch(message, options?): MaybePromise<void>;
subscribe(handler, options?): MaybePromise<Unsubscribe>;
}

Type Parameters

OutMsg
InMsg = OutMsg
SubHandlerOpts = object

Hierarchy

MessageDispatcher<OutMsg>
MessageSubscription<InMsg, SubHandlerOpts>
- MessageBus
  - PeerAwareMessageBus

Implemented by

Index

Methods

dispatch subscribe

Methods

dispatch

dispatch(message, options?): MaybePromise<void>
Dispatches a message.
Parameters
- message: OutMsg
- Optional options: MessageOptions
Returns MaybePromise<void>
Inherited from MessageDispatcher.dispatch
- Defined in packages/messaging/src/messaging.ts:14

subscribe

subscribe(handler, options?): MaybePromise<Unsubscribe>
Subscribes to new messages and returns a handle to unsubscribe.
Parameters
- handler: MessageHandler<InMsg, SubHandlerOpts>
- Optional options: SubscribeOptions<InMsg, SubHandlerOpts>
Returns MaybePromise<Unsubscribe>
Inherited from MessageSubscription.subscribe
- Defined in packages/messaging/src/messaging.ts:20

Generated using TypeDoc