@sora-soft/framework

---

@sora-soft/framework / ArrayMap

Class: ArrayMap<K, T>

Defined in: packages/framework/src/utility/Utility.ts:190

Extends

• Map<K, T[]>

Type Parameters

Type Parameter
K
T

Constructors

Constructor

new ArrayMap<K, T>(): ArrayMap<K, T>;

Defined in: packages/framework/src/utility/Utility.ts:191

Returns

ArrayMap<K, T>

Overrides

Map<K, T[]>.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
[toStringTag]	readonly	string	ArrayMap.[toStringTag]	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
size	readonly	number	ArrayMap.size	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:45
[species]	readonly	MapConstructor	Map.[species]	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319

Methods

[iterator]()

iterator: MapIterator<[K, T[]]>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

Returns an iterable of entries in the map.

Returns

MapIterator<[K, T[]]>

Inherited from

Map.[iterator]

---

append()

append(k, value): void;

Defined in: packages/framework/src/utility/Utility.ts:195

Parameters

Parameter	Type
k	K
value	T

Returns

void

---

clear()

clear(): void;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:20

Returns

void

Inherited from

Map.clear

---

delete()

delete(key): boolean;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters

Parameter	Type
key	K

Returns

boolean

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

Inherited from

Map.delete

---

entries()

entries(): MapIterator<[K, T[]]>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

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

Returns

MapIterator<[K, T[]]>

Inherited from

Map.entries

---

forEach()

forEach(callbackfn, thisArg?): void;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

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

Parameters

Parameter	Type
callbackfn	(value, key, map) => void
thisArg?	any

Returns

void

Inherited from

Map.forEach

---

get()

get(key): T[] | undefined;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:33

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

Parameter	Type
key	K

Returns

T[] | undefined

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): boolean;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:37

Parameters

Parameter	Type
key	K

Returns

boolean

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

Inherited from

Map.has

---

keys()

keys(): MapIterator<K>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

Returns an iterable of keys in the map

Returns

MapIterator<K>

Inherited from

Map.keys

---

remove()

remove(k, value): void;

Defined in: packages/framework/src/utility/Utility.ts:208

Parameters

Parameter	Type
k	K
value	T

Returns

void

---

set()

set(key, value): this;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:41

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

Parameter	Type
key	K
value	T[]

Returns

this

Inherited from

Map.set

---

sureGet()

sureGet(k): T[];

Defined in: packages/framework/src/utility/Utility.ts:204

Parameters

Parameter	Type
k	K

Returns

T[]

---

values()

values(): MapIterator<T[]>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

Returns an iterable of values in the map

Returns

MapIterator<T[]>

Inherited from

Map.values

---

groupBy()

static groupBy<K, T>(items, keySelector): Map<K, T[]>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Groups members of an iterable according to the return value of the passed callback.

Type Parameters

Type Parameter
K
T

Parameters

Parameter	Type	Description
items	Iterable<T>	An iterable.
keySelector	(item, index) => K	A callback which will be invoked for each item in items.

Returns

Map<K, T[]>

Inherited from

Map.groupBy