Class: HandlerSubscription<HandlerType>
Defined in: src/sdk/sub/HandlerSubscription.ts:6
A Subscription which executes a handler function every time it receives a notification.
Extended by
Type Parameters
Type Parameter |
---|
HandlerType extends (...args ) => void |
Implements
Constructors
Constructor
new HandlerSubscription<
HandlerType
>(handler
,initialNotifyFunc?
,onDestroy?
):HandlerSubscription
<HandlerType
>
Defined in: src/sdk/sub/HandlerSubscription.ts:30
Constructor.
Parameters
Parameter | 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 ) => void | A function which sends initial notifications to this subscription. If not defined, this subscription will not support initial notifications. |
onDestroy? | (sub ) => void | A function which is called when this subscription is destroyed. |
Returns
HandlerSubscription
<HandlerType
>
Properties
canInitialNotify
readonly
canInitialNotify:boolean
Defined in: src/sdk/sub/HandlerSubscription.ts:20
Whether this subscription supports initial notifications on resume.
Implementation of
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.
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.
Implementation of
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.
Implementation of
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
Implementation of
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.
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.
Implementation of
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.