Interface ReadonlyReactiveMap<K, V>

Readonly$

Readonlysize

[iterator]

• "[iterator]"(): MapIterator<[K, V]>

  Returns an iterable of entries in the map.

  Returns MapIterator<[K, V]>

entries

• entries(): MapIterator<[K, V]>

  Returns an iterable of key, value pairs for every entry in the map.

  Returns MapIterator<[K, V]>

forEach

• forEach(
      callbackfn: (value: V, key: K, map: ReadonlyMap<K, V>) => void,
      thisArg?: any,
  ): void

  Parameters

  • callbackfn: (value: V, key: K, map: ReadonlyMap<K, V>) => void
  • OptionalthisArg: any

  Returns void

get

• get(key: K): undefined | V

  Parameters

  • key: K

  Returns undefined | V

has

• has(key: K): boolean

  Parameters

  • key: K

  Returns boolean

keys

• keys(): MapIterator<K>

  Returns an iterable of keys in the map

  Returns MapIterator<K>

onChanged

• onChanged(fn: (changed: ReactiveMapChanged<K, V>) => void): RemoveListener

  Subscribe to changes in the map.

  Parameters

  • fn: (changed: ReactiveMapChanged<K, V>) => void

    The function to call when the map is changed.

  Returns RemoveListener

  A disposer function to unsubscribe from the event.

onDisposeValue

• onDisposeValue(fn: (value: V) => void): RemoveListener

  Subscribe to events when a value is needed to be disposed.

  A value is considered for disposal when:

  • it is deleted from the map.
  • it is replaced by another value (the old value is removed).
  • it is cleared from the map.
  • the map is disposed.

  Note that for performance reasons, it does not handle the case where multiple keys map to the same value.

  Parameters

  • fn: (value: V) => void

    The function to call when a value is needed to be disposed.

  Returns RemoveListener

  A disposer function to unsubscribe from the event.

values

• values(): MapIterator<V>

  Returns an iterable of values in the map

  Returns MapIterator<V>