Initial commit

Author: TheRealFloatDev

README.md

@@ -1,9 +1,27 @@
-# Node Package Template
-A basic npm package template.
-This is only meant for building packages and no standalone application, therefore it does not contain any startup scripts.
-
-## Contents
- - TypeScript (for type safety)
- - Jest (for testing)
- - Github Packages (for publishing)
- - Github Test
+# Debounce Function
+
+A TypeScript debounce function that can be used to limit the frequency of function calls.
+
+## Usage
+
+```typescript
+import { debounce } from '@garmingo/debounce';
+
+const myFunction = () => {
+  console.log('Debounced function called');
+};
+
+const debouncedFunction = debounce(myFunction, 500); // Set the delay time in milliseconds
+
+// Call debouncedFunction multiple times quickly
+debouncedFunction();
+debouncedFunction();
+debouncedFunction();
+
+// Only one actual call to myFunction will be made after 500ms
+```
+
+## Parameters
+
+ - `func`: The original function you want to debounce.
+ - `delay`: The delay time in milliseconds.

package-lock.json

@@ -1,22 +1,22 @@
 {
-  "name": "@garmingo/node-package-template",
+  "name": "@garmingo/debounce",
   "version": "1.0.0",
-  "description": "A basic template for a node package with typescript and jest",
+  "description": "A basic debounce function for TypeScript",
   "main": "src/index.ts",
   "type": "module",
   "scripts": {
     "test": "jest"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Garmingo/node-package-template.git"
+    "url": "git+https://github.com/Garmingo/debounce.git"
   },
-  "author": "Codineer Digital",
+  "author": "Garmingo",
   "license": "UNLICENSED",
   "bugs": {
-    "url": "https://github.com/Garmingo/node-package-template/issues"
+    "url": "https://github.com/Garmingo/debounce/issues"
   },
-  "homepage": "https://github.com/Garmingo/node-package-template#readme",
+  "homepage": "https://github.com/Garmingo/debounce#readme",
   "devDependencies": {
     "@types/jest": "^29.5.8",
     "jest": "^29.7.0",

package.json

@@ -6,13 +6,22 @@
 
 
 /**
- * This is an example function
- * It returns the n-th fibonacci number
- * @param n The n-th fibonacci number to return
- * @returns The n-th fibonacci number
+ * Executes only the last call of a function within a given delay.
+ * @param func The function to debounce.
+ * @param delay The delay in milliseconds.
+ * @returns A function that can be called to execute the debounced function.
  */
-export function fib(n: number): number {
-    if (n < 2)
-        return n;
-    return fib(n - 1) + fib(n - 2);
-}
+export function debounce<T extends (...args: any[]) => any>(
+    func: T,
+    delay: number
+  ): (...args: Parameters<T>) => void {
+    let timeoutId: NodeJS.Timeout;
+  
+    return function (...args: Parameters<T>): void {
+      clearTimeout(timeoutId);
+  
+      timeoutId = setTimeout(() => {
+        func(...args);
+      }, delay);
+    };
+  }

src/index.ts

@@ -3,49 +3,19 @@
  *   All rights reserved.
  *   Unauthorized use, reproduction, and distribution of this source code is strictly prohibited.
  */
-import { fib } from '../src/index';
+import { debounce } from '../src/index';
 
-test('Test the fibonacci function', () => {
-    expect(fib(0)).toBe(0);
-    expect(fib(1)).toBe(1);
-    expect(fib(2)).toBe(1);
-    expect(fib(3)).toBe(2);
-    expect(fib(4)).toBe(3);
-    expect(fib(5)).toBe(5);
-    expect(fib(6)).toBe(8);
-    expect(fib(7)).toBe(13);
-    expect(fib(8)).toBe(21);
-    expect(fib(9)).toBe(34);
-    expect(fib(10)).toBe(55);
-    expect(fib(11)).toBe(89);
-    expect(fib(12)).toBe(144);
-    expect(fib(13)).toBe(233);
-    expect(fib(14)).toBe(377);
-    expect(fib(15)).toBe(610);
-    expect(fib(16)).toBe(987);
-    expect(fib(17)).toBe(1597);
-    expect(fib(18)).toBe(2584);
-    expect(fib(19)).toBe(4181);
-    expect(fib(20)).toBe(6765);
-    expect(fib(21)).toBe(10946);
-    expect(fib(22)).toBe(17711);
-    expect(fib(23)).toBe(28657);
-    expect(fib(24)).toBe(46368);
-    expect(fib(25)).toBe(75025);
-    expect(fib(26)).toBe(121393);
-    expect(fib(27)).toBe(196418);
-    expect(fib(28)).toBe(317811);
-    expect(fib(29)).toBe(514229);
-    expect(fib(30)).toBe(832040);
-    expect(fib(31)).toBe(1346269);
-    expect(fib(32)).toBe(2178309);
-    expect(fib(33)).toBe(3524578);
-    expect(fib(34)).toBe(5702887);
-    expect(fib(35)).toBe(9227465);
-    expect(fib(36)).toBe(14930352);
-    expect(fib(37)).toBe(24157817);
-    expect(fib(38)).toBe(39088169);
-    expect(fib(39)).toBe(63245986);
-    expect(fib(40)).toBe(102334155);
-    expect(fib(41)).toBe(165580141);
+test('Test the debounce function', () => {
+    const mockFn = jest.fn();
+    const debouncedFn = debounce(mockFn, 1000);
+
+    debouncedFn();
+    debouncedFn();
+    debouncedFn();
+
+    expect(mockFn).not.toHaveBeenCalled();
+
+    setTimeout(() => {
+        expect(mockFn).toHaveBeenCalledTimes(1);
+    }, 1000);
 });