@alwatr/debounce 1.1.8 → 1.1.10

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.10](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.1.9...@alwatr/debounce@1.1.10) (2025-10-06)
+
+### 🔗 Dependencies update
+
+* bump the npm-dependencies group with 4 updates ([9825815](https://github.com/Alwatr/nanolib/commit/982581552bbb4b97dca52af5e93a80937f0c3109))
+
+## [1.1.9](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.1.8...@alwatr/debounce@1.1.9) (2025-09-27)
+
+### 🧹 Miscellaneous Chores
+
+* exclude test files from package distribution ([86f4f2f](https://github.com/Alwatr/nanolib/commit/86f4f2f5985845c5cf3a3a9398de7b2f98ce53e7))
+
 ## [1.1.8](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.1.7...@alwatr/debounce@1.1.8) (2025-09-22)
 
 **Note:** Version bump only for package @alwatr/debounce

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/** 📦 @alwatr/debounce v1.1.8 */
-__dev_mode__: console.debug("📦 @alwatr/debounce v1.1.8");
+/** 📦 @alwatr/debounce v1.1.10 */
+__dev_mode__: console.debug("📦 @alwatr/debounce v1.1.10");
 "use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:true})};var __copyProps=(to,from,except,desc)=>{if(from&&typeof from==="object"||typeof from==="function"){for(let key of __getOwnPropNames(from))if(!__hasOwnProp.call(to,key)&&key!==except)__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable})}return to};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:true}),mod);var main_exports={};__export(main_exports,{Debouncer:()=>Debouncer,createDebouncer:()=>createDebouncer});module.exports=__toCommonJS(main_exports);var Debouncer=class{constructor(config__){this.config__=config__;this.config__.trailing??=true;this.flush=this.flush.bind(this)}get isPending(){return this.timerId__!==void 0}trigger(...args){this.lastArgs__=args;const firstTrigger=!this.isPending;if(firstTrigger){if(this.config__.maxWait){this.maxWaitTimerId__=setTimeout(this.flush,this.config__.maxWait)}if(this.config__.leading===true){this.invoke__()}}else{clearTimeout(this.timerId__)}this.timerId__=setTimeout(()=>{if(this.config__.trailing===true){this.invoke__()}this.cleanup__()},this.config__.delay)}cancel(){if(this.timerId__){clearTimeout(this.timerId__)}if(this.maxWaitTimerId__){clearTimeout(this.maxWaitTimerId__)}this.cleanup__()}cleanup__(){delete this.timerId__;delete this.maxWaitTimerId__;delete this.lastArgs__}flush(){if(this.isPending){this.invoke__()}this.cancel()}invoke__(){if(this.lastArgs__){this.config__.func.apply(this.config__.thisContext,this.lastArgs__);this.lastArgs__=void 0}}};function createDebouncer(config){return new Debouncer(config)}0&&(module.exports={Debouncer,createDebouncer});
 //# sourceMappingURL=main.cjs.map

package/dist/main.mjs

@@ -1,4 +1,4 @@
-/** 📦 @alwatr/debounce v1.1.8 */
-__dev_mode__: console.debug("📦 @alwatr/debounce v1.1.8");
+/** 📦 @alwatr/debounce v1.1.10 */
+__dev_mode__: console.debug("📦 @alwatr/debounce v1.1.10");
 var Debouncer=class{constructor(config__){this.config__=config__;this.config__.trailing??=true;this.flush=this.flush.bind(this)}get isPending(){return this.timerId__!==void 0}trigger(...args){this.lastArgs__=args;const firstTrigger=!this.isPending;if(firstTrigger){if(this.config__.maxWait){this.maxWaitTimerId__=setTimeout(this.flush,this.config__.maxWait)}if(this.config__.leading===true){this.invoke__()}}else{clearTimeout(this.timerId__)}this.timerId__=setTimeout(()=>{if(this.config__.trailing===true){this.invoke__()}this.cleanup__()},this.config__.delay)}cancel(){if(this.timerId__){clearTimeout(this.timerId__)}if(this.maxWaitTimerId__){clearTimeout(this.maxWaitTimerId__)}this.cleanup__()}cleanup__(){delete this.timerId__;delete this.maxWaitTimerId__;delete this.lastArgs__}flush(){if(this.isPending){this.invoke__()}this.cancel()}invoke__(){if(this.lastArgs__){this.config__.func.apply(this.config__.thisContext,this.lastArgs__);this.lastArgs__=void 0}}};function createDebouncer(config){return new Debouncer(config)}export{Debouncer,createDebouncer};
 //# sourceMappingURL=main.mjs.map

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@alwatr/debounce",
   "description": "A powerful, modern, and type-safe debouncer utility designed for high-performance applications. It's framework-agnostic, works seamlessly in both Node.js and browsers, and provides a rich API for fine-grained control over function execution.",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "bugs": "https://github.com/Alwatr/nanolib/issues",
   "devDependencies": {
-    "@alwatr/nano-build": "6.3.3",
-    "@alwatr/prettier-config": "5.0.4",
-    "@alwatr/tsconfig-base": "6.0.2",
-    "@alwatr/type-helper": "6.1.3",
-    "@jest/globals": "^30.1.2",
-    "@types/node": "^22.18.6",
-    "typescript": "^5.9.2"
+    "@alwatr/nano-build": "6.3.5",
+    "@alwatr/prettier-config": "5.0.5",
+    "@alwatr/tsconfig-base": "6.0.3",
+    "@alwatr/type-helper": "6.1.5",
+    "@jest/globals": "^30.2.0",
+    "@types/node": "^22.18.8",
+    "typescript": "^5.9.3"
   },
   "exports": {
     ".": {
@@ -23,7 +23,8 @@
   "files": [
     "**/*.{js,mjs,cjs,map,d.ts,html,md,LEGAL.txt}",
     "LICENSE",
-    "!demo/**/*"
+    "!demo/**/*",
+    "!**/*.test.js"
   ],
   "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/debounce#readme",
   "keywords": [
@@ -79,5 +80,5 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/main.d.ts",
-  "gitHead": "a0c8605949969959c8226e54b8c8c0fc7276819a"
+  "gitHead": "b141732f4dab13542e3cc99926a250fd5c74bad3"
 }

package/src/debounce.test.js

@@ -1,388 +0,0 @@
-import {describe, beforeEach, afterEach, it, expect, jest} from '@jest/globals';
-import {createDebouncer} from '@alwatr/debounce';
-
-describe('Debouncer', () => {
-  /**
-   * @type {import("jest-mock").Mock<import("jest-mock").UnknownFunction>}
-   */
-  let mockFunc;
-  /**
-   * @type {import("@alwatr/debounce").Debouncer<typeof mockFunc>}
-   */
-  let debouncer;
-
-  beforeEach(() => {
-    mockFunc = jest.fn();
-    jest.useFakeTimers();
-  });
-
-  afterEach(() => {
-    jest.clearAllTimers();
-    jest.useRealTimers();
-  });
-
-  describe('Basic Trailing Debounce (default)', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-    });
-
-    it('should execute after delay on single trigger', () => {
-      debouncer.trigger('test');
-      expect(mockFunc).not.toHaveBeenCalled();
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledWith('test');
-    });
-
-    it('should reset delay on multiple triggers', () => {
-      debouncer.trigger('first');
-      jest.advanceTimersByTime(200);
-      debouncer.trigger('second');
-      jest.advanceTimersByTime(200);
-      expect(mockFunc).not.toHaveBeenCalled();
-      jest.advanceTimersByTime(100);
-      expect(mockFunc).toHaveBeenCalledWith('second');
-    });
-
-    it('should not execute if cancelled before delay', () => {
-      debouncer.trigger('test');
-      debouncer.cancel();
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('Leading Debounce', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-        trailing: false,
-      });
-    });
-
-    it('should execute immediately on first trigger', () => {
-      debouncer.trigger('test');
-      expect(mockFunc).toHaveBeenCalledWith('test');
-    });
-
-    it('should not execute again within delay', () => {
-      debouncer.trigger('first');
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-      debouncer.trigger('second');
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-    });
-
-    it('should execute again after delay', () => {
-      debouncer.trigger('first');
-      jest.advanceTimersByTime(300);
-      debouncer.trigger('second');
-      expect(mockFunc).toHaveBeenCalledTimes(2);
-    });
-  });
-
-  describe('Both Leading and Trailing', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-        trailing: true,
-      });
-    });
-
-    it('should execute immediately but not after delay on single trigger', () => {
-      debouncer.trigger('test');
-      expect(mockFunc).toHaveBeenCalledWith('test');
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-    });
-
-    it('should execute immediately, then trailing on last trigger', () => {
-      debouncer.trigger('first');
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-      expect(mockFunc).toHaveBeenCalledWith('first');
-      jest.advanceTimersByTime(200);
-      debouncer.trigger('second');
-      jest.advanceTimersByTime(100);
-      debouncer.trigger('third');
-      jest.advanceTimersByTime(100);
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(2);
-      expect(mockFunc).toHaveBeenLastCalledWith('third');
-    });
-  });
-
-  describe('Cancel Functionality', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-    });
-
-    it('should cancel pending execution', () => {
-      debouncer.trigger('test');
-      expect(debouncer.isPending).toBe(true);
-      debouncer.cancel();
-      expect(debouncer.isPending).toBe(false);
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).not.toHaveBeenCalled();
-    });
-
-    it('should handle cancel on leading debounce', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-      });
-      debouncer.trigger('test');
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-      debouncer.cancel();
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(1); // No trailing call
-    });
-  });
-
-  describe('Flush Functionality', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-    });
-
-    it('should execute immediately and cancel pending', () => {
-      debouncer.trigger('test');
-      expect(mockFunc).not.toHaveBeenCalled();
-      debouncer.flush();
-      expect(mockFunc).toHaveBeenCalledWith('test');
-      expect(debouncer.isPending).toBe(false);
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(1);
-    });
-
-    it('should do nothing if no pending call', () => {
-      debouncer.flush();
-      expect(mockFunc).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('MaxWait Functionality', () => {
-    beforeEach(() => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        maxWait: 1000,
-      });
-    });
-
-    it('should execute after maxWait even with continuous triggers', () => {
-      debouncer.trigger('first');
-      jest.advanceTimersByTime(500);
-      debouncer.trigger('second');
-      jest.advanceTimersByTime(500);
-      expect(mockFunc).toHaveBeenCalledWith('first'); // After maxWait
-      debouncer.trigger('third');
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledWith('third');
-    });
-  });
-
-  describe('ThisContext Binding', () => {
-    /**
-     * @type {{ value: string; }}
-     */
-    let context;
-
-    beforeEach(() => {
-      context = {value: 'test'};
-      mockFunc = jest.fn(function () {
-        this.value = 'changed';
-      });
-      debouncer = createDebouncer({
-        func: mockFunc,
-        thisContext: context,
-        delay: 300,
-      });
-    });
-
-    it('should bind thisContext correctly', () => {
-      debouncer.trigger();
-      jest.advanceTimersByTime(300);
-      expect(context.value).toBe('changed');
-    });
-  });
-
-  describe('Edge Cases', () => {
-    it('should handle zero delay', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 0,
-      });
-      debouncer.trigger('test');
-      jest.advanceTimersByTime(0);
-      expect(mockFunc).toHaveBeenCalledWith('test');
-    });
-
-    it('should handle no arguments', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-      debouncer.trigger();
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledWith();
-    });
-
-    it('should handle multiple arguments', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-      debouncer.trigger('arg1', 'arg2', 123);
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledWith('arg1', 'arg2', 123);
-    });
-
-    it('should not execute if func throws', () => {
-      mockFunc = jest.fn(() => {
-        throw new Error('test');
-      });
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-      });
-      debouncer.trigger();
-      expect(() => jest.advanceTimersByTime(300)).toThrow('test');
-    });
-
-    it('should double-invocation with leading: true, trailing: false, and maxWait on multiple trigger', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-        trailing: false,
-        maxWait: 500,
-      });
-      debouncer.trigger('first');
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Leading call
-      jest.advanceTimersByTime(200);
-      debouncer.trigger('second');
-      jest.advanceTimersByTime(200);
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Should not call again yet
-      jest.advanceTimersByTime(200); // Trigger maxWait, which may call flush
-      expect(mockFunc).toHaveBeenCalledTimes(2); // Should be called a second time due to maxWait
-    });
-
-    it('should prevent double-invocation with leading: true, trailing: false, and maxWait on single trigger', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-        trailing: false,
-        maxWait: 200,
-      });
-      debouncer.trigger('first');
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Leading call
-      jest.advanceTimersByTime(300);
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Should not call again
-    });
-
-    it('should prevent double-invocation with leading: true, trailing: false, and flush', () => {
-      debouncer = createDebouncer({
-        func: mockFunc,
-        delay: 300,
-        leading: true,
-        trailing: false,
-      });
-      debouncer.trigger('first');
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Leading call
-      jest.advanceTimersByTime(100);
-      debouncer.flush();
-      debouncer.flush();
-      expect(mockFunc).toHaveBeenCalledTimes(1); // Should not call again
-    });
-  });
-  
-  it('should execute after delay for trailing debounce', () => {
-    debouncer = createDebouncer({
-      func: mockFunc,
-      delay: 300,
-      leading: false,
-      trailing: true,
-    });
-    debouncer.trigger('first');
-    expect(mockFunc).toHaveBeenCalledTimes(0); // No call yet
-    jest.advanceTimersByTime(300);
-    expect(mockFunc).toHaveBeenCalledTimes(1); // Trailing call
-  });
-  it('should execute leading but skip trailing on single trigger', () => {
-    debouncer = createDebouncer({
-      func: mockFunc,
-      delay: 300,
-      leading: true,
-      trailing: true,
-    });
-    debouncer.trigger('first');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // leading call
-    jest.advanceTimersByTime(300);
-    expect(mockFunc).toHaveBeenCalledTimes(1); // no trailing call on same argument
-  });
-
-  it('should execute leading and skip trailing after flush', () => {
-    debouncer = createDebouncer({
-      func: mockFunc,
-      delay: 300,
-      leading: true,
-      trailing: true,
-    });
-    debouncer.trigger('first');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // leading call
-    jest.advanceTimersByTime(100);
-    debouncer.flush();
-    jest.advanceTimersByTime(100);
-    expect(mockFunc).toHaveBeenCalledTimes(1); // no trailing call on same argument
-  });
-
-  it('should execute leading and trailing on multiple triggers', () => {
-    debouncer = createDebouncer({
-      func: mockFunc,
-      delay: 300,
-      leading: true,
-      trailing: true,
-    });
-    debouncer.trigger('first');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // leading call
-    debouncer.trigger('second');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // No call again yet
-    jest.advanceTimersByTime(300);
-    expect(mockFunc).toHaveBeenCalledTimes(2); // Trailing call
-    expect(mockFunc).toHaveBeenLastCalledWith('second');
-  });
-
-  it('should execute leading and flush, skip trailing', () => {
-    debouncer = createDebouncer({
-      func: mockFunc,
-      delay: 300,
-      leading: true,
-      trailing: false,
-    });
-    debouncer.trigger('first');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // leading call
-    debouncer.trigger('second');
-    expect(mockFunc).toHaveBeenCalledTimes(1); // No call again yet
-    debouncer.flush();
-    debouncer.flush();
-    expect(mockFunc).toHaveBeenCalledTimes(2);
-    expect(mockFunc).toHaveBeenLastCalledWith('second');
-    jest.advanceTimersByTime(300);
-    debouncer.flush();
-    expect(mockFunc).toHaveBeenCalledTimes(2); // no trailing call
-  });
-});