@mongez/reinforcements 2.3.0 → 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.
@@ -1883,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);
 }
@@ -1903,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
@@ -1919,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

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/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/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.3.0",
+    "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",