JsBackedMap class

A view into a JavaScript object (jsObject) that conforms to the Dart Map interface.

The keys are all enumerable properties of the jsObject, though non-enumerable properties may also be accessed. For this reason, it is recommended to use plain, simple JavaScript objects.

Keys should be strings, as any other object (primitive or non-primitive), will be coerced by JavaScript to a string upon read/write. This includes null, which gets coerced to the string 'null'.

For performance reasons, keys are not validated.

Iteration order is arbitrary, and is based on the current browser's implementation.

Two JsBackedMap instances are considered equal if they are backed by the same jsObject.

Inheritance

Constructors

JsBackedMap()
Creates a JsBackedMap instance backed by a new jsObject.
JsBackedMap.backedBy(JsMap jsObject)
Creates a JsBackedMap instance backed by jsObject.
JsBackedMap.from(Map other)
Creates a JsBackedMap instance that contains all key/value pairs of other.
factory
JsBackedMap.fromJs(JsMap jsOther)
Creates a JsBackedMap instance that contains all key/value pairs of the JS object jsOther.
factory

Properties

entries → Iterable<MapEntry>
The map entries of this Map.
no setterinherited
hashCode → int
The hash code for this object.
no setteroverride
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
jsObject → JsMap
final
keys → Iterable
The keys of this Map.
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
values → Iterable
The values of this Map.
no setteroverride

Methods

addAll(Map other) → void
Adds all key/value pairs of other to this map.
override
addAllFromJs(JsMap jsOther) → void
Adds all key/value pairs of the JS object jsOther to this map.
addEntries(Iterable<MapEntry> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
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.
override
containsValue(Object? value) → bool
Whether this map contains the given value.
override
forEach(void action(dynamic key, dynamic value)) → void
Applies action to each key/value pair of the map.
inherited
map<K2, V2>(MapEntry<K2, V2> transform(dynamic key, dynamic value)) → Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putIfAbsent(dynamic key, dynamic ifAbsent()) → dynamic
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → dynamic
Removes key and its associated value, if present, from the map.
override
removeWhere(bool test(dynamic key, dynamic value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() → String
A string representation of this object.
inherited
update(dynamic key, dynamic update(dynamic value), {dynamic ifAbsent()?}) → dynamic
Updates the value for the provided key.
inherited
updateAll(dynamic update(dynamic key, dynamic value)) → void
Updates all values.
inherited

Operators

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