@valkyriestudios/utils 12.6.1 → 12.7.0

package/array/groupBy.d.ts

@@ -1,3 +1,23 @@
 type Handler<T> = (val: T) => string | number | boolean;
+/**
+ * Return a grouped object from an array.
+ * Take Note: This function will automatically filter out any non/empty objects from the array
+ *
+ * Example:
+ *  const group = groupBy([
+ *      {tally: 20, name: 'Peter'},
+ *      {tally: 40, name: 'Jake'},
+ *      {tally: 5, name: 'Bob'},
+ *  ], el => el.tally > 15);
+ * Output:
+ *  {
+ *      false: [{tally: 5, name: 'Bob'}],
+ *      true: [{tally: 20, name: 'Peter'}, {tally: 40, name: 'Jake'}],
+ *  }
+ *
+ * @param {T[]} arr - Array to group
+ * @param {Handler<T>|string} handler - String or a function, determines what to group by
+ * @returns {Record<string, T[]>}
+ */
 declare function groupBy<T extends Record<string, any>>(arr: T[], handler: Handler<T> | string): Record<string, T[]>;
 export { groupBy, groupBy as default };

package/array/groupBy.js

@@ -10,23 +10,23 @@ function groupBy(arr, handler) {
     const acc = {};
     const n_handler = typeof handler === 'function'
         ? handler
-        : typeof handler === 'string' && handler.length
-            ? ((el) => el[handler] ?? FALLBACK)
+        : typeof handler === 'string'
+            ? ((el) => el[handler])
             : defaultHandler;
     let key;
-    const set = new Set();
-    for (const el of arr) {
+    let el;
+    for (let i = 0; i < arr.length; i++) {
+        el = arr[i];
         if (!(0, isNotEmpty_1.isNotEmptyObject)(el))
             continue;
         key = n_handler(el);
         if (key === undefined || (typeof key === 'string' && !key.length))
             key = FALLBACK;
-        if (set.has(key)) {
+        if (Array.isArray(acc[key])) {
             acc[key].push(el);
             continue;
         }
         acc[key] = [el];
-        set.add(key);
     }
     return acc;
 }

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.6.1", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.7.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }