Class ObservableMap<K, V>

constructor

• new ObservableMap<K = any, V = any>(
      initialData?: IObservableMapInitialValues<K, V>,
      enhancer?: IEnhancer<V>,
      name?: string,
  ): ObservableMap<K, V>

  Type Parameters

  • K = any
  • V = any

  Parameters

  • OptionalinitialData: IObservableMapInitialValues<K, V>
  • Optionalenhancer: IEnhancer<V>
  • Optionalname: string

  Returns ObservableMap<K, V>

[iterator]

[toStringTag]

$mobx

changeListeners

dehancer

enhancer

interceptors

name

size

• get size(): number

  Returns number

  the number of elements in the Map.

clear

• clear(): void

  Returns void

delete

• delete(key: K): boolean

  Parameters

  • key: K

  Returns boolean

  true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

• entries(): IterableIterator<IMapEntry<K, V>>

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

  Returns IterableIterator<IMapEntry<K, V>>

forEach

• forEach(
      callback: (value: V, key: K, object: Map<K, V>) => void,
      thisArg?: any,
  ): void

  Executes a provided function once per each key/value pair in the Map, in insertion order.

  Parameters

  • callback: (value: V, key: K, object: Map<K, V>) => void
  • OptionalthisArg: any

  Returns void

get

• get(key: K): undefined | V

  Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

  Parameters

  • key: K

  Returns undefined | V

  Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

• has(key: K): boolean

  Parameters

  • key: K

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

intercept

• intercept(handler: IInterceptor<IMapWillChange<K, V>>): Lambda

  Parameters

  • handler: IInterceptor<IMapWillChange<K, V>>

  Returns Lambda

keys

• keys(): IterableIterator<K>

  Returns an iterable of keys in the map

  Returns IterableIterator<K>

merge

• merge(other: any): ObservableMap<K, V>

  Merge another object into this object, returns this.

  Parameters

  • other: any

  Returns ObservableMap<K, V>

observe

• observe(
      listener: (changes: IMapDidChange<K, V>) => void,
      fireImmediately?: boolean,
  ): Lambda

  Observes this object. Triggers for the events 'add', 'update' and 'delete'. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/observe for callback details

  Parameters

  • listener: (changes: IMapDidChange<K, V>) => void
  • OptionalfireImmediately: boolean

  Returns Lambda

replace

• replace(values: any): ObservableMap<K, V>

  Parameters

  • values: any

  Returns ObservableMap<K, V>

set

• set(key: K, value: V): this

  Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

  Parameters

  • key: K
  • value: V

  Returns this

toJS

• toJS(): Map<K, V>

  Returns a shallow non observable object clone of this map. Note that the values migth still be observable. For a deep clone use mobx.toJS.

  Returns Map<K, V>

toJSON

• toJSON(): IKeyValueMap<V>

  Returns IKeyValueMap<V>

toPOJO

• toPOJO(): IKeyValueMap<V>

  Returns a plain object that represents this map. Note that all the keys being stringified. If there are duplicating keys after converting them to strings, behaviour is undetermined.

  Returns IKeyValueMap<V>

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

values

• values(): IterableIterator<V>

  Returns an iterable of values in the map

  Returns IterableIterator<V>