Interface IPubSubHub

A simple pub/sub component.

interface IPubSubHub {
    publish(topic: string, message: MessageData): void;
    subscribe(topic: string, handler: MessageHandler): null | string;
    unsubscribe(subscriptionId: string): void;
}

Implemented by

PubSubHub

Index

Methods

publish subscribe unsubscribe

Methods

publish

publish(topic: string, message: MessageData): void
Publish a message to a topic.
Parameters
- topic: string
  The topic to publish to.
- message: MessageData
  The message to publish.
Returns void
- Defined in src/pubsub/contracts.ts:28

subscribe(topic: string, handler: MessageHandler): null | string
Subscribe to a topic.
Parameters
- topic: string
  The topic to subscribe to.
- handler: MessageHandler
  The handler to call when a message is published.
Returns null | string
The id of the handler subscription if the subscription is successful.
- Defined in src/pubsub/contracts.ts:36

unsubscribe

unsubscribe(subscriptionId: string): void
Unsubscribe from a topic.
Parameters
- subscriptionId: string
  The subscription id to unsubscribe.
Returns void
- Defined in src/pubsub/contracts.ts:43