Class MapEx<T>

Extended Map class with additional features and change event emitter.

Type Parameters

T extends MapExItem

Hierarchy

Map<T["id"], T>
- MapEx

Index

Constructors

Properties

[toStringTag] change size [species]

Accessors

Methods

[iterator] clear delete entries forEach get has keys set values

Constructors

constructor

new MapEx<T extends MapExItem>(
entries?: null | readonly (readonly [T["id"], T])[],
): MapEx<T>
Type Parameters
- T extends MapExItem
Parameters
- Optionalentries: null | readonly (readonly [T["id"], T])[]
Returns MapEx<T>
Inherited from Map<T['id'], T>.constructor
new MapEx<T extends MapExItem>(
iterable?: null | Iterable<readonly [T["id"], T], any, any>,
): MapEx<T>
Type Parameters
- T extends MapExItem
Parameters
- Optionaliterable: null | Iterable<readonly [T["id"], T], any, any>
Returns MapEx<T>
Inherited from Map<T['id'], T>.constructor

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`change

change: EventEmitter<MapEx<T>> = ...

Emits when a change happens in this map.

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

list

get list(): T[]
Returns T[]
array of values.

Methods

[iterator]

"[iterator]"(): MapIterator<[T["id"], T]>
Returns an iterable of entries in the map.

Returns MapIterator<[T["id"], T]>
Inherited from Map.[iterator]

clear

clear(): void
Clears all items from the map and updates the list. Emits the change event.

Returns void
Overrides Map.clear

delete

delete(id: PK): boolean
Deletes an item from the map by its id, updates the list, and triggers the onChange callback.
Parameters
- id: PK
  The id of the item to be deleted.
Returns boolean
True if the item was successfully deleted, false otherwise.

Overrides Map.delete

entries

entries(): MapIterator<[T["id"], T]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[T["id"], T]>
Inherited from Map.entries

forEach

forEach(
callbackfn: (value: T, key: T["id"], map: Map<T["id"], T>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: T, key: T["id"], map: Map<T["id"], T>) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach

get

get(key: T["id"]): undefined | T
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: T["id"]
Returns undefined | T
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

Inherited from Map.get

has

has(key: T["id"]): boolean
Parameters
- key: T["id"]
Returns boolean
boolean indicating whether an element with the specified key exists or not.

Inherited from Map.has

keys

keys(): MapIterator<T["id"]>
Returns an iterable of keys in the map

Returns MapIterator<T["id"]>
Inherited from Map.keys

set

set(id: PK, item: T): this
Sets or updates an item in the map, updates the list, and triggers the onChange callback.
Parameters
- id: PK
  The id for the item.
- item: T
  The item to be added or updated.
Returns this
The MapEx instance for method chaining.

Overrides Map.set

values

values(): MapIterator<T>
Returns an iterable of values in the map

Returns MapIterator<T>
Inherited from Map.values