Docs for m2-core, m2-components
  1. Classes
  2. MapUtils

File

projects/m2-core/src/lib/core/utils/map.utils.ts

Index

Methods

Methods

Static addToArray
addToArray(map: Map, key: K, value: V)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | V[]> No
key K No
value V No
Returns : void
Static countKey
countKey(map: Map, key: K)
Type parameters :
  • K
Parameters :
Name Type Optional
map Map<K | number> No
key K No
Returns : void
Static delete
delete(map: Map, keys: T[] | Set)
Type parameters :
  • T
Parameters :
Name Type Optional
map Map<T | any> No
keys T[] | Set<T> No
Returns : void
Static deleteAllExcept
deleteAllExcept(map: Map, keys: T[] | Set)
Type parameters :
  • T
Parameters :
Name Type Optional
map Map<T | any> No
keys T[] | Set<T> No
Returns : void
Static deleteEntries
deleteEntries(map: Map, predicate: (key: K,value: V) => void)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | V> No
predicate function No
Returns : V[]
Static extract
extract(map: Map, key: K)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | V> No
key K No
Returns : V | undefined
Static findValue
findValue(map: Map, predicate: (v: T) => void)
Type parameters :
  • T

{T} The first value that matches the predicate

Parameters :
Name Type Optional
map Map<any | T> No
predicate function No
Returns : T
Static getKeysArray
getKeysArray(map: Map)
Type parameters :
  • T
Parameters :
Name Type Optional
map Map<T | any> No
Returns : T[]
Static getOrCreateValueArray
getOrCreateValueArray(map: Map>, key: K)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | Array<V>> No
key K No
Returns : V[]
Static getOrCreateValueMap
getOrCreateValueMap(map: Map>, key: K)
Type parameters :
  • K
  • T
  • V
Parameters :
Name Type Optional
map Map<K | Map<T, V>> No
key K No
Returns : Map<T, V>
Static getOrCreateValueNumberMap
getOrCreateValueNumberMap(map: Map<K | NumberMap<V>>, key: K)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | NumberMap<V>> No
key K No
Returns : NumberMap<V>
Static getOrCreateValueSet
getOrCreateValueSet(map: Map>, key: K)
Type parameters :
  • K
  • V
Parameters :
Name Type Optional
map Map<K | Set<V>> No
key K No
Returns : Set<V>
Static getValuesArray
getValuesArray(map: Map)
Type parameters :
  • T
Parameters :
Name Type Optional
map Map<any | T> No
Returns : T[]
Static isEmpty
isEmpty(map: Map)
Parameters :
Name Type Optional
map Map<any | any> No
Returns : boolean
Static mapToObject
mapToObject(map: Map)
Parameters :
Name Type Optional
map Map<any | any> No
Returns : Object
Static merge
merge(map1: Map, map2: Map, override?: boolean)
Type parameters :
  • K
  • V

Adds entries of the second map at the end of the first one.

Parameters :
Name Type Optional
map1 Map<K | V> No
map2 Map<K | V> No
override boolean Yes
Returns : void
Static objectToMap
objectToMap(obj: Object, numericKeys, valueMapperFn?: (value?: any) => void)
Type parameters :
  • V
Parameters :
Name Type Optional Default value
obj Object No
numericKeys No true
valueMapperFn function Yes
Returns : Map<any, V>
Static objectToNumberMap
objectToNumberMap(obj: Object, valueMapperFn?: (value?: V) => void)
Type parameters :
  • V
  • T
Parameters :
Name Type Optional
obj Object No
valueMapperFn function Yes
Returns : NumberMap<T>
Static prepareValuesMap
prepareValuesMap(keys: number[])
Type parameters :
  • V

Initializes indexed values array for each key

Parameters :
Name Type Optional
keys number[] No
Returns : NumberMap<V[]>

results matching ""

    No results matching ""