@valkyriestudios/utils 12.4.0 → 12.6.0

package/README.md

@@ -30,7 +30,7 @@ isNotEmptyArray([]); // FALSE
 isNotEmptyArray([0, 1, 2]); // TRUE
 ```
 
-- **mapKey(val:array[Object], key:string, opts:object={})**
+- **mapKey(val:Record[], key:string, opts:object={})**
 Map a non-primitive object array into an object map by key
 ```js
 mapKey([
@@ -99,7 +99,7 @@ output:
 }
 ```
 
-- **mapFn(val:array[Object], key:Function, opts:object={})**
+- **mapFn(val:Record[], key:Function, opts:object={})**
 Same behavior as mapKey but instead of a key, a function is passed to generate your own key. Eg:
 
 ```js
@@ -120,7 +120,7 @@ output:
 
 options are the same as the mapKey function
 
-- **mapPrimitive(val:any, opts:object={valtrim:false,keyround:false,valround:false})**
+- **mapPrimitive(val:any[], opts:object={valtrim:false,keyround:false,valround:false})**
 Map an array of primitives (number/string)
 ```js
 mapPrimitive([1,2,3]); // {1: 1, 2: 2, 3: 3}
@@ -128,6 +128,62 @@ mapPrimitive(['hello', 'hello', 'foo', 'bar']); // {hello: 'hello', foo: 'foo',
 mapPrimitive(['hello', ' hello', 'foo', '  foo'], {valtrim: true}); // {hello: 'hello', foo: 'foo'}
 ```
 
+- **groupBy(val:Record[], handler:Function|string)**
+Return a grouped object from an array. This function **will automatically filter out any non/empty objects**.
+
+Example usage when using a **function** as the handler
+```typescript
+/* The output of the function will be what the key is on the map  */
+const group = groupBy([
+    {tally: 20, name: 'Peter'},
+    {tally: 40, name: 'Jake'},
+    {tally: 5, name: 'Bob'},
+], el => el.tally > 15);
+
+/* Expected output: */
+{
+    false: [{tally: 5, name: 'Bob'}],
+    true: [{tally: 20, name: 'Peter'}, {tally: 40, name: 'Jake'}],
+}
+
+/* Can also work with a property return  */
+const group = groupBy([
+    {role: 'user', name: 'Peter'},
+    {role: 'user', name: 'Jake'},
+    {role: 'guest', name: 'Bob'},
+    {name: 'Alice'},
+], el => el.role || 'other');
+
+/* Expected output: */
+{
+    user: [{role: 'user', name: 'Peter'}, {role: 'user', name: 'Jake'}],
+    guest: [{role: 'guest', name: 'Bob'}],
+    other: [{name: 'Alice'}],
+}
+```
+**Take note**: If the function returns an undefined or empty string the object will be added to a fallback group called '_'
+
+
+Example usage when using a **string** as the handler to denote a grouping by a certain property name
+```typescript
+const group = groupBy([
+    {role: 'user', name: 'Peter'},
+    {role: 'user', name: 'Jake'},
+    {role: 'guest', name: 'Bob'},
+    {name: 'Alice'},
+], 'role');
+
+/* Expected output: */
+{
+    user: [{role: 'user', name: 'Peter'}, {role: 'user', name: 'Jake'}],
+    guest: [{role: 'guest', name: 'Bob'}],
+    _: [{name: 'Alice'}],
+}
+```
+
+**Take note**: any object without the key will be added to a fallback group called '_'
+
+
 - **dedupe(val:Array)**
 Remove all duplicates from an array, behind the scenes it uses the fnv 1A hash algorithm to performantly do comparisons.
 ```js
@@ -278,7 +334,7 @@ const memoized_function = memoize((a) => {
 - **isDate(val:any)**
 Check if a variable is of type Date
 ```js
-isDate(new Date('December 17, 1995 03:24:00'); // TRUE
+isDate(new Date('December 17, 1995 03:24:00')); // TRUE
 isDate('December 17, 1995 03:24:00'); // FALSE
 ```
 
@@ -545,6 +601,14 @@ An empty function that returns a promise that will immediately resolve itself an
 An empty function that returns a promise that will resolve after X milliseconds, default is set to 1000ms.
 **
 
+### formdata
+- **isFormData(val:any)**
+Check if a variable is of type FormData
+```js
+isFormData(new FormData()); // TRUE
+isFormData({hi: 'there'}); // FALSE
+```
+
 ### hash
 - **guid()**
 Generate a unique identifier (guid) according to RFC4122

package/dist/array/groupBy.d.ts

@@ -0,0 +1,3 @@
+type Handler<T> = (val: T) => string | number | boolean;
+declare function groupBy<T extends Record<string, any>>(arr: T[], handler: Handler<T> | string): Record<string, T[]>;
+export { groupBy, groupBy as default };

package/dist/array/groupBy.js

@@ -0,0 +1,34 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.groupBy = void 0;
+const isNotEmpty_1 = require("../object/isNotEmpty");
+const FALLBACK = '_';
+const defaultHandler = () => FALLBACK;
+function groupBy(arr, handler) {
+    if (!Array.isArray(arr))
+        return {};
+    const acc = {};
+    const n_handler = typeof handler === 'function'
+        ? handler
+        : typeof handler === 'string' && handler.length
+            ? ((el) => el[handler] ?? FALLBACK)
+            : defaultHandler;
+    let key;
+    const set = new Set();
+    for (const el of arr) {
+        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)) {
+            acc[key].push(el);
+            continue;
+        }
+        acc[key] = [el];
+        set.add(key);
+    }
+    return acc;
+}
+exports.groupBy = groupBy;
+exports.default = groupBy;

package/dist/array/index.d.ts

@@ -0,0 +1,11 @@
+import { dedupe } from './dedupe';
+import { isArray } from './is';
+import { isNotEmptyArray } from './isNotEmpty';
+import { join } from './join';
+import { mapFn } from './mapFn';
+import { mapKey } from './mapKey';
+import { mapPrimitive } from './mapPrimitive';
+import { groupBy } from './groupBy';
+import { shuffle } from './shuffle';
+import { sort } from './sort';
+export { dedupe, isArray, isArray as is, isNotEmptyArray, isNotEmptyArray as isNotEmpty, isNotEmptyArray as isNeArray, isNotEmptyArray as isNe, join, mapFn, mapKey, mapPrimitive, groupBy, shuffle, sort };

package/dist/array/index.js

@@ -0,0 +1,27 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sort = exports.shuffle = exports.groupBy = exports.mapPrimitive = exports.mapKey = exports.mapFn = exports.join = exports.isNe = exports.isNeArray = exports.isNotEmpty = exports.isNotEmptyArray = exports.is = exports.isArray = exports.dedupe = void 0;
+const dedupe_1 = require("./dedupe");
+Object.defineProperty(exports, "dedupe", { enumerable: true, get: function () { return dedupe_1.dedupe; } });
+const is_1 = require("./is");
+Object.defineProperty(exports, "isArray", { enumerable: true, get: function () { return is_1.isArray; } });
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return is_1.isArray; } });
+const isNotEmpty_1 = require("./isNotEmpty");
+Object.defineProperty(exports, "isNotEmptyArray", { enumerable: true, get: function () { return isNotEmpty_1.isNotEmptyArray; } });
+Object.defineProperty(exports, "isNotEmpty", { enumerable: true, get: function () { return isNotEmpty_1.isNotEmptyArray; } });
+Object.defineProperty(exports, "isNeArray", { enumerable: true, get: function () { return isNotEmpty_1.isNotEmptyArray; } });
+Object.defineProperty(exports, "isNe", { enumerable: true, get: function () { return isNotEmpty_1.isNotEmptyArray; } });
+const join_1 = require("./join");
+Object.defineProperty(exports, "join", { enumerable: true, get: function () { return join_1.join; } });
+const mapFn_1 = require("./mapFn");
+Object.defineProperty(exports, "mapFn", { enumerable: true, get: function () { return mapFn_1.mapFn; } });
+const mapKey_1 = require("./mapKey");
+Object.defineProperty(exports, "mapKey", { enumerable: true, get: function () { return mapKey_1.mapKey; } });
+const mapPrimitive_1 = require("./mapPrimitive");
+Object.defineProperty(exports, "mapPrimitive", { enumerable: true, get: function () { return mapPrimitive_1.mapPrimitive; } });
+const groupBy_1 = require("./groupBy");
+Object.defineProperty(exports, "groupBy", { enumerable: true, get: function () { return groupBy_1.groupBy; } });
+const shuffle_1 = require("./shuffle");
+Object.defineProperty(exports, "shuffle", { enumerable: true, get: function () { return shuffle_1.shuffle; } });
+const sort_1 = require("./sort");
+Object.defineProperty(exports, "sort", { enumerable: true, get: function () { return sort_1.sort; } });

package/dist/boolean/index.d.ts

@@ -0,0 +1,2 @@
+import { isBoolean } from './is';
+export { isBoolean, isBoolean as is };

package/dist/boolean/index.js

@@ -0,0 +1,6 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.is = exports.isBoolean = void 0;
+const is_1 = require("./is");
+Object.defineProperty(exports, "isBoolean", { enumerable: true, get: function () { return is_1.isBoolean; } });
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return is_1.isBoolean; } });

package/dist/caching/index.d.ts

@@ -0,0 +1,2 @@
+import { memoize } from './memoize';
+export { memoize };

package/dist/caching/index.js

@@ -0,0 +1,5 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.memoize = void 0;
+const memoize_1 = require("./memoize");
+Object.defineProperty(exports, "memoize", { enumerable: true, get: function () { return memoize_1.memoize; } });

package/dist/date/index.d.ts

@@ -0,0 +1,11 @@
+import { addUTC } from './addUTC';
+import { diff } from './diff';
+import { endOfUTC } from './endOfUTC';
+import { format } from './format';
+import { isDate } from './is';
+import { nowUnix } from './nowUnix';
+import { nowUnixMs } from './nowUnixMs';
+import { startOfUTC } from './startOfUTC';
+import { toUnix } from './toUnix';
+import { toUTC } from './toUTC';
+export { addUTC, diff, endOfUTC, format, isDate, isDate as is, nowUnix, nowUnixMs, startOfUTC, toUnix, toUTC };

package/dist/date/index.js

@@ -0,0 +1,24 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUTC = exports.toUnix = exports.startOfUTC = exports.nowUnixMs = exports.nowUnix = exports.is = exports.isDate = exports.format = exports.endOfUTC = exports.diff = exports.addUTC = void 0;
+const addUTC_1 = require("./addUTC");
+Object.defineProperty(exports, "addUTC", { enumerable: true, get: function () { return addUTC_1.addUTC; } });
+const diff_1 = require("./diff");
+Object.defineProperty(exports, "diff", { enumerable: true, get: function () { return diff_1.diff; } });
+const endOfUTC_1 = require("./endOfUTC");
+Object.defineProperty(exports, "endOfUTC", { enumerable: true, get: function () { return endOfUTC_1.endOfUTC; } });
+const format_1 = require("./format");
+Object.defineProperty(exports, "format", { enumerable: true, get: function () { return format_1.format; } });
+const is_1 = require("./is");
+Object.defineProperty(exports, "isDate", { enumerable: true, get: function () { return is_1.isDate; } });
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return is_1.isDate; } });
+const nowUnix_1 = require("./nowUnix");
+Object.defineProperty(exports, "nowUnix", { enumerable: true, get: function () { return nowUnix_1.nowUnix; } });
+const nowUnixMs_1 = require("./nowUnixMs");
+Object.defineProperty(exports, "nowUnixMs", { enumerable: true, get: function () { return nowUnixMs_1.nowUnixMs; } });
+const startOfUTC_1 = require("./startOfUTC");
+Object.defineProperty(exports, "startOfUTC", { enumerable: true, get: function () { return startOfUTC_1.startOfUTC; } });
+const toUnix_1 = require("./toUnix");
+Object.defineProperty(exports, "toUnix", { enumerable: true, get: function () { return toUnix_1.toUnix; } });
+const toUTC_1 = require("./toUTC");
+Object.defineProperty(exports, "toUTC", { enumerable: true, get: function () { return toUTC_1.toUTC; } });

package/dist/deep/index.d.ts

@@ -0,0 +1,5 @@
+import { deepFreeze } from './freeze';
+import { deepGet } from './get';
+import { deepSeal } from './seal';
+import { deepSet } from './set';
+export { deepFreeze as freeze, deepFreeze, deepGet as get, deepGet, deepSeal as seal, deepSeal, deepSet as set, deepSet };

package/dist/deep/index.js

@@ -0,0 +1,15 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepSet = exports.set = exports.deepSeal = exports.seal = exports.deepGet = exports.get = exports.deepFreeze = exports.freeze = void 0;
+const freeze_1 = require("./freeze");
+Object.defineProperty(exports, "freeze", { enumerable: true, get: function () { return freeze_1.deepFreeze; } });
+Object.defineProperty(exports, "deepFreeze", { enumerable: true, get: function () { return freeze_1.deepFreeze; } });
+const get_1 = require("./get");
+Object.defineProperty(exports, "get", { enumerable: true, get: function () { return get_1.deepGet; } });
+Object.defineProperty(exports, "deepGet", { enumerable: true, get: function () { return get_1.deepGet; } });
+const seal_1 = require("./seal");
+Object.defineProperty(exports, "seal", { enumerable: true, get: function () { return seal_1.deepSeal; } });
+Object.defineProperty(exports, "deepSeal", { enumerable: true, get: function () { return seal_1.deepSeal; } });
+const set_1 = require("./set");
+Object.defineProperty(exports, "set", { enumerable: true, get: function () { return set_1.deepSet; } });
+Object.defineProperty(exports, "deepSet", { enumerable: true, get: function () { return set_1.deepSet; } });

package/dist/formdata/index.d.ts

@@ -0,0 +1,2 @@
+import { isFormData } from './is';
+export { isFormData, isFormData as is };

package/dist/formdata/index.js

@@ -0,0 +1,6 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.is = exports.isFormData = void 0;
+const is_1 = require("./is");
+Object.defineProperty(exports, "isFormData", { enumerable: true, get: function () { return is_1.isFormData; } });
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return is_1.isFormData; } });

package/dist/formdata/is.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Check whether or not a provided value is an instance of FormData
+ *
+ * @param val - Value to verify
+ *
+ * @returns Whether or not the value is an instance of FormData
+ */
+declare function isFormData(val: unknown): val is FormData;
+export { isFormData, isFormData as default };

package/dist/formdata/is.js

@@ -0,0 +1,8 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.isFormData = void 0;
+function isFormData(val) {
+    return val instanceof FormData;
+}
+exports.isFormData = isFormData;
+exports.default = isFormData;

package/dist/function/index.d.ts

@@ -0,0 +1,7 @@
+import { isFunction } from './is';
+import { isAsyncFunction } from './isAsync';
+import { noop } from './noop';
+import { noopresolve } from './noopresolve';
+import { noopreturn } from './noopreturn';
+import { sleep } from './sleep';
+export { isFunction, isFunction as is, isFunction as isFn, isAsyncFunction, isAsyncFunction as isAsync, isAsyncFunction as isAsyncFn, noop, noopresolve, noopreturn, sleep };

package/dist/function/index.js

@@ -0,0 +1,19 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = exports.noopreturn = exports.noopresolve = exports.noop = exports.isAsyncFn = exports.isAsync = exports.isAsyncFunction = exports.isFn = exports.is = exports.isFunction = void 0;
+const is_1 = require("./is");
+Object.defineProperty(exports, "isFunction", { enumerable: true, get: function () { return is_1.isFunction; } });
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return is_1.isFunction; } });
+Object.defineProperty(exports, "isFn", { enumerable: true, get: function () { return is_1.isFunction; } });
+const isAsync_1 = require("./isAsync");
+Object.defineProperty(exports, "isAsyncFunction", { enumerable: true, get: function () { return isAsync_1.isAsyncFunction; } });
+Object.defineProperty(exports, "isAsync", { enumerable: true, get: function () { return isAsync_1.isAsyncFunction; } });
+Object.defineProperty(exports, "isAsyncFn", { enumerable: true, get: function () { return isAsync_1.isAsyncFunction; } });
+const noop_1 = require("./noop");
+Object.defineProperty(exports, "noop", { enumerable: true, get: function () { return noop_1.noop; } });
+const noopresolve_1 = require("./noopresolve");
+Object.defineProperty(exports, "noopresolve", { enumerable: true, get: function () { return noopresolve_1.noopresolve; } });
+const noopreturn_1 = require("./noopreturn");
+Object.defineProperty(exports, "noopreturn", { enumerable: true, get: function () { return noopreturn_1.noopreturn; } });
+const sleep_1 = require("./sleep");
+Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return sleep_1.sleep; } });

package/dist/hash/index.d.ts

@@ -0,0 +1,3 @@
+import { fnv1A } from './fnv1A';
+import { guid } from './guid';
+export { fnv1A, guid };

package/dist/hash/index.js

@@ -0,0 +1,7 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guid = exports.fnv1A = void 0;
+const fnv1A_1 = require("./fnv1A");
+Object.defineProperty(exports, "fnv1A", { enumerable: true, get: function () { return fnv1A_1.fnv1A; } });
+const guid_1 = require("./guid");
+Object.defineProperty(exports, "guid", { enumerable: true, get: function () { return guid_1.guid; } });