Class: FilteredMapSubject<K, V>
A subscribable map whose key-value pairs can be freely added and removed for a set of allowed keys.
Type parameters
Name |
---|
K |
V |
Hierarchy
AbstractSubscribableMap
<K
,V
>↳
FilteredMapSubject
Implements
MutableSubscribable
<ReadonlyMap
<K
,V
>,Iterable
<readonly [K
,V
]>>MutableSubscribableMap
<K
,V
>
Properties
initialNotifyFunc
• Protected
Readonly
initialNotifyFunc: (sub
: HandlerSubscription
<SubscribableMapHandler
<K
, V
>>) => void
A function which sends initial notifications to subscriptions.
Type declaration
▸ (sub
): void
A function which sends initial notifications to subscriptions.
Parameters
Name | Type |
---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> |
Returns
void
Inherited from
AbstractSubscribableMap.initialNotifyFunc
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:28
isMutableSubscribable
• Readonly
isMutableSubscribable: true
Flags this object as a MutableSubscribable.
Implementation of
MutableSubscribable.isMutableSubscribable
Defined in
src/sdk/sub/FilteredMapSubject.ts:14
isMutableSubscribableMap
• Readonly
isMutableSubscribableMap: true
Flags this object as a MutableSubscribableMap.
Implementation of
MutableSubscribableMap.isMutableSubscribableMap
Defined in
src/sdk/sub/FilteredMapSubject.ts:15
isSubscribable
• Readonly
isSubscribable: true
Flags this object as a Subscribable.
Implementation of
MutableSubscribable.isSubscribable
Inherited from
AbstractSubscribableMap.isSubscribable
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:14
isSubscribableMap
• Readonly
isSubscribableMap: true
Flags this object as a SubscribableMap.
Implementation of
MutableSubscribableMap.isSubscribableMap
Inherited from
AbstractSubscribableMap.isSubscribableMap
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:15
notifyDepth
• Protected
notifyDepth: number
= 0
Inherited from
AbstractSubscribableMap.notifyDepth
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:25
onSubDestroyedFunc
• Protected
Readonly
onSubDestroyedFunc: (sub
: HandlerSubscription
<SubscribableMapHandler
<K
, V
>>) => void
A function which responds to when a subscription to this subscribable is destroyed.
Type declaration
▸ (sub
): void
A function which responds to when a subscription to this subscribable is destroyed.
Parameters
Name | Type |
---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> |
Returns
void
Inherited from
AbstractSubscribableMap.onSubDestroyedFunc
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:31
singletonSub
• Protected
Optional
singletonSub: HandlerSubscription
<SubscribableMapHandler
<K
, V
>>
Inherited from
AbstractSubscribableMap.singletonSub
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:22
subs
• Protected
Optional
subs: HandlerSubscription
<SubscribableMapHandler
<K
, V
>>[]
Inherited from
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:24
Accessors
size
• get
size(): number
The number of elements contained in this map.
Returns
number
Implementation of
Inherited from
AbstractSubscribableMap.size
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:18
Methods
addSubscription
▸ addSubscription(sub
): void
Adds a subscription to this map.
Parameters
Name | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The subscription to add. |
Returns
void
Inherited from
AbstractSubscribableMap.addSubscription
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:37
clear
▸ clear(): void
Removes all key-value pairs from this map.
Returns
void
Implementation of
Defined in
src/sdk/sub/FilteredMapSubject.ts:115
delete
▸ delete(key
): boolean
Removes a key-value pair from this map.
Parameters
Name | Type | Description |
---|---|---|
key | K | The key to remove. |
Returns
boolean
Whether the key-value pair was removed.
Implementation of
Defined in
src/sdk/sub/FilteredMapSubject.ts:103
destroy
▸ destroy(): void
Destroys this map.
Returns
void
Defined in
src/sdk/sub/FilteredMapSubject.ts:137
get
▸ get(): ReadonlyMap
<K
, V
>
Gets this item's state.
Returns
ReadonlyMap
<K
, V
>
This item's state.
Implementation of
Overrides
Defined in
src/sdk/sub/FilteredMapSubject.ts:62
getValue
▸ getValue(key
): undefined
| V
Gets the value stored under a given key in this map.
Parameters
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:57
has
▸ has(key
): boolean
Checks whether this map contains a key.
Parameters
Name | Type | Description |
---|---|---|
key | K | The key to check. |
Returns
boolean
Whether this map contains the specified key.
Implementation of
Inherited from
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:52
initialNotify
▸ initialNotify(sub
): void
Notifies a subscription of this map's current state.
Parameters
Name | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The subscription to notify. |
Returns
void
Inherited from
AbstractSubscribableMap.initialNotify
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:173
map
▸ map<M
>(fn
, equalityFunc?
): MappedSubject
<[ReadonlyMap
<K
, V
>], M
>
Maps this subscribable to a new subscribable.
Type parameters
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
fn | (input : ReadonlyMap <K , V >, previousVal? : M ) => M | The function to use to map to the new subscribable. |
equalityFunc? | (a : M , b : M ) => 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:206
▸ map<M
>(fn
, equalityFunc
, mutateFunc
, initialVal
): MappedSubject
<[ReadonlyMap
<K
, V
>], M
>
Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.
Type parameters
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
fn | (input : ReadonlyMap <K , V >, previousVal? : M ) => M | The function to use to map to the new subscribable. |
equalityFunc | (a : M , b : M ) => boolean | The function to use to check for equality between mapped values. |
mutateFunc | (oldVal : M , newVal : M ) => 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:215
notify
▸ notify(type
, key
, value
): void
Notifies subscriptions of a change in this map.
Parameters
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:95
onSubDestroyed
▸ onSubDestroyed(sub
): void
Responds to when a subscription to this map is destroyed.
Parameters
Name | Type | Description |
---|---|---|
sub | HandlerSubscription <SubscribableMapHandler <K , V >> | The destroyed subscription. |
Returns
void
Inherited from
AbstractSubscribableMap.onSubDestroyed
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:184
pipe
▸ pipe(to
, paused?
): Subscription
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
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:243
▸ pipe<M
>(to
, map
, paused?
): Subscription
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
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
to | MutableSubscribable <any , M > | The mutable subscribable to which to pipe this subscribable's mapped state. |
map | (fromVal : ReadonlyMap <K , V >, toVal : M ) => 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:253
▸ pipe(to
, paused?
): Subscription
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
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:262
set
▸ set(entries
): void
Sets the key-value pairs contained in this map.
Parameters
Name | Type | Description |
---|---|---|
entries | Iterable <[K , V ]> | The key-value pairs to set. |
Returns
void
Implementation of
Defined in
src/sdk/sub/FilteredMapSubject.ts:70
setValue
▸ setValue(key
, value
): this
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
Name | 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
Defined in
src/sdk/sub/FilteredMapSubject.ts:85
sub
▸ sub(handler
, initialNotify?
, paused?
): Subscription
Subscribes to changes in this subscribable's state.
Parameters
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:62
unsub
▸ unsub(handler
): void
Unsubscribes a callback function from this subscribable.
Parameters
Name | 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
Defined in
src/sdk/sub/AbstractSubscribableMap.ts:77
create
▸ create<K
, V
>(allowedKeys
, initialEntries?
): FilteredMapSubject
<K
, V
>
Creates and returns a new FilteredMapSubject.
Type parameters
Name |
---|
K |
V |
Parameters
Name | Type | Description |
---|---|---|
allowedKeys | Iterable <K > | SubscribableSet <K > | Subscribable <Iterable <K >> | The allowed keys for the new map. If an allowed key is removed after the map is created, then that key will be removed from the map. |
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
FilteredMapSubject
<K
, V
>
A new FilteredMapSubject instance.
Defined in
src/sdk/sub/FilteredMapSubject.ts:57