RxMap<K, V> class

An RxMap gives you a deeper level of observability on a map of values. It tracks when keys are added, removed or modified and notifies the observers.

Use an RxMap when a change in the map matters.

Inheritance
Implemented types
Mixed in types
Available Extensions
Annotations
  • @Deprecated('Collections, Futures and Streams will no longer be ' 'supported by this package as they violate the ASP standard. ' 'It is better to use a pure [Atom] synchronously ' 'to understand the flow of reactivity.')

Constructors

RxMap([Map<K, V>? map, String? key])
Creates a RxMap that may be initialized with a map. {@tool snippet}

Properties

entries → Iterable<MapEntry<K, V>>
The map entries of this.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
isEmpty → bool
Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
key ↔ String
Atom Identify
latefinaloverride-getter
keys → Iterable<K>
The keys of this.
no setteroverride
length → int
The number of key/value pairs in the map.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → RxMap<K, V>
The current value of the object. When the value changes, the callbacks registered with addListener will be invoked.
no setteroverride
values → Iterable<V>
The values of this.
no setterinherited

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map.
override
addEntries(Iterable<MapEntry<K, V>> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
buffer(int count, {Duration timeLimit = const Duration(seconds: 10)}) → Future<List<RxMap<K, V>>>
Buffer changes of a Atom. The count is a number of a buffered items. The timeLimit is 10 seconds by default.
override
cast<RK, RV>() → Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
override
containsKey(Object? key) → bool
Whether this map contains the given key.
inherited
containsValue(Object? value) → bool
Whether this map contains the given value.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
forEach(void action(K key, V value)) → void
Applies action to each key/value pair of the map.
inherited
map<K2, V2>(MapEntry<K2, V2> transform(K key, V value)) → Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
next({Duration timeLimit = const Duration(seconds: 10)}) → Future<RxMap<K, V>>
Wait the next change of a Atom. The timeLimit is 10 seconds by default.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
putIfAbsent(K key, V ifAbsent()) → V
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → V?
Removes key and its associated value, if present, from the map.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeWhere(bool test(K key, V value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() → String
A string representation of this object.
inherited
update(K key, V update(V value), {V ifAbsent()?}) → V
Updates the value for the provided key.
inherited
updateAll(V update(K key, V value)) → void
Updates all values.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](Object? key) → V?
The value for the given key, or null if key is not in the map.
override
operator []=(K key, V value) → void
Associates the key with the given value.
override

Static Methods

of<K, V>(Map<K, V> map) → RxMap<K, V>
Creates a RxMap from a map. {@tool snippet}