Interface: SubscribableMap<K, V>
Defined in: src/sdk/sub/SubscribableMap.ts:25
A map which allows others to subscribe to be notified of changes in its state.
Extended by
Type Parameters
Type Parameter |
---|
K |
V |
Properties
isSubscribableMap
readonly
isSubscribableMap:true
Defined in: src/sdk/sub/SubscribableMap.ts:27
Flags this object as a SubscribableMap.
size
readonly
size:number
Defined in: src/sdk/sub/SubscribableMap.ts:30
The number of elements contained in this map.
Methods
get()
get():
ReadonlyMap
<K
,V
>
Defined in: src/sdk/sub/SubscribableMap.ts:36
Gets a read-only version of this map.
Returns
ReadonlyMap
<K
, V
>
A read-only version of this map.
getValue()
getValue(
key
):undefined
|V
Defined in: src/sdk/sub/SubscribableMap.ts:51
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.
has()
has(
key
):boolean
Defined in: src/sdk/sub/SubscribableMap.ts:43
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.
pipe()
pipe(
to
,paused?
):Subscription
Defined in: src/sdk/sub/SubscribableMap.ts:71
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.
sub()
sub(
handler
,initialNotify?
,paused?
):Subscription
Defined in: src/sdk/sub/SubscribableMap.ts:61
Subscribes to changes in this map's state.
Parameters
Parameter | Type | Description |
---|---|---|
handler | SubscribableMapHandler <K , V > | A function which is called when this map's state changes. |
initialNotify? | boolean | Whether to immediately invoke the callback function with this map'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.