@mongez/reinforcements 2.2.8 → 2.3.1

package/README.md

@@ -384,9 +384,11 @@ const user = {
   },
 };
 
-const simpleUserData = unset(user, ["id", "address", "email"]); // { name: 'Hasan Zohdy', job: {title: 'Software Engineer'}}
+const unset(user, ["id", "address", "email"]); // { name: 'Hasan Zohdy', job: {title: 'Software Engineer'}}
 ```
 
+> The `unset` removes the keys from the object, but it doesn't return a new object, it modifies the original object and returns it, if you want to return a new object, use `except` method.
+
 ### Flatten objects
 
 We can flatten any big fat objects into one object, with only one dimension.
@@ -629,7 +631,8 @@ Now let's move to arrays utilities.
 - [Median](#median): Get the median of all values in an array or by given key.
 - [Unique](#unique): Get unique values from an array.
 - [Push Unique](#push-unique): Push a value or more to an array if it doesn't exist.
-- [Unshift Unique](#unshift-unique): Add a value or more to the beginning of an array if it doesn't exist.
+- [Unshift Unique](#unshift-unique): Add a value or more to the beginning of an array if it
+  doesn't exist.
 
 ### Pluck
 
@@ -674,7 +677,7 @@ Group by a single key:
 ```ts
 import { groupBy } from "@mongez/reinforcements";
 
