Interface: Subscription<T> ​

Toc Ref

1

Type parameters ​

Table of contents ​

Properties ​

• subscribe
• unsubscribe

Methods ​

• on

Properties ​

subscribe ​

• subscribe: () => Promise<void>

Type declaration ​

▸ (): Promise<void>

Can be used to re-subscribe with the same parameters.

Returns ​

Promise<void>

Defined in ​

src/index.ts:1123

unsubscribe ​

• unsubscribe: () => Promise<void>

Type declaration ​

▸ (): Promise<void>

Unsubscribes the subscription.

Returns ​

Promise<void>

Defined in ​

src/index.ts:1128

Methods ​

on ​

▸ on(eventName, listener): Subscription<T>

Fires on each incoming event with the event object as argument.

Parameters ​

Returns ​

Subscription<T>

Defined in ​

src/index.ts:1102

▸ on(eventName, listener): Subscription<T>

Fires on successful re-subscription

Parameters ​

Returns ​

Subscription<T>

Defined in ​

src/index.ts:1110

▸ on(eventName, listener): Subscription<T>

Fires on unsubscription

Parameters ​

Returns ​

Subscription<T>

Defined in ​

src/index.ts:1118