IReadOnlyObservableMap

API / IReadOnlyObservableMap<TKey, TItem> interface

Represents a read-only observable map based on the Map interface.

Extends Iterable<[TKey, TItem]>, INotifyPropertiesChanged, INotifyMapChanged<TKey, TItem>.

interface IReadOnlyObservableMap<TKey, TItem>
    extends Iterable<[TKey, TItem]>, INotifyPropertiesChanged, INotifyMapChanged<TKey, TItem>

Source reference: src/collections/observableMap/IReadOnlyObservableMap.ts:9.

Generic Parameters

• TKey - The type of keys the map contains.

• TItem - The type of items the map contains.

Properties

• readonly size - Gets the number of entries in the map.
• inherited readonly mapChanged - An event that is raised when the map changed by adding or removing entries.
• inherited readonly propertiesChanged - An event that is raised when one or more properties may have changed.

Methods

• [iterator] - Gets an iterator that provides each element in the map in an key-item tupple.
• entries - Gets an iterator that provides each element in the map in an key-item tupple.
• forEach - Iterates over the entire map executing the callback for each pair.
• get - Looks up provided key and returns the associated item if one exists; otherwise undefined.
• has - Checks whether there is a value associated with the provided key.
• keys - Gets an iterator that provides each key in the map.
• toMap - Converts the observable map to a native JavaScript Map.
• values - Gets an iterator that provides each item in the map.

Implementations

• ObservableMap<TKey, TItem>
• ReadOnlyObservableMap<TKey, TItem>