Class PubSubHub

A PubSub implementation.

Implements

IPubSubHub

Index

Constructors

Methods

[dispose] publish subscribe unsubscribe

Constructors

constructor

new PubSubHub(options?: PubSubHubOptions): PubSubHub
Parameters
- Optionaloptions: PubSubHubOptions
Returns PubSubHub
- Defined in src/pubsub/pubsub.ts:73

Methods

[dispose]

"[dispose]"(): Promise<void>
Returns Promise<void>
- Defined in src/pubsub/pubsub.ts:174

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
Implementation of IPubSubHub.publish
- Defined in src/pubsub/pubsub.ts:87

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.
Implementation of IPubSubHub.subscribe
- Defined in src/pubsub/pubsub.ts:131

unsubscribe

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