@alwatr/debounce 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/dist/debounce.d.ts.map +1 -1
- package/dist/main.cjs +2 -156
- package/dist/main.cjs.map +2 -2
- package/dist/main.mjs +2 -129
- package/dist/main.mjs.map +2 -2
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,16 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.1.2](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.1.1...@alwatr/debounce@1.1.2) (2025-09-15)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @alwatr/debounce
|
|
9
|
+
|
|
10
|
+
## [1.1.1](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.1.0...@alwatr/debounce@1.1.1) (2025-09-15)
|
|
11
|
+
|
|
12
|
+
### 🐛 Bug Fixes
|
|
13
|
+
|
|
14
|
+
* bind flush method correctly in Debouncer and improve readability of invoke logic ([5ddb12c](https://github.com/Alwatr/nanolib/commit/5ddb12c7d5d6040edad0f37ae79b3f725481d1f7))
|
|
15
|
+
|
|
6
16
|
## [1.1.0](https://github.com/Alwatr/nanolib/compare/@alwatr/debounce@1.0.1...@alwatr/debounce@1.1.0) (2025-09-14)
|
|
7
17
|
|
|
8
18
|
### ✨ Features
|
package/dist/debounce.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../src/debounce.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,WAAW,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,WAAW;IAKvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ5C,OAAO,CAAC,SAAS,CAAC,CAA0B;IAC5C,OAAO,CAAC,gBAAgB,CAAC,CAA0B;IACnD,OAAO,CAAC,UAAU,CAAC,CAAgB;gBAEC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../src/debounce.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,WAAW,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,WAAW;IAKvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ5C,OAAO,CAAC,SAAS,CAAC,CAA0B;IAC5C,OAAO,CAAC,gBAAgB,CAAC,CAA0B;IACnD,OAAO,CAAC,UAAU,CAAC,CAAgB;gBAEC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAIhE;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,OAAO,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI;IAwB5C;;;;;;;;;;;;;;;OAeG;IACI,MAAM,IAAI,IAAI;IAUrB;;OAEG;IACH,OAAO,CAAC,SAAS;IAMjB;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,IAAI,IAAI;IAOpB;;OAEG;IACH,OAAO,CAAC,QAAQ;CAOjB"}
|
package/dist/main.cjs
CHANGED
|
@@ -1,157 +1,3 @@
|
|
|
1
|
-
/* @alwatr/debounce v1.1.
|
|
2
|
-
"use strict";
|
|
3
|
-
var __defProp = Object.defineProperty;
|
|
4
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
-
var __export = (target, all) => {
|
|
8
|
-
for (var name in all)
|
|
9
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
10
|
-
};
|
|
11
|
-
var __copyProps = (to, from, except, desc) => {
|
|
12
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
13
|
-
for (let key of __getOwnPropNames(from))
|
|
14
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
15
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
16
|
-
}
|
|
17
|
-
return to;
|
|
18
|
-
};
|
|
19
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
20
|
-
|
|
21
|
-
// src/main.ts
|
|
22
|
-
var main_exports = {};
|
|
23
|
-
__export(main_exports, {
|
|
24
|
-
Debouncer: () => Debouncer,
|
|
25
|
-
createDebouncer: () => createDebouncer
|
|
26
|
-
});
|
|
27
|
-
module.exports = __toCommonJS(main_exports);
|
|
28
|
-
|
|
29
|
-
// src/debounce.ts
|
|
30
|
-
var Debouncer = class {
|
|
31
|
-
constructor(config__) {
|
|
32
|
-
this.config__ = config__;
|
|
33
|
-
this.config__.trailing ??= true;
|
|
34
|
-
this.flush = this.flush.bind(this);
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* Checks if there is a pending execution scheduled.
|
|
38
|
-
* Returns true if a timer is active, indicating a debounced call is waiting.
|
|
39
|
-
*/
|
|
40
|
-
get isPending() {
|
|
41
|
-
return this.timerId__ !== void 0;
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* Triggers the debounced function with the stored `thisContext`.
|
|
45
|
-
* @param args The arguments to pass to the `func`.
|
|
46
|
-
*
|
|
47
|
-
* @example
|
|
48
|
-
* ```typescript
|
|
49
|
-
* const debouncer = new Debouncer({
|
|
50
|
-
* func: (value: number) => console.log('Value:', value),
|
|
51
|
-
* delay: 500,
|
|
52
|
-
* });
|
|
53
|
-
* debouncer.trigger(42); // Logs after 500ms if not triggered again
|
|
54
|
-
*
|
|
55
|
-
* // Edge case: Rapid triggers only execute the last one
|
|
56
|
-
* debouncer.trigger(1);
|
|
57
|
-
* debouncer.trigger(2); // Only 2 will execute after delay
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
trigger(...args) {
|
|
61
|
-
this.lastArgs__ = args;
|
|
62
|
-
const firstTrigger = !this.isPending;
|
|
63
|
-
if (firstTrigger) {
|
|
64
|
-
if (this.config__.maxWait) {
|
|
65
|
-
this.maxWaitTimerId__ = setTimeout(this.flush, this.config__.maxWait);
|
|
66
|
-
}
|
|
67
|
-
if (this.config__.leading === true) {
|
|
68
|
-
this.invoke__();
|
|
69
|
-
}
|
|
70
|
-
} else {
|
|
71
|
-
clearTimeout(this.timerId__);
|
|
72
|
-
}
|
|
73
|
-
this.timerId__ = setTimeout(() => {
|
|
74
|
-
if (this.config__.trailing === true) {
|
|
75
|
-
this.invoke__();
|
|
76
|
-
}
|
|
77
|
-
this.cleanup__();
|
|
78
|
-
}, this.config__.delay);
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* Cancels any pending debounced execution and cleans up internal state.
|
|
82
|
-
* Useful for stopping execution when the operation is no longer needed (e.g., component unmount).
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* ```typescript
|
|
86
|
-
* const debouncer = new Debouncer({
|
|
87
|
-
* func: () => console.log('Executed'),
|
|
88
|
-
* delay: 1000,
|
|
89
|
-
* });
|
|
90
|
-
* debouncer.trigger();
|
|
91
|
-
* debouncer.cancel(); // Prevents execution
|
|
92
|
-
*
|
|
93
|
-
* // Note: After cancel, isPending becomes false
|
|
94
|
-
* ```
|
|
95
|
-
*/
|
|
96
|
-
cancel() {
|
|
97
|
-
if (this.timerId__) {
|
|
98
|
-
clearTimeout(this.timerId__);
|
|
99
|
-
}
|
|
100
|
-
if (this.maxWaitTimerId__) {
|
|
101
|
-
clearTimeout(this.maxWaitTimerId__);
|
|
102
|
-
}
|
|
103
|
-
this.cleanup__();
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* Cleans up internal state by deleting timer and arguments.
|
|
107
|
-
*/
|
|
108
|
-
cleanup__() {
|
|
109
|
-
delete this.timerId__;
|
|
110
|
-
delete this.maxWaitTimerId__;
|
|
111
|
-
delete this.lastArgs__;
|
|
112
|
-
}
|
|
113
|
-
/**
|
|
114
|
-
* Immediately executes the pending function if one exists.
|
|
115
|
-
* Bypasses the delay and cleans up state. If no pending call, does nothing.
|
|
116
|
-
*
|
|
117
|
-
* @example
|
|
118
|
-
* ```typescript
|
|
119
|
-
* const debouncer = new Debouncer({
|
|
120
|
-
* func: () => console.log('Flushed'),
|
|
121
|
-
* delay: 1000,
|
|
122
|
-
* });
|
|
123
|
-
* debouncer.trigger();
|
|
124
|
-
* setTimeout(() => debouncer.flush(), 500); // Executes immediately
|
|
125
|
-
*
|
|
126
|
-
* // Edge case: Flush after cancel does nothing
|
|
127
|
-
* debouncer.cancel();
|
|
128
|
-
* debouncer.flush(); // No execution
|
|
129
|
-
* ```
|
|
130
|
-
*/
|
|
131
|
-
flush() {
|
|
132
|
-
if (this.isPending) {
|
|
133
|
-
this.invoke__();
|
|
134
|
-
}
|
|
135
|
-
this.cancel();
|
|
136
|
-
}
|
|
137
|
-
/**
|
|
138
|
-
* The core execution logic.
|
|
139
|
-
*/
|
|
140
|
-
invoke__() {
|
|
141
|
-
if (this.lastArgs__) {
|
|
142
|
-
this.config__.func.apply(this.config__.thisContext, this.lastArgs__);
|
|
143
|
-
this.lastArgs__ = void 0;
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
};
|
|
147
|
-
|
|
148
|
-
// src/main.ts
|
|
149
|
-
function createDebouncer(config) {
|
|
150
|
-
return new Debouncer(config);
|
|
151
|
-
}
|
|
152
|
-
// Annotate the CommonJS export names for ESM import in node:
|
|
153
|
-
0 && (module.exports = {
|
|
154
|
-
Debouncer,
|
|
155
|
-
createDebouncer
|
|
156
|
-
});
|
|
1
|
+
/* @alwatr/debounce v1.1.2 */
|
|
2
|
+
"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}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});
|
|
157
3
|
//# sourceMappingURL=main.cjs.map
|
package/dist/main.cjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/main.ts", "../src/debounce.ts"],
|
|
4
|
-
"sourcesContent": ["import {Debouncer} from './debounce.js';\n\nimport type {DebouncerConfig} from './type.js';\n\nexport * from './debounce.js';\nexport type * from './type.js';\n\n/**\n * Factory function for creating a Debouncer instance for better type inference.\n * @param config Configuration for the debouncer.\n *\n * @example\n * ```typescript\n * const debouncer = createDebouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // With custom thisContext\n * const obj = { log: (msg: string) => console.log('Obj:', msg) };\n * const debouncerWithContext = createDebouncer({\n * func: obj.log,\n * thisContext: obj,\n * delay: 200,\n * });\n * debouncerWithContext.trigger('test'); // Logs 'Obj: test'\n * ```\n */\nexport function createDebouncer<F extends AnyFunction>(config: DebouncerConfig<F>): Debouncer<F> {\n return new Debouncer(config);\n}\n", "import type {DebouncerConfig} from './type.ts';\n\n/**\n * A powerful and type-safe Debouncer class.\n *\n * It encapsulates the debouncing logic, state, and provides a rich control API.\n * Debouncing delays function execution until after a specified delay has passed since the last invocation.\n * Useful for optimizing performance in scenarios like search inputs, resize events, or API calls.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // Advanced: With leading edge\n * const leadingDebouncer = new Debouncer({\n * func: () => console.log('Immediate and delayed'),\n * delay: 500,\n * leading: true,\n * trailing: true,\n * });\n * leadingDebouncer.trigger(); // Logs immediately, then again after 500ms if not cancelled\n * ```\n */\nexport class Debouncer<F extends AnyFunction> {\n private timerId__?: number | NodeJS.Timeout;\n private maxWaitTimerId__?: number | NodeJS.Timeout;\n private lastArgs__?: Parameters<F>;\n\n public constructor(private readonly config__: DebouncerConfig<F>) {\n this.config__.trailing ??= true;\n
|
|
5
|
-
"mappings": "
|
|
4
|
+
"sourcesContent": ["import {Debouncer} from './debounce.js';\n\nimport type {DebouncerConfig} from './type.js';\n\nexport * from './debounce.js';\nexport type * from './type.js';\n\n/**\n * Factory function for creating a Debouncer instance for better type inference.\n * @param config Configuration for the debouncer.\n *\n * @example\n * ```typescript\n * const debouncer = createDebouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // With custom thisContext\n * const obj = { log: (msg: string) => console.log('Obj:', msg) };\n * const debouncerWithContext = createDebouncer({\n * func: obj.log,\n * thisContext: obj,\n * delay: 200,\n * });\n * debouncerWithContext.trigger('test'); // Logs 'Obj: test'\n * ```\n */\nexport function createDebouncer<F extends AnyFunction>(config: DebouncerConfig<F>): Debouncer<F> {\n return new Debouncer(config);\n}\n", "import type {DebouncerConfig} from './type.ts';\n\n/**\n * A powerful and type-safe Debouncer class.\n *\n * It encapsulates the debouncing logic, state, and provides a rich control API.\n * Debouncing delays function execution until after a specified delay has passed since the last invocation.\n * Useful for optimizing performance in scenarios like search inputs, resize events, or API calls.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // Advanced: With leading edge\n * const leadingDebouncer = new Debouncer({\n * func: () => console.log('Immediate and delayed'),\n * delay: 500,\n * leading: true,\n * trailing: true,\n * });\n * leadingDebouncer.trigger(); // Logs immediately, then again after 500ms if not cancelled\n * ```\n */\nexport class Debouncer<F extends AnyFunction> {\n private timerId__?: number | NodeJS.Timeout;\n private maxWaitTimerId__?: number | NodeJS.Timeout;\n private lastArgs__?: Parameters<F>;\n\n public constructor(private readonly config__: DebouncerConfig<F>) {\n this.config__.trailing ??= true;\n }\n\n /**\n * Checks if there is a pending execution scheduled.\n * Returns true if a timer is active, indicating a debounced call is waiting.\n */\n public get isPending(): boolean {\n return this.timerId__ !== undefined;\n }\n\n /**\n * Triggers the debounced function with the stored `thisContext`.\n * @param args The arguments to pass to the `func`.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (value: number) => console.log('Value:', value),\n * delay: 500,\n * });\n * debouncer.trigger(42); // Logs after 500ms if not triggered again\n *\n * // Edge case: Rapid triggers only execute the last one\n * debouncer.trigger(1);\n * debouncer.trigger(2); // Only 2 will execute after delay\n * ```\n */\n public trigger(...args: Parameters<F>): void {\n this.lastArgs__ = args; // its an array even if triggered without any args\n const firstTrigger = !this.isPending;\n\n if (firstTrigger) {\n if (this.config__.maxWait) {\n this.maxWaitTimerId__ = setTimeout(() => this.flush, this.config__.maxWait);\n }\n if (this.config__.leading === true) {\n this.invoke__();\n }\n }\n else {\n clearTimeout(this.timerId__!);\n }\n\n this.timerId__ = setTimeout(() => {\n if (this.config__.trailing === true) {\n this.invoke__();\n }\n this.cleanup__();\n }, this.config__.delay);\n }\n\n /**\n * Cancels any pending debounced execution and cleans up internal state.\n * Useful for stopping execution when the operation is no longer needed (e.g., component unmount).\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: () => console.log('Executed'),\n * delay: 1000,\n * });\n * debouncer.trigger();\n * debouncer.cancel(); // Prevents execution\n *\n * // Note: After cancel, isPending becomes false\n * ```\n */\n public cancel(): void {\n if (this.timerId__) {\n clearTimeout(this.timerId__);\n }\n if (this.maxWaitTimerId__) {\n clearTimeout(this.maxWaitTimerId__);\n }\n this.cleanup__();\n }\n\n /**\n * Cleans up internal state by deleting timer and arguments.\n */\n private cleanup__(): void {\n delete this.timerId__;\n delete this.maxWaitTimerId__;\n delete this.lastArgs__;\n }\n\n /**\n * Immediately executes the pending function if one exists.\n * Bypasses the delay and cleans up state. If no pending call, does nothing.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: () => console.log('Flushed'),\n * delay: 1000,\n * });\n * debouncer.trigger();\n * setTimeout(() => debouncer.flush(), 500); // Executes immediately\n *\n * // Edge case: Flush after cancel does nothing\n * debouncer.cancel();\n * debouncer.flush(); // No execution\n * ```\n */\n public flush(): void {\n if (this.isPending) {\n this.invoke__();\n }\n this.cancel();\n }\n\n /**\n * The core execution logic.\n */\n private invoke__(): void {\n if (this.lastArgs__) {\n // only call if we have new args (skip trailing call if leading already called)\n this.config__.func.apply(this.config__.thisContext, this.lastArgs__);\n this.lastArgs__ = undefined;\n }\n }\n}\n"],
|
|
5
|
+
"mappings": ";qqBAAA,mJCgCO,IAAM,UAAN,KAAuC,CAKrC,YAA6B,SAA8B,CAA9B,uBAClC,KAAK,SAAS,WAAa,IAC7B,CAMA,IAAW,WAAqB,CAC9B,OAAO,KAAK,YAAc,MAC5B,CAmBO,WAAW,KAA2B,CAC3C,KAAK,WAAa,KAClB,MAAM,aAAe,CAAC,KAAK,UAE3B,GAAI,aAAc,CAChB,GAAI,KAAK,SAAS,QAAS,CACzB,KAAK,iBAAmB,WAAW,IAAM,KAAK,MAAO,KAAK,SAAS,OAAO,CAC5E,CACA,GAAI,KAAK,SAAS,UAAY,KAAM,CAClC,KAAK,SAAS,CAChB,CACF,KACK,CACH,aAAa,KAAK,SAAU,CAC9B,CAEA,KAAK,UAAY,WAAW,IAAM,CAChC,GAAI,KAAK,SAAS,WAAa,KAAM,CACnC,KAAK,SAAS,CAChB,CACA,KAAK,UAAU,CACjB,EAAG,KAAK,SAAS,KAAK,CACxB,CAkBO,QAAe,CACpB,GAAI,KAAK,UAAW,CAClB,aAAa,KAAK,SAAS,CAC7B,CACA,GAAI,KAAK,iBAAkB,CACzB,aAAa,KAAK,gBAAgB,CACpC,CACA,KAAK,UAAU,CACjB,CAKQ,WAAkB,CACxB,OAAO,KAAK,UACZ,OAAO,KAAK,iBACZ,OAAO,KAAK,UACd,CAoBO,OAAc,CACnB,GAAI,KAAK,UAAW,CAClB,KAAK,SAAS,CAChB,CACA,KAAK,OAAO,CACd,CAKQ,UAAiB,CACvB,GAAI,KAAK,WAAY,CAEnB,KAAK,SAAS,KAAK,MAAM,KAAK,SAAS,YAAa,KAAK,UAAU,EACnE,KAAK,WAAa,MACpB,CACF,CACF,ED9HO,SAAS,gBAAuC,OAA0C,CAC/F,OAAO,IAAI,UAAU,MAAM,CAC7B",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/dist/main.mjs
CHANGED
|
@@ -1,130 +1,3 @@
|
|
|
1
|
-
/* @alwatr/debounce v1.1.
|
|
2
|
-
|
|
3
|
-
// src/debounce.ts
|
|
4
|
-
var Debouncer = class {
|
|
5
|
-
constructor(config__) {
|
|
6
|
-
this.config__ = config__;
|
|
7
|
-
this.config__.trailing ??= true;
|
|
8
|
-
this.flush = this.flush.bind(this);
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* Checks if there is a pending execution scheduled.
|
|
12
|
-
* Returns true if a timer is active, indicating a debounced call is waiting.
|
|
13
|
-
*/
|
|
14
|
-
get isPending() {
|
|
15
|
-
return this.timerId__ !== void 0;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Triggers the debounced function with the stored `thisContext`.
|
|
19
|
-
* @param args The arguments to pass to the `func`.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```typescript
|
|
23
|
-
* const debouncer = new Debouncer({
|
|
24
|
-
* func: (value: number) => console.log('Value:', value),
|
|
25
|
-
* delay: 500,
|
|
26
|
-
* });
|
|
27
|
-
* debouncer.trigger(42); // Logs after 500ms if not triggered again
|
|
28
|
-
*
|
|
29
|
-
* // Edge case: Rapid triggers only execute the last one
|
|
30
|
-
* debouncer.trigger(1);
|
|
31
|
-
* debouncer.trigger(2); // Only 2 will execute after delay
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
trigger(...args) {
|
|
35
|
-
this.lastArgs__ = args;
|
|
36
|
-
const firstTrigger = !this.isPending;
|
|
37
|
-
if (firstTrigger) {
|
|
38
|
-
if (this.config__.maxWait) {
|
|
39
|
-
this.maxWaitTimerId__ = setTimeout(this.flush, this.config__.maxWait);
|
|
40
|
-
}
|
|
41
|
-
if (this.config__.leading === true) {
|
|
42
|
-
this.invoke__();
|
|
43
|
-
}
|
|
44
|
-
} else {
|
|
45
|
-
clearTimeout(this.timerId__);
|
|
46
|
-
}
|
|
47
|
-
this.timerId__ = setTimeout(() => {
|
|
48
|
-
if (this.config__.trailing === true) {
|
|
49
|
-
this.invoke__();
|
|
50
|
-
}
|
|
51
|
-
this.cleanup__();
|
|
52
|
-
}, this.config__.delay);
|
|
53
|
-
}
|
|
54
|
-
/**
|
|
55
|
-
* Cancels any pending debounced execution and cleans up internal state.
|
|
56
|
-
* Useful for stopping execution when the operation is no longer needed (e.g., component unmount).
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* ```typescript
|
|
60
|
-
* const debouncer = new Debouncer({
|
|
61
|
-
* func: () => console.log('Executed'),
|
|
62
|
-
* delay: 1000,
|
|
63
|
-
* });
|
|
64
|
-
* debouncer.trigger();
|
|
65
|
-
* debouncer.cancel(); // Prevents execution
|
|
66
|
-
*
|
|
67
|
-
* // Note: After cancel, isPending becomes false
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
cancel() {
|
|
71
|
-
if (this.timerId__) {
|
|
72
|
-
clearTimeout(this.timerId__);
|
|
73
|
-
}
|
|
74
|
-
if (this.maxWaitTimerId__) {
|
|
75
|
-
clearTimeout(this.maxWaitTimerId__);
|
|
76
|
-
}
|
|
77
|
-
this.cleanup__();
|
|
78
|
-
}
|
|
79
|
-
/**
|
|
80
|
-
* Cleans up internal state by deleting timer and arguments.
|
|
81
|
-
*/
|
|
82
|
-
cleanup__() {
|
|
83
|
-
delete this.timerId__;
|
|
84
|
-
delete this.maxWaitTimerId__;
|
|
85
|
-
delete this.lastArgs__;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* Immediately executes the pending function if one exists.
|
|
89
|
-
* Bypasses the delay and cleans up state. If no pending call, does nothing.
|
|
90
|
-
*
|
|
91
|
-
* @example
|
|
92
|
-
* ```typescript
|
|
93
|
-
* const debouncer = new Debouncer({
|
|
94
|
-
* func: () => console.log('Flushed'),
|
|
95
|
-
* delay: 1000,
|
|
96
|
-
* });
|
|
97
|
-
* debouncer.trigger();
|
|
98
|
-
* setTimeout(() => debouncer.flush(), 500); // Executes immediately
|
|
99
|
-
*
|
|
100
|
-
* // Edge case: Flush after cancel does nothing
|
|
101
|
-
* debouncer.cancel();
|
|
102
|
-
* debouncer.flush(); // No execution
|
|
103
|
-
* ```
|
|
104
|
-
*/
|
|
105
|
-
flush() {
|
|
106
|
-
if (this.isPending) {
|
|
107
|
-
this.invoke__();
|
|
108
|
-
}
|
|
109
|
-
this.cancel();
|
|
110
|
-
}
|
|
111
|
-
/**
|
|
112
|
-
* The core execution logic.
|
|
113
|
-
*/
|
|
114
|
-
invoke__() {
|
|
115
|
-
if (this.lastArgs__) {
|
|
116
|
-
this.config__.func.apply(this.config__.thisContext, this.lastArgs__);
|
|
117
|
-
this.lastArgs__ = void 0;
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
};
|
|
121
|
-
|
|
122
|
-
// src/main.ts
|
|
123
|
-
function createDebouncer(config) {
|
|
124
|
-
return new Debouncer(config);
|
|
125
|
-
}
|
|
126
|
-
export {
|
|
127
|
-
Debouncer,
|
|
128
|
-
createDebouncer
|
|
129
|
-
};
|
|
1
|
+
/* @alwatr/debounce v1.1.2 */
|
|
2
|
+
var Debouncer=class{constructor(config__){this.config__=config__;this.config__.trailing??=true}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};
|
|
130
3
|
//# sourceMappingURL=main.mjs.map
|
package/dist/main.mjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/debounce.ts", "../src/main.ts"],
|
|
4
|
-
"sourcesContent": ["import type {DebouncerConfig} from './type.ts';\n\n/**\n * A powerful and type-safe Debouncer class.\n *\n * It encapsulates the debouncing logic, state, and provides a rich control API.\n * Debouncing delays function execution until after a specified delay has passed since the last invocation.\n * Useful for optimizing performance in scenarios like search inputs, resize events, or API calls.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // Advanced: With leading edge\n * const leadingDebouncer = new Debouncer({\n * func: () => console.log('Immediate and delayed'),\n * delay: 500,\n * leading: true,\n * trailing: true,\n * });\n * leadingDebouncer.trigger(); // Logs immediately, then again after 500ms if not cancelled\n * ```\n */\nexport class Debouncer<F extends AnyFunction> {\n private timerId__?: number | NodeJS.Timeout;\n private maxWaitTimerId__?: number | NodeJS.Timeout;\n private lastArgs__?: Parameters<F>;\n\n public constructor(private readonly config__: DebouncerConfig<F>) {\n this.config__.trailing ??= true;\n
|
|
5
|
-
"mappings": "
|
|
4
|
+
"sourcesContent": ["import type {DebouncerConfig} from './type.ts';\n\n/**\n * A powerful and type-safe Debouncer class.\n *\n * It encapsulates the debouncing logic, state, and provides a rich control API.\n * Debouncing delays function execution until after a specified delay has passed since the last invocation.\n * Useful for optimizing performance in scenarios like search inputs, resize events, or API calls.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // Advanced: With leading edge\n * const leadingDebouncer = new Debouncer({\n * func: () => console.log('Immediate and delayed'),\n * delay: 500,\n * leading: true,\n * trailing: true,\n * });\n * leadingDebouncer.trigger(); // Logs immediately, then again after 500ms if not cancelled\n * ```\n */\nexport class Debouncer<F extends AnyFunction> {\n private timerId__?: number | NodeJS.Timeout;\n private maxWaitTimerId__?: number | NodeJS.Timeout;\n private lastArgs__?: Parameters<F>;\n\n public constructor(private readonly config__: DebouncerConfig<F>) {\n this.config__.trailing ??= true;\n }\n\n /**\n * Checks if there is a pending execution scheduled.\n * Returns true if a timer is active, indicating a debounced call is waiting.\n */\n public get isPending(): boolean {\n return this.timerId__ !== undefined;\n }\n\n /**\n * Triggers the debounced function with the stored `thisContext`.\n * @param args The arguments to pass to the `func`.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: (value: number) => console.log('Value:', value),\n * delay: 500,\n * });\n * debouncer.trigger(42); // Logs after 500ms if not triggered again\n *\n * // Edge case: Rapid triggers only execute the last one\n * debouncer.trigger(1);\n * debouncer.trigger(2); // Only 2 will execute after delay\n * ```\n */\n public trigger(...args: Parameters<F>): void {\n this.lastArgs__ = args; // its an array even if triggered without any args\n const firstTrigger = !this.isPending;\n\n if (firstTrigger) {\n if (this.config__.maxWait) {\n this.maxWaitTimerId__ = setTimeout(() => this.flush, this.config__.maxWait);\n }\n if (this.config__.leading === true) {\n this.invoke__();\n }\n }\n else {\n clearTimeout(this.timerId__!);\n }\n\n this.timerId__ = setTimeout(() => {\n if (this.config__.trailing === true) {\n this.invoke__();\n }\n this.cleanup__();\n }, this.config__.delay);\n }\n\n /**\n * Cancels any pending debounced execution and cleans up internal state.\n * Useful for stopping execution when the operation is no longer needed (e.g., component unmount).\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: () => console.log('Executed'),\n * delay: 1000,\n * });\n * debouncer.trigger();\n * debouncer.cancel(); // Prevents execution\n *\n * // Note: After cancel, isPending becomes false\n * ```\n */\n public cancel(): void {\n if (this.timerId__) {\n clearTimeout(this.timerId__);\n }\n if (this.maxWaitTimerId__) {\n clearTimeout(this.maxWaitTimerId__);\n }\n this.cleanup__();\n }\n\n /**\n * Cleans up internal state by deleting timer and arguments.\n */\n private cleanup__(): void {\n delete this.timerId__;\n delete this.maxWaitTimerId__;\n delete this.lastArgs__;\n }\n\n /**\n * Immediately executes the pending function if one exists.\n * Bypasses the delay and cleans up state. If no pending call, does nothing.\n *\n * @example\n * ```typescript\n * const debouncer = new Debouncer({\n * func: () => console.log('Flushed'),\n * delay: 1000,\n * });\n * debouncer.trigger();\n * setTimeout(() => debouncer.flush(), 500); // Executes immediately\n *\n * // Edge case: Flush after cancel does nothing\n * debouncer.cancel();\n * debouncer.flush(); // No execution\n * ```\n */\n public flush(): void {\n if (this.isPending) {\n this.invoke__();\n }\n this.cancel();\n }\n\n /**\n * The core execution logic.\n */\n private invoke__(): void {\n if (this.lastArgs__) {\n // only call if we have new args (skip trailing call if leading already called)\n this.config__.func.apply(this.config__.thisContext, this.lastArgs__);\n this.lastArgs__ = undefined;\n }\n }\n}\n", "import {Debouncer} from './debounce.js';\n\nimport type {DebouncerConfig} from './type.js';\n\nexport * from './debounce.js';\nexport type * from './type.js';\n\n/**\n * Factory function for creating a Debouncer instance for better type inference.\n * @param config Configuration for the debouncer.\n *\n * @example\n * ```typescript\n * const debouncer = createDebouncer({\n * func: (text: string) => console.log('Searching:', text),\n * delay: 300,\n * leading: false,\n * trailing: true,\n * });\n *\n * // Debounce search input\n * debouncer.trigger('hello');\n * debouncer.trigger('hello world'); // Only 'hello world' will log after 300ms\n *\n * // With custom thisContext\n * const obj = { log: (msg: string) => console.log('Obj:', msg) };\n * const debouncerWithContext = createDebouncer({\n * func: obj.log,\n * thisContext: obj,\n * delay: 200,\n * });\n * debouncerWithContext.trigger('test'); // Logs 'Obj: test'\n * ```\n */\nexport function createDebouncer<F extends AnyFunction>(config: DebouncerConfig<F>): Debouncer<F> {\n return new Debouncer(config);\n}\n"],
|
|
5
|
+
"mappings": ";AAgCO,IAAM,UAAN,KAAuC,CAKrC,YAA6B,SAA8B,CAA9B,uBAClC,KAAK,SAAS,WAAa,IAC7B,CAMA,IAAW,WAAqB,CAC9B,OAAO,KAAK,YAAc,MAC5B,CAmBO,WAAW,KAA2B,CAC3C,KAAK,WAAa,KAClB,MAAM,aAAe,CAAC,KAAK,UAE3B,GAAI,aAAc,CAChB,GAAI,KAAK,SAAS,QAAS,CACzB,KAAK,iBAAmB,WAAW,IAAM,KAAK,MAAO,KAAK,SAAS,OAAO,CAC5E,CACA,GAAI,KAAK,SAAS,UAAY,KAAM,CAClC,KAAK,SAAS,CAChB,CACF,KACK,CACH,aAAa,KAAK,SAAU,CAC9B,CAEA,KAAK,UAAY,WAAW,IAAM,CAChC,GAAI,KAAK,SAAS,WAAa,KAAM,CACnC,KAAK,SAAS,CAChB,CACA,KAAK,UAAU,CACjB,EAAG,KAAK,SAAS,KAAK,CACxB,CAkBO,QAAe,CACpB,GAAI,KAAK,UAAW,CAClB,aAAa,KAAK,SAAS,CAC7B,CACA,GAAI,KAAK,iBAAkB,CACzB,aAAa,KAAK,gBAAgB,CACpC,CACA,KAAK,UAAU,CACjB,CAKQ,WAAkB,CACxB,OAAO,KAAK,UACZ,OAAO,KAAK,iBACZ,OAAO,KAAK,UACd,CAoBO,OAAc,CACnB,GAAI,KAAK,UAAW,CAClB,KAAK,SAAS,CAChB,CACA,KAAK,OAAO,CACd,CAKQ,UAAiB,CACvB,GAAI,KAAK,WAAY,CAEnB,KAAK,SAAS,KAAK,MAAM,KAAK,SAAS,YAAa,KAAK,UAAU,EACnE,KAAK,WAAa,MACpB,CACF,CACF,EC9HO,SAAS,gBAAuC,OAA0C,CAC/F,OAAO,IAAI,UAAU,MAAM,CAC7B",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwatr/debounce",
|
|
3
3
|
"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.",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.2",
|
|
5
5
|
"author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
|
|
6
6
|
"bugs": "https://github.com/Alwatr/nanolib/issues",
|
|
7
7
|
"devDependencies": {
|
|
8
|
-
"@alwatr/nano-build": "6.
|
|
8
|
+
"@alwatr/nano-build": "6.2.0",
|
|
9
9
|
"@alwatr/prettier-config": "5.0.3",
|
|
10
10
|
"@alwatr/tsconfig-base": "6.0.1",
|
|
11
11
|
"@alwatr/type-helper": "6.0.2",
|
|
@@ -78,5 +78,5 @@
|
|
|
78
78
|
},
|
|
79
79
|
"type": "module",
|
|
80
80
|
"types": "./dist/main.d.ts",
|
|
81
|
-
"gitHead": "
|
|
81
|
+
"gitHead": "e081773e1ba6bf1c62c07d7dc966b174fa7dd3ea"
|
|
82
82
|
}
|