@trackunit/shared-utils 0.0.13 → 0.0.14

package/index.cjs.js

@@ -423,24 +423,28 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @template T The type of items in the list.
+ * @template K The type of the key.
+ * @param {T[]} list The array of items to group.
+ * @param {(item: T) => K} getKey A function to get the key to group by.
+ * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @example
+ * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
+ * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
 function groupBy(list, getKey) {
-    const map = new Map();
+    const groupedMap = new Map();
     list.forEach(item => {
         const key = getKey(item);
-        const collection = map.get(key);
+        const collection = groupedMap.get(key);
         if (!collection) {
-            map.set(key, [item]);
+            groupedMap.set(key, [item]);
         }
         else {
             collection.push(item);
         }
     });
-    return map;
+    return groupedMap;
 }
 
 const UUID_HYPHEN_POSITIONS = [8, 12, 16, 20];

package/index.esm.js

@@ -419,24 +419,28 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @template T The type of items in the list.
+ * @template K The type of the key.
+ * @param {T[]} list The array of items to group.
+ * @param {(item: T) => K} getKey A function to get the key to group by.
+ * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @example
+ * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
+ * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
 function groupBy(list, getKey) {
-    const map = new Map();
+    const groupedMap = new Map();
     list.forEach(item => {
         const key = getKey(item);
-        const collection = map.get(key);
+        const collection = groupedMap.get(key);
         if (!collection) {
-            map.set(key, [item]);
+            groupedMap.set(key, [item]);
         }
         else {
             collection.push(item);
         }
     });
-    return map;
+    return groupedMap;
 }
 
 const UUID_HYPHEN_POSITIONS = [8, 12, 16, 20];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/groupBy/groupBy.d.ts

@@ -1,9 +1,13 @@
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @template T The type of items in the list.
+ * @template K The type of the key.
+ * @param {T[]} list The array of items to group.
+ * @param {(item: T) => K} getKey A function to get the key to group by.
+ * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @example
+ * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
+ * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
 export declare function groupBy<T, K>(list: T[], getKey: (item: T) => K): Map<K, T[]>;