Class: SubscribablePipe<I, O, HandlerType>

A pipe from an input subscribable to an output mutable subscribable. Each notification received by the pipe is used to change the state of the output subscribable.

Type parameters

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

Hierarchy

• HandlerSubscription<HandlerType>

  ↳ SubscribablePipe

Constructors

constructor

• new SubscribablePipe<I, O, HandlerType>(from, to, onDestroy): SubscribablePipe<I, O, HandlerType>

Constructor.

Type parameters

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

Parameters

Name	Type	Description
from	Subscribable<I>	The input subscribable.
to	MutableSubscribable<any, I>	The output mutable subscribable.
onDestroy	(sub: SubscribablePipe<I, O, HandlerType>) => void	A function which is called when this subscription is destroyed.

Returns

SubscribablePipe<I, O, HandlerType>

Overrides

HandlerSubscription.constructor

Defined in

src/sdk/sub/SubscribablePipe.ts:15

• new SubscribablePipe<I, O, HandlerType>(from, to, map, onDestroy): SubscribablePipe<I, O, HandlerType>

Constructor.

Type parameters

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

Parameters

Name	Type	Description
from	Subscribable<I>	The input subscribable.
to	MutableSubscribable<any, O>	The output mutable subscribable.
map	(fromVal: I, toVal: O) => O	A function which transforms this pipe's inputs.
onDestroy	(sub: SubscribablePipe<I, O, HandlerType>) => void	A function which is called when this subscription is destroyed.

Returns

SubscribablePipe<I, O, HandlerType>

Overrides

HandlerSubscription\<HandlerType\>.constructor

Defined in

src/sdk/sub/SubscribablePipe.ts:23

Properties

canInitialNotify

• Readonly canInitialNotify: boolean

Whether this subscription supports initial notifications on resume.

Inherited from

HandlerSubscription.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.

Inherited from

HandlerSubscription.handler

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

Inherited from

HandlerSubscription.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

Inherited from

HandlerSubscription.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

Inherited from

HandlerSubscription.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.

Inherited from

HandlerSubscription.initialNotify

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.

Inherited from

HandlerSubscription.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.

Inherited from

HandlerSubscription.resume

Defined in

src/sdk/sub/HandlerSubscription.ts:62