debounce-throttle-utility 1.0.0 → 2.0.0

package/README.md

@@ -1,4 +1,4 @@
-# Debounce & Throttle Utility [(Git)](https://github.com/paradoxial-composition/debounce-throttle-utility)
+# Debounce & Throttle Utility [(NPM)](https://www.npmjs.com/package/debounce-throttle-utility)
 
 A lightweight utility for debouncing and throttling functions, optimized for performance. Ideal for handling events like scrolling, resizing, or input changes in web apps.
 

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+interface DebounceOptions {
+    leading?: boolean;
+    trailing?: boolean;
+}
+export declare function debounce<T extends (...args: any[]) => any>(func: T, wait: number, options?: DebounceOptions): (...args: Parameters<T>) => void;
+export declare function throttle<T extends (...args: any[]) => any>(func: T, limit: number): (...args: Parameters<T>) => void;
+export {};

package/dist/index.js

@@ -0,0 +1,37 @@
+"use strict";
+// index.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = debounce;
+exports.throttle = throttle;
+function debounce(func, wait, options = {}) {
+    let timeout;
+    const { leading = false, trailing = true } = options;
+    return function (...args) {
+        const context = this;
+        if (timeout !== undefined) {
+            clearTimeout(timeout);
+        }
+        if (leading && timeout === undefined) {
+            func.apply(context, args);
+        }
+        timeout = setTimeout(() => {
+            if (trailing) {
+                func.apply(context, args);
+            }
+            timeout = undefined;
+        }, wait);
+    };
+}
+function throttle(func, limit) {
+    let inThrottle = false;
+    return function (...args) {
+        const context = this;
+        if (!inThrottle) {
+            func.apply(context, args);
+            inThrottle = true;
+            setTimeout(() => {
+                inThrottle = false;
+            }, limit);
+        }
+    };
+}

package/jest.config.ts

@@ -0,0 +1,8 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};
+
+export default config;

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "debounce-throttle-utility",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "A lightweight utility for debouncing and throttling functions, optimized for performance.",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
+    "build": "tsc",
     "test": "jest"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/paradoxial-composition/debounce-throttle-utility.git"
   },
-  "keywords": ["debounce", "throttle", "utility", "performance", "scroll", "input", "resize"],
+  "keywords": [
+    "debounce",
+    "throttle",
+    "utility",
+    "performance",
+    "scroll",
+    "input",
+    "resize",
+    "optimize"
+  ],
   "author": "elbani.othman@gmail.com",
   "license": "MIT",
   "bugs": {
@@ -18,6 +28,11 @@
   },
   "homepage": "https://github.com/paradoxial-composition/debounce-throttle-utility#readme",
   "devDependencies": {
-    "jest": "^29.7.0"
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.6",
+    "typescript": "^5.7.3",
+    "ts-node": "^10.9.2"
   }
 }

package/src/index.ts

@@ -0,0 +1,51 @@
+// index.ts
+
+type Timer = ReturnType<typeof setTimeout> | undefined;
+
+interface DebounceOptions {
+  leading?: boolean;
+  trailing?: boolean;
+}
+
+export function debounce<T extends (...args: any[]) => any>(
+  func: T,
+  wait: number,
+  options: DebounceOptions = {}
+): (...args: Parameters<T>) => void {
+  let timeout: Timer;
+  const { leading = false, trailing = true } = options;
+
+  return function (this: any, ...args: Parameters<T>): void {
+    const context = this;
+    if (timeout !== undefined) {
+      clearTimeout(timeout);
+    }
+    if (leading && timeout === undefined) {
+      func.apply(context, args);
+    }
+    timeout = setTimeout(() => {
+      if (trailing) {
+        func.apply(context, args);
+      }
+      timeout = undefined;
+    }, wait);
+  };
+}
+
+export function throttle<T extends (...args: any[]) => any>(
+  func: T,
+  limit: number
+): (...args: Parameters<T>) => void {
+  let inThrottle = false;
+
+  return function (this: any, ...args: Parameters<T>): void {
+    const context = this;
+    if (!inThrottle) {
+      func.apply(context, args);
+      inThrottle = true;
+      setTimeout(() => {
+        inThrottle = false;
+      }, limit);
+    }
+  };
+}

package/{test.spec.js → test.test.ts}

@@ -1,6 +1,4 @@
-// test.js
-
-const { debounce, throttle } = require('./index');
+import { debounce, throttle } from './src/index';
 
 describe('Debounce', () => {
     it('should delay execution', async () => {
@@ -31,7 +29,7 @@ describe('Throttle', () => {
         expect(count).toBe(1); // Should execute only once within 100ms
     });
 
-    it('should be executed only twice in a 500ms interval ', async () => {
+    it('should be executed only twice in a 500ms interval', async () => {
         let count = 0;
         const throttled = throttle(() => {
             count++;

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+      "target": "ES2018",
+      "module": "CommonJS",
+      "strict": true,
+      "esModuleInterop": true,
+      "declaration": true,
+      "outDir": "dist"
+    },
+    "include": ["src"]
+  }
+  

package/index.js

@@ -1,52 +0,0 @@
-// index.js
-
-/**
- * Debounce function
- * @param {Function} func - The function to debounce
- * @param {number} wait - Delay in milliseconds
- * @param {Object} options - Optional configuration
- * @returns {Function} - Debounced function
- */
-function debounce(func, wait, options = {}) {
-    let timeout;
-    const { leading = false, trailing = true } = options;
-
-    return function(...args) {
-        const context = this;
-        clearTimeout(timeout);
-
-        if (leading && !timeout) {
-            func.apply(context, args);
-        }
-
-        timeout = setTimeout(() => {
-            if (trailing) {
-                func.apply(context, args);
-            }
-        }, wait);
-    };
-}
-
-/**
- * Throttle function
- * @param {Function} func - The function to throttle
- * @param {number} limit - Interval in milliseconds
- * @returns {Function} - Throttled function
- */
-function throttle(func, limit) {
-    let inThrottle;
-
-    return function(...args) {
-        const context = this;
-        if (!inThrottle) {
-            func.apply(context, args);
-            inThrottle = true;
-            setTimeout(() => (inThrottle = false), limit);
-        }
-    };
-}
-
-module.exports = {
-    debounce,
-    throttle,
-};