- const studentsClasses = [
+const studentsClasses = [
   {
     id: 1,
     class: "A",
@@ -902,7 +905,7 @@ const studentsClasses = [
   },
 ];
 
-console.log(groupBy(studentsClasses, ["class", "grade"], 'students'));
+console.log(groupBy(studentsClasses, ["class", "grade"], "students"));
 ```
 
 Output:
@@ -1013,7 +1016,7 @@ const array = [
   { id: 5, value: 5 },
 ];
 
-console.log(count(array, (item) => item.value > 2)); // 3
+console.log(count(array, item => item.value > 2)); // 3
 ```
 
 ### Count By
@@ -1026,14 +1029,14 @@ Count total occurrence of values for the given key.
 import { countBy } from "@mongez/reinforcements";
 
 const array = [
-  { id: 1, animal: 'dog' },
-  { id: 2, animal: 'cat' },
-  { id: 3, animal: 'dog' },
-  { id: 4, animal: 'cat' },
-  { id: 5, animal: 'dog' },
+  { id: 1, animal: "dog" },
+  { id: 2, animal: "cat" },
+  { id: 3, animal: "dog" },
+  { id: 4, animal: "cat" },
+  { id: 5, animal: "dog" },
 ];
 
-console.log(countBy(array, 'animal')); // { dog: 3, cat: 2 }
+console.log(countBy(array, "animal")); // { dog: 3, cat: 2 }
 ```
 
 ### Even
@@ -1337,6 +1340,26 @@ const array = [1, 2, 3, 4, 5];
 console.log(unshiftUnique(array, 6, 7, 5, 6, 1, 2, 4, 3)); // [7, 6, 1, 2, 3, 4, 5]
 ```
 
+### Range
+
+> Added in v2.3.0
+
+Generates an array of numbers starting from the given min value to the given max value.
+
+`range(min: number, max: number): number[]`
+
+```ts
+import { range } from "@mongez/reinforcements";
+
+console.log(range(1, 6)); // [1, 2, 3, 4, 5, 6]
+
+console.log(range(3, 5)); // [3, 4, 5]
+```
+
+If the given `min` or `max` parameter is not a number, an error **will be thrown**.
+
+> Min value must be higher than max value.
+
 ## Working With Strings
 
 The following list defines all available string utilities
@@ -1410,7 +1433,7 @@ import { toSnakeCase } from "@mongez/reinforcements";
 
 const words = "hello world";
 
-console.log(toSnakeCase(words, '-')); // hello-world
+console.log(toSnakeCase(words, "-")); // hello-world
 ```
 
 Also setting the third argument to false will not convert letters to lower case, will keep each letter as its own.
@@ -1420,7 +1443,7 @@ import { toSnakeCase } from "@mongez/reinforcements";
 
 const words = "Hello World";
 
-console.log(toSnakeCase(words, '-', false)); // Hello_World
+console.log(toSnakeCase(words, "-", false)); // Hello_World
 ```
 
 ### Kebab Case
@@ -1758,7 +1781,7 @@ import { initials } from "@mongez/reinforcements";
 
 const name = "John Doe";
 
-console.log(initials(name, '.')); // J.D
+console.log(initials(name, ".")); // J.D
 ```
 
 If the given parameter is not a string it will throw an error.
@@ -1862,11 +1885,7 @@ The section covers general utilities that can be used in any project.
 
 You can debounce your functions using `debounce` to prevent multiple calls.
 
-> This debounce function will be called instantly and will not return a callback function.
-
 ```tsx
-import { debounce } from "@mongez/reinforcements";
-
 function sendEmail(e: any) {
   sendEmailApi(e.target);
 }
@@ -1882,14 +1901,14 @@ Now when using `debounce`
 import { debounce } from "@mongez/reinforcements";
 
 function sendEmail(e: any) {
-  debounce(() => {
-    sendEmailApi(e.target);
-  });
+  sendEmailApi(e.target);
 }
 
+const debouncedSendEmail = debounce(sendEmail);
+
 // If user clicked 5 times, it will make only one ajax call
 
-<button click={sendEmail}>Send Email</button>;
+<button click={debouncedSendEmail}>Send Email</button>;
 ```
 
 You can also set a timer when to trigger the function
@@ -1898,15 +1917,14 @@ You can also set a timer when to trigger the function
 import { debounce } from "@mongez/reinforcements";
 
 function sendEmail(e: any) {
-  // wait 3 seconds before calling the function
-  debounce(() => {
-    sendEmailApi(e.target);
-  }, 150);
+  sendEmailApi(e.target);
 }
 
+const debouncedSendEmail = debounce(sendEmail, 1000);
+
 // If user clicked 5 times, it will make only one ajax call
 
-<button click={sendEmail}>Send Email</button>;
+<button click={debouncedSendEmail}>Send Email</button>;
 ```
 
 ### Escape Regex
@@ -1918,7 +1936,8 @@ Escape regex special characters in the given string.
 ```ts
 import { escapeRegex } from "@mongez/reinforcements";
 
-const string = "This is a string with special characters like: . * + ? ^ $ { } ( ) | [ ] / \\";
+const string =
+  "This is a string with special characters like: . * + ? ^ $ { } ( ) | [ ] / \\";
 
 console.log(escapeRegex(string)); // This is a string with special characters like: \\. \\* \\+ \\? \\^ \\$ \\{ \\} \\( \\) \\| \\[ \\] / \\\\
 ```
@@ -2038,6 +2057,10 @@ To run tests run `npm run test` or `yarn test`
 
 ## Change Log
 
+- 2.3.0 (25 Mar 2023)
+  - Added [Range](#range) function.
+  - Exposed typings.
+  - Enhanced tests for `areEqual` function,
 - 2.2.7 (22 Feb 2023)
   - Added [Name Initials](#name-initials) function.
 - 2.2.0 (08 Nov 2022)

package/cjs/array/groupBy.js

@@ -9,7 +9,7 @@ require("../object/merge.js");
  * The key(s) support dot notation.
  */
 function groupBy(array, groupByKey, listAs = "data") {
-  const newData = {};
+  const groupedData = {};
   const groupByKeys =
     typeof groupByKey === "string" ? [groupByKey] : groupByKey;
   for (const item of array) {
@@ -23,20 +23,20 @@ function groupBy(array, groupByKey, listAs = "data") {
       });
     }
     const dataKey = JSON.stringify(baseKeys);
-    if (!newData[dataKey]) {
+    if (!groupedData[dataKey]) {
       const groupedDataList = {
         data: [],
       };
       for (const groupByKeyData of baseKeys) {
         groupedDataList[groupByKeyData.key] = groupByKeyData.value;
       }
-      newData[dataKey] = groupedDataList;
+      groupedData[dataKey] = groupedDataList;
     }
-    newData[dataKey]?.data?.push(item);
+    groupedData[dataKey]?.data?.push(item);
   }
   const finalData = [];
-  for (const groupedKeyWithValue in newData) {
-    const { data, ...otherGroupedKeys } = newData[groupedKeyWithValue];
+  for (const groupedKeyWithValue in groupedData) {
+    const { data, ...otherGroupedKeys } = groupedData[groupedKeyWithValue];
     finalData.push({
       ...otherGroupedKeys,
       [listAs]: data,

package/cjs/array/range.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generate array of numbers starting from the" given min value to the given max value
+ */
+export default function range(min: number, max: number): number[];
+//# sourceMappingURL=range.d.ts.map

package/cjs/array/range.js

@@ -0,0 +1,23 @@
+"use strict";
+
+/**
+ * Generate array of numbers starting from the" given min value to the given max value
+ */
+function range(min, max) {
+  if (typeof min !== "number") {
+    throw new Error(`min parameter should be number, "${typeof min}" given.`);
+  }
+  if (typeof max !== "number") {
+    throw new Error(`max parameter should be number, "${typeof max}" given.`);
+  }
+  if (min >= max) {
+    throw new Error("max parameter should be higher than min parameter");
+  }
+  const array = [];
+  for (let i = min; i <= max; i++) {
+    array.push(i);
+  }
+  return array;
+}
+
+module.exports = range;

package/cjs/index.d.ts

@@ -12,6 +12,7 @@ export { default as odd } from "./array/odd";
 export { default as oddIndexes } from "./array/oddIndexes";
 export { default as pluck } from "./array/pluck";
 export { default as pushUnique } from "./array/pushUnique";
+export { default as range } from "./array/range";
 export { default as sum } from "./array/sum";
 export { default as unique } from "./array/unique";
 export { default as unshiftUnique } from "./array/unshiftUnique";
@@ -50,6 +51,7 @@ export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";
 export { default as ucfirst } from "./string/ucfirst";
+export * from "./types";
 export { default as debounce } from "./utils/debounce";
 export { default as escapeRegex } from "./utils/escapeRegex";
 //# sourceMappingURL=index.d.ts.map

package/cjs/index.js

@@ -16,6 +16,7 @@ var odd = require("./array/odd.js");
 var oddIndexes = require("./array/oddIndexes.js");
 var pluck = require("./array/pluck.js");
 var pushUnique = require("./array/pushUnique.js");
+var range = require("./array/range.js");
 var sum = require("./array/sum.js");
 var unique = require("./array/unique.js");
 var unshiftUnique = require("./array/unshiftUnique.js");
@@ -72,6 +73,7 @@ exports.odd = odd;
 exports.oddIndexes = oddIndexes;
 exports.pluck = pluck;
 exports.pushUnique = pushUnique;
+exports.range = range;
 exports.sum = sum;
 exports.unique = unique;
 exports.unshiftUnique = unshiftUnique;

package/cjs/string/toInputName.d.ts

@@ -1,9 +1,6 @@
 /**
  * Convert the current a dot notation string to compound input name
  * my.input.name >> my[input][name]
- *
- * @param   {string} string
- * @returns {string}
  */
 export default function toInputName(string: string): string;
 //# sourceMappingURL=toInputName.d.ts.map

package/cjs/string/toInputName.js

@@ -5,13 +5,9 @@ var rtrim = require("./rtrim.js");
 /**
  * Convert the current a dot notation string to compound input name
  * my.input.name >> my[input][name]
- *
- * @param   {string} string
- * @returns {string}
  */
 function toInputName(string) {
   if (!string) return "";
-  if (!string.includes(".")) return string;
   const namesList = string.split(".");
   let mainName = namesList.shift() || "";
   for (let name of namesList) {

package/cjs/utils/debounce.d.ts

@@ -1,2 +1,9 @@
-export default function debounce(callback: () => void, wait?: number): void;
+declare type DebounceFn<T extends (...args: any[]) => any> = (this: ThisParameterType<T>, ...args: Parameters<T>) => void;
+/**
+ * Debounce the callback function and return a new function.
+ * Example of usage:
+ * @example const debounced = debounce(() => console.log('Hello'), 1000);
+ */
+export default function debounce<T extends (...args: any[]) => any>(callback: T, time: number): DebounceFn<T>;
+export {};
 //# sourceMappingURL=debounce.d.ts.map

package/cjs/utils/debounce.js

@@ -1,17 +1,18 @@
 "use strict";
 
-let timeoutId;
-function debounce(callback, wait = 0) {
-  // Clear previous delayed action, if existent
-  if (timeoutId !== undefined) {
+/**
+ * Debounce the callback function and return a new function.
+ * Example of usage:
+ * @example const debounced = debounce(() => console.log('Hello'), 1000);
+ */
+function debounce(callback, time) {
+  let timeoutId;
+  return function (...args) {
     clearTimeout(timeoutId);
-    timeoutId = undefined;
-  }
-  // Start new delayed action for latest call
-  timeoutId = setTimeout(() => {
-    callback();
-    timeoutId = undefined; // Clear timeout
-  }, wait);
+    timeoutId = setTimeout(() => {
+      callback.apply(this, args);
+    }, time);
+  };
 }
 
 module.exports = debounce;

package/esm/array/groupBy.js

@@ -7,7 +7,7 @@ import "../object/merge.js";
  * The key(s) support dot notation.
  */
 function groupBy(array, groupByKey, listAs = "data") {
-  const newData = {};
+  const groupedData = {};
   const groupByKeys =
     typeof groupByKey === "string" ? [groupByKey] : groupByKey;
   for (const item of array) {
@@ -21,20 +21,20 @@ function groupBy(array, groupByKey, listAs = "data") {
       });
     }
     const dataKey = JSON.stringify(baseKeys);
-    if (!newData[dataKey]) {
+    if (!groupedData[dataKey]) {
       const groupedDataList = {
         data: [],
       };
       for (const groupByKeyData of baseKeys) {
         groupedDataList[groupByKeyData.key] = groupByKeyData.value;
       }
-      newData[dataKey] = groupedDataList;
+      groupedData[dataKey] = groupedDataList;
     }
-    newData[dataKey]?.data?.push(item);
+    groupedData[dataKey]?.data?.push(item);
   }
   const finalData = [];
-  for (const groupedKeyWithValue in newData) {
-    const { data, ...otherGroupedKeys } = newData[groupedKeyWithValue];
+  for (const groupedKeyWithValue in groupedData) {
+    const { data, ...otherGroupedKeys } = groupedData[groupedKeyWithValue];
     finalData.push({
       ...otherGroupedKeys,
       [listAs]: data,

package/esm/array/range.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generate array of numbers starting from the" given min value to the given max value
+ */
+export default function range(min: number, max: number): number[];
+//# sourceMappingURL=range.d.ts.map

package/esm/array/range.js

@@ -0,0 +1,21 @@
+/**
+ * Generate array of numbers starting from the" given min value to the given max value
+ */
+function range(min, max) {
+  if (typeof min !== "number") {
+    throw new Error(`min parameter should be number, "${typeof min}" given.`);
+  }
+  if (typeof max !== "number") {
+    throw new Error(`max parameter should be number, "${typeof max}" given.`);
+  }
+  if (min >= max) {
+    throw new Error("max parameter should be higher than min parameter");
+  }
+  const array = [];
+  for (let i = min; i <= max; i++) {
+    array.push(i);
+  }
+  return array;
+}
+
+export { range as default };

package/esm/index.d.ts

@@ -12,6 +12,7 @@ export { default as odd } from "./array/odd";
 export { default as oddIndexes } from "./array/oddIndexes";
 export { default as pluck } from "./array/pluck";
 export { default as pushUnique } from "./array/pushUnique";
+export { default as range } from "./array/range";
 export { default as sum } from "./array/sum";
 export { default as unique } from "./array/unique";
 export { default as unshiftUnique } from "./array/unshiftUnique";
@@ -50,6 +51,7 @@ export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";
 export { default as ucfirst } from "./string/ucfirst";
+export * from "./types";
 export { default as debounce } from "./utils/debounce";
 export { default as escapeRegex } from "./utils/escapeRegex";
 //# sourceMappingURL=index.d.ts.map

package/esm/index.js

@@ -12,6 +12,7 @@ export { default as odd } from "./array/odd.js";
 export { default as oddIndexes } from "./array/oddIndexes.js";
 export { default as pluck } from "./array/pluck.js";
 export { default as pushUnique } from "./array/pushUnique.js";
+export { default as range } from "./array/range.js";
 export { default as sum } from "./array/sum.js";
 export { default as unique } from "./array/unique.js";
 export { default as unshiftUnique } from "./array/unshiftUnique.js";

package/esm/string/toInputName.d.ts

@@ -1,9 +1,6 @@
 /**
  * Convert the current a dot notation string to compound input name
  * my.input.name >> my[input][name]
- *
- * @param   {string} string
- * @returns {string}
  */
 export default function toInputName(string: string): string;
 //# sourceMappingURL=toInputName.d.ts.map

package/esm/string/toInputName.js

@@ -3,13 +3,9 @@ import rtrim from "./rtrim.js";
 /**
  * Convert the current a dot notation string to compound input name
  * my.input.name >> my[input][name]
- *
- * @param   {string} string
- * @returns {string}
  */
 function toInputName(string) {
   if (!string) return "";
-  if (!string.includes(".")) return string;
   const namesList = string.split(".");
   let mainName = namesList.shift() || "";
   for (let name of namesList) {

package/esm/utils/debounce.d.ts

@@ -1,2 +1,9 @@
-export default function debounce(callback: () => void, wait?: number): void;
+declare type DebounceFn<T extends (...args: any[]) => any> = (this: ThisParameterType<T>, ...args: Parameters<T>) => void;
+/**
+ * Debounce the callback function and return a new function.
+ * Example of usage:
+ * @example const debounced = debounce(() => console.log('Hello'), 1000);
+ */
+export default function debounce<T extends (...args: any[]) => any>(callback: T, time: number): DebounceFn<T>;
+export {};
 //# sourceMappingURL=debounce.d.ts.map

package/esm/utils/debounce.js

@@ -1,15 +1,16 @@
-let timeoutId;
-function debounce(callback, wait = 0) {
-  // Clear previous delayed action, if existent
-  if (timeoutId !== undefined) {
+/**
+ * Debounce the callback function and return a new function.
+ * Example of usage:
+ * @example const debounced = debounce(() => console.log('Hello'), 1000);
+ */
+function debounce(callback, time) {
+  let timeoutId;
+  return function (...args) {
     clearTimeout(timeoutId);
-    timeoutId = undefined;
-  }
-  // Start new delayed action for latest call
-  timeoutId = setTimeout(() => {
-    callback();
-    timeoutId = undefined; // Clear timeout
-  }, wait);
+    timeoutId = setTimeout(() => {
+      callback.apply(this, args);
+    }, time);
+  };
 }
 
 export { debounce as default };

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@mongez/reinforcements",
-    "version": "2.2.8",
+    "version": "2.3.1",
     "description": "A lightweight package to give a massive reinforcements to variant types of data in Nodejs/Javascript",
     "main": "./cjs/index.js",
     "dependencies": {
-        "@mongez/supportive-is": "^1.0.11"
+        "@mongez/supportive-is": "^1.0.12"
     },
     "scripts": {
         "test": "jest ./src",
@@ -17,11 +17,11 @@
         "url": "https://github.com/hassanzohdy/reinforcements"
     },
     "devDependencies": {
-        "@types/jest": "^28.1.6",
-        "jest": "^28.1.3",
+        "@types/jest": "^29.5.0",
+        "jest": "^29.5.0",
         "jest-esm-jsx-transform": "^1.0.0",
-        "ts-jest": "^28.0.7",
-        "typescript": "^4.7.4"
+        "ts-jest": "^29.0.5",
+        "typescript": "^5.0.2"
     },
     "keywords": [
         "array",