@tanstack/pacer 0.1.0 → 0.2.0

package/dist/cjs/async-debouncer.cjs

@@ -6,17 +6,19 @@ const defaultOptions = {
   trailing: true,
   onError: () => {
   },
+  onExecute: () => {
+  },
   wait: 0
 };
 class AsyncDebouncer {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this.abortController = null;
-    this.executionCount = 0;
-    this.isExecuting = false;
-    this.timeoutId = null;
-    this.canLeadingExecute = true;
-    this.options = {
+    this._abortController = null;
+    this._executionCount = 0;
+    this._isExecuting = false;
+    this._timeoutId = null;
+    this._canLeadingExecute = true;
+    this._options = {
       ...defaultOptions,
       ...initialOptions
     };
@@ -26,32 +28,17 @@ class AsyncDebouncer {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this.options = {
-      ...this.options,
+    this._options = {
+      ...this._options,
       ...newOptions
     };
-    return this.options;
+    return this._options;
   }
   /**
-   * Returns the number of times the function has been executed
+   * Returns the current debouncer options
    */
-  getExecutionCount() {
-    return this.executionCount;
-  }
-  /**
-   * Cancels any pending execution
-   */
-  cancel() {
-    if (this.timeoutId) {
-      clearTimeout(this.timeoutId);
-      this.timeoutId = null;
-    }
-    if (this.abortController) {
-      this.abortController.abort();
-      this.abortController = null;
-    }
-    this.lastArgs = void 0;
-    this.canLeadingExecute = true;
+  getOptions() {
+    return this._options;
   }
   /**
    * Attempts to execute the debounced function
@@ -59,45 +46,74 @@ class AsyncDebouncer {
    */
   async maybeExecute(...args) {
     this.cancel();
-    this.lastArgs = args;
-    if (this.options.leading && this.canLeadingExecute) {
-      this.canLeadingExecute = false;
+    this._lastArgs = args;
+    if (this._options.leading && this._canLeadingExecute) {
+      this._canLeadingExecute = false;
       await this.executeFunction(...args);
     }
     return new Promise((resolve) => {
-      this.timeoutId = setTimeout(async () => {
-        if (this.isExecuting) {
+      this._timeoutId = setTimeout(async () => {
+        if (this._isExecuting) {
           resolve();
           return;
         }
-        this.canLeadingExecute = true;
-        if (this.options.trailing) {
-          this.abortController = new AbortController();
+        this._canLeadingExecute = true;
+        if (this._options.trailing) {
+          this._abortController = new AbortController();
           try {
-            this.isExecuting = true;
-            if (this.lastArgs) {
-              await this.executeFunction(...this.lastArgs);
+            this._isExecuting = true;
+            if (this._lastArgs) {
+              await this.executeFunction(...this._lastArgs);
             }
           } catch (error) {
             try {
-              this.options.onError(error);
+              this._options.onError(error);
             } catch {
+              console.error("Error in error handler", error);
             }
           } finally {
-            this.isExecuting = false;
-            this.abortController = null;
+            this._isExecuting = false;
+            this._abortController = null;
             resolve();
           }
         } else {
           resolve();
         }
-      }, this.options.wait);
+      }, this._options.wait);
     });
   }
   async executeFunction(...args) {
-    if (!this.options.enabled) return;
-    this.executionCount++;
+    if (!this._options.enabled) return;
+    this._executionCount++;
     await this.fn(...args);
+    this._options.onExecute(this);
+  }
+  /**
+   * Cancels any pending execution
+   */
+  cancel() {
+    if (this._timeoutId) {
+      clearTimeout(this._timeoutId);
+      this._timeoutId = null;
+    }
+    if (this._abortController) {
+      this._abortController.abort();
+      this._abortController = null;
+    }
+    this._lastArgs = void 0;
+    this._canLeadingExecute = true;
+  }
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getExecutionCount() {
+    return this._executionCount;
+  }
+  /**
+   * Returns `true` if there is a pending execution
+   */
+  getIsPending() {
+    return this._options.enabled && (this._timeoutId !== null || this._isExecuting);
   }
 }
 function asyncDebounce(fn, initialOptions) {

package/dist/cjs/async-debouncer.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"async-debouncer.cjs","sources":["../../src/async-debouncer.ts"],"sourcesContent":["/**\n * Options for configuring an async debounced function\n */\nexport interface AsyncDebouncerOptions {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Delay in milliseconds to wait after the last call before executing\n   * Defaults to 0ms\n   */\n  wait: number\n  /**\n   * Optional error handler for when the debounced function throws\n   */\n  onError?: (error: unknown) => void\n}\n\nconst defaultOptions: Required<AsyncDebouncerOptions> = {\n  enabled: true,\n  leading: false,\n  trailing: true,\n  onError: () => {},\n  wait: 0,\n}\n\n/**\n * A class that creates an async debounced function.\n *\n * Debouncing ensures that a function is only executed after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * @example\n * ```ts\n * const debouncer = new AsyncDebouncer(async (value: string) => {\n *   await searchAPI(value);\n * }, { wait: 500 });\n *\n * // Called on each keystroke but only executes after 500ms of no typing\n * inputElement.addEventListener('input', () => {\n *   debouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class AsyncDebouncer<\n  TFn extends (...args: Array<any>) => Promise<any>,\n  TArgs extends Parameters<TFn>,\n> {\n  private abortController: AbortController | null = null\n  private executionCount = 0\n  private isExecuting = false\n  private lastArgs: TArgs | undefined\n  private options: Required<AsyncDebouncerOptions>\n  private timeoutId: ReturnType<typeof setTimeout> | null = null\n  private canLeadingExecute = true\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncDebouncerOptions,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the debouncer options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncDebouncerOptions>,\n  ): Required<AsyncDebouncerOptions> {\n    this.options = {\n      ...this.options,\n      ...newOptions,\n    }\n    return this.options\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this.executionCount\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this.timeoutId) {\n      clearTimeout(this.timeoutId)\n      this.timeoutId = null\n    }\n    if (this.abortController) {\n      this.abortController.abort()\n      this.abortController = null\n    }\n    this.lastArgs = undefined\n    this.canLeadingExecute = true\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  async maybeExecute(...args: TArgs): Promise<void> {\n    this.cancel()\n    this.lastArgs = args\n\n    // Handle leading execution\n    if (this.options.leading && this.canLeadingExecute) {\n      this.canLeadingExecute = false\n      await this.executeFunction(...args)\n    }\n\n    return new Promise((resolve) => {\n      this.timeoutId = setTimeout(async () => {\n        if (this.isExecuting) {\n          resolve()\n          return\n        }\n\n        this.canLeadingExecute = true\n        // Execute trailing only if enabled\n        if (this.options.trailing) {\n          this.abortController = new AbortController()\n          try {\n            this.isExecuting = true\n            if (this.lastArgs) {\n              await this.executeFunction(...this.lastArgs)\n            }\n          } catch (error) {\n            try {\n              this.options.onError(error)\n            } catch {\n              // Ignore errors from error handler\n            }\n          } finally {\n            this.isExecuting = false\n            this.abortController = null\n            resolve()\n          }\n        } else {\n          resolve()\n        }\n      }, this.options.wait)\n    })\n  }\n\n  private async executeFunction(...args: TArgs): Promise<void> {\n    if (!this.options.enabled) return\n    this.executionCount++\n    await this.fn(...args)\n  }\n}\n\n/**\n * Creates an async debounced function that delays execution until after a specified wait time.\n * The debounced function will only execute once the wait period has elapsed without any new calls.\n * If called again during the wait period, the timer resets and a new wait period begins.\n *\n * @example\n * ```ts\n * const debounced = asyncDebounce(async (value: string) => {\n *   await saveToAPI(value);\n * }, { wait: 1000 });\n *\n * // Will only execute once, 1 second after the last call\n * await debounced(\"first\");  // Cancelled\n * await debounced(\"second\"); // Cancelled\n * await debounced(\"third\");  // Executes after 1s\n * ```\n */\nexport function asyncDebounce<\n  TFn extends (...args: Array<any>) => Promise<any>,\n>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions, 'enabled'>) {\n  const asyncDebouncer = new AsyncDebouncer(fn, initialOptions)\n  return asyncDebouncer.maybeExecute.bind(asyncDebouncer)\n}\n"],"names":[],"mappings":";;AA8BA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,MAAM;AACR;AAwBO,MAAM,eAGX;AAAA,EASA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,kBAA0C;AAClD,SAAQ,iBAAiB;AACzB,SAAQ,cAAc;AAGtB,SAAQ,YAAkD;AAC1D,SAAQ,oBAAoB;AAM1B,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACiC;AACjC,SAAK,UAAU;AAAA,MACb,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAe;AACb,QAAI,KAAK,WAAW;AAClB,mBAAa,KAAK,SAAS;AAC3B,WAAK,YAAY;AAAA,IAAA;AAEnB,QAAI,KAAK,iBAAiB;AACxB,WAAK,gBAAgB,MAAM;AAC3B,WAAK,kBAAkB;AAAA,IAAA;AAEzB,SAAK,WAAW;AAChB,SAAK,oBAAoB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3B,MAAM,gBAAgB,MAA4B;AAChD,SAAK,OAAO;AACZ,SAAK,WAAW;AAGhB,QAAI,KAAK,QAAQ,WAAW,KAAK,mBAAmB;AAClD,WAAK,oBAAoB;AACnB,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAAA,IAAA;AAG7B,WAAA,IAAI,QAAQ,CAAC,YAAY;AACzB,WAAA,YAAY,WAAW,YAAY;AACtC,YAAI,KAAK,aAAa;AACZ,kBAAA;AACR;AAAA,QAAA;AAGF,aAAK,oBAAoB;AAErB,YAAA,KAAK,QAAQ,UAAU;AACpB,eAAA,kBAAkB,IAAI,gBAAgB;AACvC,cAAA;AACF,iBAAK,cAAc;AACnB,gBAAI,KAAK,UAAU;AACjB,oBAAM,KAAK,gBAAgB,GAAG,KAAK,QAAQ;AAAA,YAAA;AAAA,mBAEtC,OAAO;AACV,gBAAA;AACG,mBAAA,QAAQ,QAAQ,KAAK;AAAA,YAAA,QACpB;AAAA,YAAA;AAAA,UAER,UACA;AACA,iBAAK,cAAc;AACnB,iBAAK,kBAAkB;AACf,oBAAA;AAAA,UAAA;AAAA,QACV,OACK;AACG,kBAAA;AAAA,QAAA;AAAA,MACV,GACC,KAAK,QAAQ,IAAI;AAAA,IAAA,CACrB;AAAA,EAAA;AAAA,EAGH,MAAc,mBAAmB,MAA4B;AACvD,QAAA,CAAC,KAAK,QAAQ,QAAS;AACtB,SAAA;AACC,UAAA,KAAK,GAAG,GAAG,IAAI;AAAA,EAAA;AAEzB;AAmBgB,SAAA,cAEd,IAAS,gBAAwD;AACjE,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;;;"}
+{"version":3,"file":"async-debouncer.cjs","sources":["../../src/async-debouncer.ts"],"sourcesContent":["import type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async debounced function\n */\nexport interface AsyncDebouncerOptions<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Optional error handler for when the debounced function throws\n   */\n  onError?: (error: unknown) => void\n  /**\n   * Optional function to call when the debounced function is executed\n   */\n  onExecute?: (debouncer: AsyncDebouncer<TFn, TArgs>) => void\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Delay in milliseconds to wait after the last call before executing\n   * Defaults to 0ms\n   */\n  wait: number\n}\n\nconst defaultOptions: Required<AsyncDebouncerOptions<any, any>> = {\n  enabled: true,\n  leading: false,\n  trailing: true,\n  onError: () => {},\n  onExecute: () => {},\n  wait: 0,\n}\n\n/**\n * A class that creates an async debounced function.\n *\n * Debouncing ensures that a function is only executed after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * @example\n * ```ts\n * const asyncDebouncer = new AsyncDebouncer(async (value: string) => {\n *   await searchAPI(value);\n * }, { wait: 500 });\n *\n * // Called on each keystroke but only executes after 500ms of no typing\n * inputElement.addEventListener('input', () => {\n *   asyncDebouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class AsyncDebouncer<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  private _abortController: AbortController | null = null\n  private _executionCount = 0\n  private _isExecuting = false\n  private _lastArgs: TArgs | undefined\n  private _options: Required<AsyncDebouncerOptions<TFn, TArgs>>\n  private _timeoutId: ReturnType<typeof setTimeout> | null = null\n  private _canLeadingExecute = true\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncDebouncerOptions<TFn, TArgs>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the debouncer options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncDebouncerOptions<TFn, TArgs>>,\n  ): Required<AsyncDebouncerOptions<TFn, TArgs>> {\n    this._options = {\n      ...this._options,\n      ...newOptions,\n    }\n    return this._options\n  }\n\n  /**\n   * Returns the current debouncer options\n   */\n  getOptions(): Required<AsyncDebouncerOptions<TFn, TArgs>> {\n    return this._options\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  async maybeExecute(...args: TArgs): Promise<void> {\n    this.cancel()\n    this._lastArgs = args\n\n    // Handle leading execution\n    if (this._options.leading && this._canLeadingExecute) {\n      this._canLeadingExecute = false\n      await this.executeFunction(...args)\n    }\n\n    return new Promise((resolve) => {\n      this._timeoutId = setTimeout(async () => {\n        if (this._isExecuting) {\n          resolve()\n          return\n        }\n\n        this._canLeadingExecute = true\n        // Execute trailing only if enabled\n        if (this._options.trailing) {\n          this._abortController = new AbortController()\n          try {\n            this._isExecuting = true\n            if (this._lastArgs) {\n              await this.executeFunction(...this._lastArgs)\n            }\n          } catch (error) {\n            try {\n              this._options.onError(error)\n            } catch {\n              console.error('Error in error handler', error)\n            }\n          } finally {\n            this._isExecuting = false\n            this._abortController = null\n            resolve()\n          }\n        } else {\n          resolve()\n        }\n      }, this._options.wait)\n    })\n  }\n\n  private async executeFunction(...args: TArgs): Promise<void> {\n    if (!this._options.enabled) return\n    this._executionCount++\n    await this.fn(...args)\n    this._options.onExecute(this)\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this._timeoutId) {\n      clearTimeout(this._timeoutId)\n      this._timeoutId = null\n    }\n    if (this._abortController) {\n      this._abortController.abort()\n      this._abortController = null\n    }\n    this._lastArgs = undefined\n    this._canLeadingExecute = true\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this._executionCount\n  }\n\n  /**\n   * Returns `true` if there is a pending execution\n   */\n  getIsPending(): boolean {\n    return (\n      this._options.enabled && (this._timeoutId !== null || this._isExecuting)\n    )\n  }\n}\n\n/**\n * Creates an async debounced function that delays execution until after a specified wait time.\n * The debounced function will only execute once the wait period has elapsed without any new calls.\n * If called again during the wait period, the timer resets and a new wait period begins.\n *\n * @example\n * ```ts\n * const debounced = asyncDebounce(async (value: string) => {\n *   await saveToAPI(value);\n * }, { wait: 1000 });\n *\n * // Will only execute once, 1 second after the last call\n * await debounced(\"first\");  // Cancelled\n * await debounced(\"second\"); // Cancelled\n * await debounced(\"third\");  // Executes after 1s\n * ```\n */\nexport function asyncDebounce<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions<TFn, TArgs>, 'enabled'>) {\n  const asyncDebouncer = new AsyncDebouncer(fn, initialOptions)\n  return asyncDebouncer.maybeExecute.bind(asyncDebouncer)\n}\n"],"names":[],"mappings":";;AAuCA,MAAM,iBAA4D;AAAA,EAChE,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,MAAM;AACR;AAwBO,MAAM,eAGX;AAAA,EASA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,mBAA2C;AACnD,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AAGvB,SAAQ,aAAmD;AAC3D,SAAQ,qBAAqB;AAM3B,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YAC6C;AAC7C,SAAK,WAAW;AAAA,MACd,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAA0D;AACxD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,MAAM,gBAAgB,MAA4B;AAChD,SAAK,OAAO;AACZ,SAAK,YAAY;AAGjB,QAAI,KAAK,SAAS,WAAW,KAAK,oBAAoB;AACpD,WAAK,qBAAqB;AACpB,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAAA,IAAA;AAG7B,WAAA,IAAI,QAAQ,CAAC,YAAY;AACzB,WAAA,aAAa,WAAW,YAAY;AACvC,YAAI,KAAK,cAAc;AACb,kBAAA;AACR;AAAA,QAAA;AAGF,aAAK,qBAAqB;AAEtB,YAAA,KAAK,SAAS,UAAU;AACrB,eAAA,mBAAmB,IAAI,gBAAgB;AACxC,cAAA;AACF,iBAAK,eAAe;AACpB,gBAAI,KAAK,WAAW;AAClB,oBAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,YAAA;AAAA,mBAEvC,OAAO;AACV,gBAAA;AACG,mBAAA,SAAS,QAAQ,KAAK;AAAA,YAAA,QACrB;AACE,sBAAA,MAAM,0BAA0B,KAAK;AAAA,YAAA;AAAA,UAC/C,UACA;AACA,iBAAK,eAAe;AACpB,iBAAK,mBAAmB;AAChB,oBAAA;AAAA,UAAA;AAAA,QACV,OACK;AACG,kBAAA;AAAA,QAAA;AAAA,MACV,GACC,KAAK,SAAS,IAAI;AAAA,IAAA,CACtB;AAAA,EAAA;AAAA,EAGH,MAAc,mBAAmB,MAA4B;AACvD,QAAA,CAAC,KAAK,SAAS,QAAS;AACvB,SAAA;AACC,UAAA,KAAK,GAAG,GAAG,IAAI;AAChB,SAAA,SAAS,UAAU,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,aAAa;AAAA,IAAA;AAEpB,QAAI,KAAK,kBAAkB;AACzB,WAAK,iBAAiB,MAAM;AAC5B,WAAK,mBAAmB;AAAA,IAAA;AAE1B,SAAK,YAAY;AACjB,SAAK,qBAAqB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WACE,KAAK,SAAS,YAAY,KAAK,eAAe,QAAQ,KAAK;AAAA,EAAA;AAGjE;AAmBgB,SAAA,cAGd,IAAS,gBAAoE;AAC7E,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;;;"}

package/dist/cjs/async-debouncer.d.cts

@@ -1,7 +1,8 @@
+import { AnyAsyncFunction } from './types.cjs';
 /**
  * Options for configuring an async debounced function
  */
-export interface AsyncDebouncerOptions {
+export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
     /**
      * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -12,6 +13,14 @@ export interface AsyncDebouncerOptions {
      * Defaults to false.
      */
     leading?: boolean;
+    /**
+     * Optional error handler for when the debounced function throws
+     */
+    onError?: (error: unknown) => void;
+    /**
+     * Optional function to call when the debounced function is executed
+     */
+    onExecute?: (debouncer: AsyncDebouncer<TFn, TArgs>) => void;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.
@@ -22,10 +31,6 @@ export interface AsyncDebouncerOptions {
      * Defaults to 0ms
      */
     wait: number;
-    /**
-     * Optional error handler for when the debounced function throws
-     */
-    onError?: (error: unknown) => void;
 }
 /**
  * A class that creates an async debounced function.
@@ -39,45 +44,53 @@ export interface AsyncDebouncerOptions {
  *
  * @example
  * ```ts
- * const debouncer = new AsyncDebouncer(async (value: string) => {
+ * const asyncDebouncer = new AsyncDebouncer(async (value: string) => {
  *   await searchAPI(value);
  * }, { wait: 500 });
  *
  * // Called on each keystroke but only executes after 500ms of no typing
  * inputElement.addEventListener('input', () => {
- *   debouncer.maybeExecute(inputElement.value);
+ *   asyncDebouncer.maybeExecute(inputElement.value);
  * });
  * ```
  */
-export declare class AsyncDebouncer<TFn extends (...args: Array<any>) => Promise<any>, TArgs extends Parameters<TFn>> {
+export declare class AsyncDebouncer<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
     private fn;
-    private abortController;
-    private executionCount;
-    private isExecuting;
-    private lastArgs;
-    private options;
-    private timeoutId;
-    private canLeadingExecute;
-    constructor(fn: TFn, initialOptions: AsyncDebouncerOptions);
+    private _abortController;
+    private _executionCount;
+    private _isExecuting;
+    private _lastArgs;
+    private _options;
+    private _timeoutId;
+    private _canLeadingExecute;
+    constructor(fn: TFn, initialOptions: AsyncDebouncerOptions<TFn, TArgs>);
     /**
      * Updates the debouncer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncDebouncerOptions>): Required<AsyncDebouncerOptions>;
-    /**
-     * Returns the number of times the function has been executed
-     */
-    getExecutionCount(): number;
+    setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn, TArgs>>): Required<AsyncDebouncerOptions<TFn, TArgs>>;
     /**
-     * Cancels any pending execution
+     * Returns the current debouncer options
      */
-    cancel(): void;
+    getOptions(): Required<AsyncDebouncerOptions<TFn, TArgs>>;
     /**
      * Attempts to execute the debounced function
      * If a call is already in progress, it will be queued
      */
     maybeExecute(...args: TArgs): Promise<void>;
     private executeFunction;
+    /**
+     * Cancels any pending execution
+     */
+    cancel(): void;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns `true` if there is a pending execution
+     */
+    getIsPending(): boolean;
 }
 /**
  * Creates an async debounced function that delays execution until after a specified wait time.
@@ -96,4 +109,4 @@ export declare class AsyncDebouncer<TFn extends (...args: Array<any>) => Promise
  * await debounced("third");  // Executes after 1s
  * ```
  */
-export declare function asyncDebounce<TFn extends (...args: Array<any>) => Promise<any>>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions, 'enabled'>): (...args: Parameters<TFn>) => Promise<void>;
+export declare function asyncDebounce<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions<TFn, TArgs>, 'enabled'>): (...args: TArgs) => Promise<void>;