Class: SubscribablePipe<I, O, HandlerType>
Defined in: src/sdk/sub/SubscribablePipe.ts:8
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.
Extends
HandlerSubscription
<HandlerType
>
Type Parameters
Type Parameter |
---|
I |
O |
HandlerType extends (...args ) => void |
Constructors
Constructor
new SubscribablePipe<
I
,O
,HandlerType
>(from
,to
,onDestroy
):SubscribablePipe
<I
,O
,HandlerType
>
Defined in: src/sdk/sub/SubscribablePipe.ts:15
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
from | Subscribable <I > | The input subscribable. |
to | MutableSubscribable <any , I > | The output mutable subscribable. |
onDestroy | (sub ) => void | A function which is called when this subscription is destroyed. |
Returns
SubscribablePipe
<I
, O
, HandlerType
>
Overrides
HandlerSubscription
.constructor
Constructor
new SubscribablePipe<
I
,O
,HandlerType
>(from
,to
,map
,onDestroy
):SubscribablePipe
<I
,O
,HandlerType
>
Defined in: src/sdk/sub/SubscribablePipe.ts:23
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
from | Subscribable <I > | The input subscribable. |
to | MutableSubscribable <any , O > | The output mutable subscribable. |
map | (fromVal , toVal ) => O | A function which transforms this pipe's inputs. |
onDestroy | (sub ) => void | A function which is called when this subscription is destroyed. |
Returns
SubscribablePipe
<I
, O
, HandlerType
>
Overrides
HandlerSubscription<HandlerType>.constructor
Properties
canInitialNotify
readonly
canInitialNotify:boolean
Defined in: src/sdk/sub/HandlerSubscription.ts:20
Whether this subscription supports initial notifications on resume.
Inherited from
HandlerSubscription
.canInitialNotify
handler
readonly
handler:HandlerType
Defined in: src/sdk/sub/HandlerSubscription.ts:31
This subscription's handler. The handler will be called each time this subscription receives a notification from its source.
Inherited from
Accessors
isAlive
Get Signature
get isAlive():
boolean
Defined in: src/sdk/sub/HandlerSubscription.ts:9
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
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.
Inherited from
isPaused
Get Signature
get isPaused():
boolean
Defined in: src/sdk/sub/HandlerSubscription.ts:15
Whether this subscription is paused. Paused subscriptions do not receive notifications from their sources until they are resumed.
Returns
boolean
Whether this subscription is paused. Paused subscriptions do not receive notifications from their sources until they are resumed.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/sub/HandlerSubscription.ts:81
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
initialNotify()
initialNotify():
void
Defined in: src/sdk/sub/HandlerSubscription.ts:42
Sends an initial notification to this subscription.
Returns
void
Throws
Error if this subscription is not alive.
Inherited from
HandlerSubscription
.initialNotify
pause()
pause():
this
Defined in: src/sdk/sub/HandlerSubscription.ts:51
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
resume()
resume(
initialNotify
):this
Defined in: src/sdk/sub/HandlerSubscription.ts:62
Resumes this subscription. Once resumed, this subscription will receive notifications from its source.
Parameters
Parameter | 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.