Class: SubscribableMapPipe<K, V, HandlerType>
A pipe from an input subscribable map to an output mutable subscribable map. Each key-value pair added/changed/removed notification received by the pipe is used to add/change/remove key-value pairs in the output map.
Type parameters
| Name | Type |
|---|---|
K | K |
V | V |
HandlerType | extends (map: ReadonlyMap<K, V>, type: SubscribableMapEventType, key: K, value: V, ...args: any[]) => void |
Hierarchy
HandlerSubscription<HandlerType>↳
SubscribableMapPipe
Constructors
constructor
• new SubscribableMapPipe<K, V, HandlerType>(from, to, onDestroy): SubscribableMapPipe<K, V, HandlerType>
Constructor.
Type parameters
| Name | Type |
|---|---|
K | K |
V | V |
HandlerType | extends (map: ReadonlyMap<K, V>, type: SubscribableMapEventType, key: K, value: V, ...args: any[]) => void |
Parameters
| Name | Type | Description |
|---|---|---|
from | SubscribableMap<K, V> | The input subscribable map. |
to | MutableSubscribableMap<K, V> | The output mutable subscribable map. |
onDestroy | (sub: SubscribableMapPipe<K, V, HandlerType>) => void | A function which is called when this subscription is destroyed. |
Returns
SubscribableMapPipe<K, V, HandlerType>
Overrides
HandlerSubscription.constructor
Defined in
src/sdk/sub/SubscribableMapPipe.ts:18
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
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
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
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
Defined in
src/sdk/sub/HandlerSubscription.ts:62