Class: MapSubject<K, V>
Defined in: src/sdk/sub/MapSubject.ts:8
A subscribable map whose key-value pairs can be freely added and removed.
Extends
AbstractSubscribableMap
<K
,V
>
Type Parameters
Type Parameter |
---|
K |
V |
Implements
MutableSubscribable
<ReadonlyMap
<K
,V
>,Iterable
<readonly [K
,V
]>>MutableSubscribableMap
<K
,V
>
Properties
initialNotifyFunc()
protected
readonly
initialNotifyFunc: (sub
) =>void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:28
A function which sends initial notifications to subscriptions.
Notifies a subscription of this map's current state.
Parameters
Parameter | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The subscription to notify. |
Returns
void
Inherited from
AbstractSubscribableMap
.initialNotifyFunc
isMutableSubscribable
readonly
isMutableSubscribable:true
=true
Defined in: src/sdk/sub/MapSubject.ts:9
Flags this object as a MutableSubscribable.
Implementation of
MutableSubscribable
.isMutableSubscribable
isMutableSubscribableMap
readonly
isMutableSubscribableMap:true
=true
Defined in: src/sdk/sub/MapSubject.ts:10
Flags this object as a MutableSubscribableMap.
Implementation of
MutableSubscribableMap
.isMutableSubscribableMap
isSubscribable
readonly
isSubscribable:true
=true
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:14
Flags this object as a Subscribable.
Implementation of
MutableSubscribable
.isSubscribable
Inherited from
AbstractSubscribableMap
.isSubscribable
isSubscribableMap
readonly
isSubscribableMap:true
=true
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:15
Flags this object as a SubscribableMap.
Implementation of
MutableSubscribableMap
.isSubscribableMap
Inherited from
AbstractSubscribableMap
.isSubscribableMap
notifyDepth
protected
notifyDepth:number
=0
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:25
Inherited from
AbstractSubscribableMap
.notifyDepth
onSubDestroyedFunc()
protected
readonly
onSubDestroyedFunc: (sub
) =>void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:31
A function which responds to when a subscription to this subscribable is destroyed.
Responds to when a subscription to this map is destroyed.
Parameters
Parameter | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The destroyed subscription. |
Returns
void
Inherited from
AbstractSubscribableMap
.onSubDestroyedFunc
singletonSub?
protected
optional
singletonSub:HandlerSubscription
<SubscribableMapHandler
<K
,V
>>
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:22
Inherited from
AbstractSubscribableMap
.singletonSub
subs?
protected
optional
subs:HandlerSubscription
<SubscribableMapHandler
<K
,V
>>[]
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:24
Inherited from
Accessors
size
Get Signature
get size():
number
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:18
The number of elements contained in this map.
Returns
number
The number of elements contained in this map.
Implementation of
Inherited from
Methods
addSubscription()
protected
addSubscription(sub
):void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:37
Adds a subscription to this map.
Parameters
Parameter | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The subscription to add. |
Returns
void
Inherited from
AbstractSubscribableMap
.addSubscription
clear()
clear():
void
Defined in: src/sdk/sub/MapSubject.ts:85
Removes all key-value pairs from this map.
Returns
void
Implementation of
delete()
delete(
key
):boolean
Defined in: src/sdk/sub/MapSubject.ts:73
Removes a key-value pair from this map.
Parameters
Parameter | Type | Description |
---|---|---|
key | K | The key to remove. |
Returns
boolean
Whether the key-value pair was removed.
Implementation of
get()
get():
ReadonlyMap
<K
,V
>
Defined in: src/sdk/sub/MapSubject.ts:36
Gets this item's state.
Returns
ReadonlyMap
<K
, V
>
This item's state.
Implementation of
Overrides
getValue()
getValue(
key
):undefined
|V
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:57
Gets the value stored under a given key in this map.
Parameters
Parameter | Type | Description |
---|---|---|
key | K | The key under which the value to get is stored. |
Returns
undefined
| V
The value stored under the specified key in this map, or undefined
if this map does not contain the
specified key.
Implementation of
MutableSubscribableMap
.getValue
Inherited from
AbstractSubscribableMap
.getValue
has()
has(
key
):boolean
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:52
Checks whether this map contains a key.
Parameters
Parameter | Type | Description |
---|---|---|
key | K | The key to check. |
Returns
boolean
Whether this map contains the specified key.
Implementation of
Inherited from
initialNotify()
protected
initialNotify(sub
):void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:173
Notifies a subscription of this map's current state.
Parameters
Parameter | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The subscription to notify. |
Returns
void
Inherited from
AbstractSubscribableMap
.initialNotify
map()
Call Signature
map<
M
>(fn
,equalityFunc?
):MappedSubject
<[ReadonlyMap
<K
,V
>],M
>
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:206
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
MappedSubject
<[ReadonlyMap
<K
, V
>], M
>
The mapped subscribable.
Implementation of
Inherited from
Call Signature
map<
M
>(fn
,equalityFunc
,mutateFunc
,initialVal
):MappedSubject
<[ReadonlyMap
<K
,V
>],M
>
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:215
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
MappedSubject
<[ReadonlyMap
<K
, V
>], M
>
The mapped subscribable.
Implementation of
Inherited from
notify()
protected
notify(type
,key
,value
):void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:95
Notifies subscriptions of a change in this map.
Parameters
Parameter | Type | Description |
---|---|---|
type | SubscribableMapEventType | The type of change. |
key | K | The key related to the change. |
value | V | The value related to the change. |
Returns
void
Inherited from
AbstractSubscribableMap
.notify
onSubDestroyed()
protected
onSubDestroyed(sub
):void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:184
Responds to when a subscription to this map is destroyed.
Parameters
Parameter | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The destroyed subscription. |
Returns
void
Inherited from
AbstractSubscribableMap
.onSubDestroyed
pipe()
Call Signature
pipe(
to
,paused?
):Subscription
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:243
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 , ReadonlyMap <K , V >> | 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.
Implementation of
Inherited from
Call Signature
pipe<
M
>(to
,map
,paused?
):Subscription
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:253
Subscribes to and pipes mapped inputs from another subscribable. Whenever an update of the other 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 this 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.
Implementation of
Inherited from
Call Signature
pipe(
to
,paused?
):Subscription
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:262
Subscribes to and pipes this map's state to a mutable subscribable map. Whenever a key-value pair added, changed, or removed event is received through the subscription, the same key-value pair will be added to, changed, or removed from the other map.
Parameters
Parameter | Type | Description |
---|---|---|
to | MutableSubscribableMap <K , V > | The mutable subscribable map to which to pipe this map's state. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false . |
Returns
The new subscription.
Implementation of
MutableSubscribable.pipe
Inherited from
set()
set(
entries
):void
Defined in: src/sdk/sub/MapSubject.ts:44
Sets the key-value pairs contained in this map.
Parameters
Parameter | Type | Description |
---|---|---|
entries | Iterable <[K , V ]> | The key-value pairs to set. |
Returns
void
Implementation of
setValue()
setValue(
key
,value
):this
Defined in: src/sdk/sub/MapSubject.ts:59
Adds a key-value pair to this map. If this map already contains the specified key, then the existing value stored under the key will be replaced with the new value.
Parameters
Parameter | Type | Description |
---|---|---|
key | K | The key to add. |
value | V | The value to add. |
Returns
this
This map, after the key-value pair has been added.
Implementation of
MutableSubscribableMap
.setValue
sub()
sub(
handler
,initialNotify
,paused
):Subscription
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:62
Subscribes to changes in this subscribable's state.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
handler | SubscribableMapHandler <K , V > | undefined | A function which is called when this subscribable's state changes. |
initialNotify | boolean | false | 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 | false | Whether the new subscription should be initialized as paused. Defaults to false . |
Returns
The new subscription.
Implementation of
Inherited from
unsub()
unsub(
handler
):void
Defined in: src/sdk/sub/AbstractSubscribableMap.ts:77
Unsubscribes a callback function from this subscribable.
Parameters
Parameter | Type | Description |
---|---|---|
handler | SubscribableMapHandler <K , V > | 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.
Implementation of
Inherited from
create()
static
create<K
,V
>(initialEntries?
):MapSubject
<K
,V
>
Defined in: src/sdk/sub/MapSubject.ts:31
Creates and returns a new MapSubject.
Type Parameters
Type Parameter |
---|
K |
V |
Parameters
Parameter | Type | Description |
---|---|---|
initialEntries? | Iterable <[K , V ]> | The key-value pairs initially contained in the new map. If not defined, then the new map will initially be empty. |
Returns
MapSubject
<K
, V
>
A new MapSubject instance.