Interface: MutableSubscribable<T, I>
Defined in: src/sdk/sub/Subscribable.ts:119
A subscribable that can accept inputs to change its state. The state of the subscribable may be derived from the inputs directly or from transformed versions of the inputs.
Extends
Subscribable
<T
>.MutableAccessible
<T
,I
>
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
T | - |
I | T |
Properties
isMutableSubscribable
readonly
isMutableSubscribable:true
Defined in: src/sdk/sub/Subscribable.ts:121
Flags this object as a MutableSubscribable.
isSubscribable
readonly
isSubscribable:true
Defined in: src/sdk/sub/Subscribable.ts:9
Flags this object as a Subscribable.
Inherited from
Methods
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
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
The mapped subscribable.
Inherited from
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
set()
set(
value
):void
Defined in: src/sdk/sub/Accessible.ts:21
Sets the state of this item.
Parameters
Parameter | Type | Description |
---|---|---|
value | I | The input used to change the state. |
Returns
void
Inherited from
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.