Interface: MappedSubscribable<T>
Defined in: src/sdk/sub/Subscribable.ts:76
A subscribable which is mapped from another subscribable.
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
canInitialNotify
readonlycanInitialNotify:boolean
Defined in: src/sdk/sub/Subscription.ts:25
Whether this subscription supports initial notifications on resume.
Inherited from
isAlive
readonlyisAlive:boolean
Defined in: src/sdk/sub/Subscribable.ts:82
Whether the subscription to the parent subscribable is alive. While alive, this subscribable will update its state based on its parent's state, unless it is paused. Once dead, this subscribable will no longer update its state, and cannot be resumed again.
Overrides
isPaused
readonlyisPaused:boolean
Defined in: src/sdk/sub/Subscribable.ts:88
Whether the subscription to the parent subscribable is paused. While paused, this subscribable will not update its state until it is resumed.
Overrides
isSubscribable
readonlyisSubscribable:true
Defined in: src/sdk/sub/Subscribable.ts:9
Flags this object as a Subscribable.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/sub/Subscribable.ts:112
Destroys the subscription to the parent subscribable.
Returns
void
Overrides
get()
get():
T
Defined in: src/sdk/sub/Accessible.ts:9
Gets this item's state.
Returns
T
This item's state.
Inherited from
map()
Call Signature
map<
M>(fn,equalityFunc?):MappedSubscribable<M>
Defined in: src/sdk/sub/Subscribable.ts:36
Maps this subscribable to a new subscribable.
Type Parameters
| Type Parameter |
|---|
M |
Parameters
| Parameter | Type | Description |
|---|---|---|
fn | (input, previousVal?) => M | The function to use to map to the new subscribable. |
equalityFunc? | (a, b) => boolean | The function to use to check for equality between mapped values. Defaults to the strict equality comparison (===). |
Returns
MappedSubscribable<M>
The mapped subscribable.
Inherited from
Call Signature
map<
M>(fn,equalityFunc,mutateFunc,initialVal):MappedSubscribable<M>
Defined in: src/sdk/sub/Subscribable.ts:45
Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.
Type Parameters
| Type Parameter |
|---|
M |
Parameters
| Parameter | Type | Description |
|---|---|---|
fn | (input, previousVal?) => M | The function to use to map to the new subscribable. |
equalityFunc | (a, b) => boolean | The function to use to check for equality between mapped values. |
mutateFunc | (oldVal, newVal) => void | The function to use to change the value of the mapped subscribable. |
initialVal | M | The initial value of the mapped subscribable. |
Returns
MappedSubscribable<M>
The mapped subscribable.
Inherited from
pause()
pause():
this
Defined in: src/sdk/sub/Subscribable.ts:96
Pauses the subscription to the parent subscribable. Once paused, this subscribable will not update its state until it is resumed.
Returns
this
This subscribable, after it has been paused.
Throws
Error if the subscription to the parent subscribable is not alive.
Overrides
pipe()
Call Signature
pipe(
to,paused?):Subscription
Defined in: src/sdk/sub/Subscribable.ts:60
Subscribes to and pipes this subscribable's state to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be used as an input to change the other subscribable's state.
Parameters
| Parameter | Type | Description |
|---|---|---|
to | MutableSubscribable<any, T> | The mutable subscribable to which to pipe this subscribable's state. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false. |
Returns
The new subscription.
Inherited from
Call Signature
pipe<
M>(to,map,paused?):Subscription
Defined in: src/sdk/sub/Subscribable.ts:70
Subscribes to this subscribable's state and pipes a mapped version to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be transformed by the specified mapping function, and the transformed state will be used as an input to change the other subscribable's state.
Type Parameters
| Type Parameter |
|---|
M |
Parameters
| Parameter | Type | Description |
|---|---|---|
to | MutableSubscribable<any, M> | The mutable subscribable to which to pipe this subscribable's mapped state. |
map | (fromVal, toVal) => M | The function to use to transform inputs. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false. |
Returns
The new subscription.
Inherited from
resume()
resume():
this
Defined in: src/sdk/sub/Subscribable.ts:107
Resumes the subscription to the parent subscribable. Once resumed, this subscribable will immediately begin to update its state based its parent's state.
Any initialNotify argument passed to this method is ignored. This subscribable is always immediately notified of
its parent's state when resumed.
Returns
this
This subscribable, after it has been resumed.
Throws
Error if the subscription to the parent subscribable is not alive.
Overrides
sub()
sub(
handler,initialNotify?,paused?):Subscription
Defined in: src/sdk/sub/Subscribable.ts:19
Subscribes to changes in this subscribable's state.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (value) => void | A function which is called when this subscribable's state changes. |
initialNotify? | boolean | Whether to immediately invoke the callback function with this subscribable's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false. |
Returns
The new subscription.
Inherited from
unsub()
unsub(
handler):void
Defined in: src/sdk/sub/Subscribable.ts:27
Unsubscribes a callback function from this subscribable.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (value) => void | The function to unsubscribe. |
Returns
void
Deprecated
This method has been deprecated in favor of using the Subscription object returned by .sub()
to manage subscriptions.