Class: HandlerSubscription<HandlerType>

A Subscription which executes a handler function every time it receives a notification.

Type parameters

Name	Type
HandlerType	extends (...args: any[]) => void

Hierarchy

• HandlerSubscription

  ↳ SubscribableMapPipe

  ↳ SubscribablePipe

  ↳ SubscribableSetPipe

Implements

• Subscription

Constructors

constructor

• new HandlerSubscription<HandlerType>(handler, initialNotifyFunc?, onDestroy?): HandlerSubscription<HandlerType>

Constructor.

Type parameters

Name	Type
HandlerType	extends (...args: any[]) => void

Parameters

Name	Type	Description
handler	HandlerType	This subscription's handler. The handler will be called each time this subscription receives a notification from its source.
initialNotifyFunc?	(sub: HandlerSubscription<HandlerType>) => void	A function which sends initial notifications to this subscription. If not defined, this subscription will not support initial notifications.
onDestroy?	(sub: HandlerSubscription<HandlerType>) => void	A function which is called when this subscription is destroyed.

Returns

HandlerSubscription<HandlerType>

Defined in

src/sdk/sub/HandlerSubscription.ts:30

Properties

canInitialNotify

• Readonly canInitialNotify: boolean

Whether this subscription supports initial notifications on resume.

Implementation of

Subscription.canInitialNotify

Defined in

src/sdk/sub/HandlerSubscription.ts:20

---

handler

• Readonly handler: HandlerType

This subscription's handler. The handler will be called each time this subscription receives a notification from its source.

Defined in

src/sdk/sub/HandlerSubscription.ts:31

Accessors

isAlive

• get isAlive(): boolean

Whether this subscription is alive. Live subscriptions can be freely paused and resumed. Dead subscriptions no longer receive notifications from their sources and will throw an error when attempting to pause or resume them.

Returns

boolean

Implementation of

Subscription.isAlive

Defined in

src/sdk/sub/HandlerSubscription.ts:9

---

isPaused

• get isPaused(): boolean

Whether this subscription is paused. Paused subscriptions do not receive notifications from their sources until they are resumed.

Returns

boolean

Implementation of

Subscription.isPaused

Defined in

src/sdk/sub/HandlerSubscription.ts:15

Methods

destroy

▸ destroy(): void

Destroys this subscription. Once destroyed, this subscription will no longer receive notifications from its source and will throw an error when attempting to pause or resume it.

Returns

void

Implementation of

Subscription.destroy

Defined in

src/sdk/sub/HandlerSubscription.ts:81

---

initialNotify

▸ initialNotify(): void

Sends an initial notification to this subscription.

Returns

void

Throws

Error if this subscription is not alive.

Defined in

src/sdk/sub/HandlerSubscription.ts:42

---

pause

▸ pause(): this

Pauses this subscription. Once paused, this subscription will not receive notifications from its source until it is resumed.

Returns

this

This subscription, after it has been paused.

Throws

Error if this subscription is not alive.

Implementation of

Subscription.pause

Defined in

src/sdk/sub/HandlerSubscription.ts:51

---

resume

▸ resume(initialNotify?): this

Resumes this subscription. Once resumed, this subscription will receive notifications from its source.

Parameters

Name	Type	Default value	Description
initialNotify	boolean	false	Whether to immediately send a notification to this subscription's handler when it is resumed if this subscription supports initial notifications. Defaults to false.

Returns

this

This subscription, after it has been resumed.

Throws

Error if this subscription is not alive.

Implementation of

Subscription.resume

Defined in

src/sdk/sub/HandlerSubscription.ts:62