Interface MessageSubscription<Msg, HandlerOpts>

A message subscription service.

interface MessageSubscription {
subscribe(handler, options?): MaybePromise<Unsubscribe>;
}

Type Parameters

Msg
HandlerOpts = object

Hierarchy

MessageSubscription
- MessageBus

Index

Methods

Methods

subscribe

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

Generated using TypeDoc