Class Subscription

A convenience API for managing an individual subscription.

Hierarchy

MessageStream
- Subscription

Index

Properties

Methods

[asyncIterator] off on once unsubscribe

Properties

`Readonly` streamPartId

streamPartId: StreamPartID

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<Message, any, undefined>
Returns AsyncIterator<Message, any, undefined>

Inherited from MessageStream.[asyncIterator]

off

off<E>(eventName: E, listener: SubscriptionEvents[E]): void
Removes an event listener from the subscription.
Type Parameters
- E extends keyof SubscriptionEvents
Parameters
- eventName: E
  
  event name, see SubscriptionEvents for options
- listener: SubscriptionEvents[E]
  
  the callback function to remove
Returns void

on

on<E>(eventName: E, listener: SubscriptionEvents[E]): void
Adds an event listener to the subscription.
Type Parameters
- E extends keyof SubscriptionEvents
Parameters
- eventName: E
  
  event name, see SubscriptionEvents for options
- listener: SubscriptionEvents[E]
  
  the callback function
Returns void

once

once<E>(eventName: E, listener: SubscriptionEvents[E]): void
Adds an event listener to the subscription that is invoked only once.
Type Parameters
- E extends keyof SubscriptionEvents
Parameters
- eventName: E
  
  event name, see SubscriptionEvents for options
- listener: SubscriptionEvents[E]
  
  the callback function
Returns void

unsubscribe

unsubscribe(): Promise<void>
Unsubscribes this subscription.

Remarks
The instance should not be used after calling this.

Returns Promise<void>

Generated using TypeDoc