@tanstack/pacer 0.1.0 → 0.3.0

package/dist/cjs/utils.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function bindInstanceMethods(instance) {
+  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance)).filter((key) => typeof instance[key] === "function").reduce((acc, key) => {
+    const method = instance[key];
+    if (typeof method === "function") {
+      acc[key] = method.bind(instance);
+    }
+    return acc;
+  }, {});
+}
+exports.bindInstanceMethods = bindInstanceMethods;
+//# sourceMappingURL=utils.cjs.map

package/dist/cjs/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sources":["../../src/utils.ts"],"sourcesContent":["export function bindInstanceMethods<T extends Record<string, any>>(\n  instance: T,\n): T {\n  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance))\n    .filter((key) => typeof instance[key as keyof T] === 'function')\n    .reduce((acc: any, key) => {\n      const method = instance[key as keyof T]\n      if (typeof method === 'function') {\n        acc[key] = method.bind(instance)\n      }\n      return acc\n    }, {} as T)\n}\n"],"names":[],"mappings":";;AAAO,SAAS,oBACd,UACG;AACH,SAAO,OAAO,oBAAoB,OAAO,eAAe,QAAQ,CAAC,EAC9D,OAAO,CAAC,QAAQ,OAAO,SAAS,GAAc,MAAM,UAAU,EAC9D,OAAO,CAAC,KAAU,QAAQ;AACnB,UAAA,SAAS,SAAS,GAAc;AAClC,QAAA,OAAO,WAAW,YAAY;AAChC,UAAI,GAAG,IAAI,OAAO,KAAK,QAAQ;AAAA,IAAA;AAE1B,WAAA;AAAA,EACT,GAAG,EAAO;AACd;;"}

package/dist/cjs/utils.d.cts

@@ -0,0 +1 @@
+export declare function bindInstanceMethods<T extends Record<string, any>>(instance: T): T;

package/dist/esm/async-debouncer.d.ts

@@ -1,7 +1,8 @@
+import { AnyAsyncFunction } from './types.js';
 /**
  * Options for configuring an async debounced function
  */
-export interface AsyncDebouncerOptions {
+export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -12,6 +13,18 @@ export interface AsyncDebouncerOptions {
      * Defaults to false.
      */
     leading?: boolean;
+    /**
+     * Optional error handler for when the debounced function throws
+     */
+    onError?: (error: unknown, debouncer: AsyncDebouncer<TFn>) => void;
+    /**
+     * Optional callback to call when the debounced function is executed
+     */
+    onSettled?: (debouncer: AsyncDebouncer<TFn>) => void;
+    /**
+     * Optional callback to call when the debounced function is executed
+     */
+    onSuccess?: (result: ReturnType<TFn>, debouncer: AsyncDebouncer<TFn>) => void;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.
@@ -22,10 +35,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 +48,77 @@ 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> {
     private fn;
-    private abortController;
-    private executionCount;
-    private isExecuting;
-    private lastArgs;
-    private options;
-    private timeoutId;
-    private canLeadingExecute;
-    constructor(fn: TFn, initialOptions: AsyncDebouncerOptions);
+    private _abortController;
+    private _canLeadingExecute;
+    private _errorCount;
+    private _isExecuting;
+    private _isPending;
+    private _lastArgs;
+    private _lastResult;
+    private _options;
+    private _settleCount;
+    private _successCount;
+    private _timeoutId;
+    constructor(fn: TFn, initialOptions: AsyncDebouncerOptions<TFn>);
     /**
      * Updates the debouncer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncDebouncerOptions>): Required<AsyncDebouncerOptions>;
+    setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn>>): void;
     /**
-     * Returns the number of times the function has been executed
+     * Returns the current debouncer options
      */
-    getExecutionCount(): number;
-    /**
-     * Cancels any pending execution
-     */
-    cancel(): void;
+    getOptions(): Required<AsyncDebouncerOptions<TFn>>;
     /**
      * Attempts to execute the debounced function
      * If a call is already in progress, it will be queued
      */
-    maybeExecute(...args: TArgs): Promise<void>;
+    maybeExecute(...args: Parameters<TFn>): Promise<ReturnType<TFn> | undefined>;
     private executeFunction;
+    /**
+     * Cancel without resetting _canLeadingExecute
+     */
+    private _cancel;
+    /**
+     * Cancels any pending execution or aborts any execution in progress
+     */
+    cancel(): void;
+    /**
+     * Returns the last result of the debounced function
+     */
+    getLastResult(): ReturnType<TFn> | undefined;
+    /**
+     * Returns the number of times the function has been executed successfully
+     */
+    getSuccessCount(): number;
+    /**
+     * Returns the number of times the function has settled (completed or errored)
+     */
+    getSettleCount(): number;
+    /**
+     * Returns the number of times the function has errored
+     */
+    getErrorCount(): number;
+    /**
+     * Returns `true` if there is a pending execution queued up for trailing execution
+     */
+    getIsPending(): boolean;
+    /**
+     * Returns `true` if there is currently an execution in progress
+     */
+    getIsExecuting(): boolean;
 }
 /**
  * Creates an async debounced function that delays execution until after a specified wait time.
@@ -96,4 +137,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>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;

package/dist/esm/async-debouncer.js

@@ -1,20 +1,27 @@
 const defaultOptions = {
   enabled: true,
   leading: false,
-  trailing: true,
   onError: () => {
   },
+  onSettled: () => {
+  },
+  onSuccess: () => {
+  },
+  trailing: true,
   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._canLeadingExecute = true;
+    this._errorCount = 0;
+    this._isExecuting = false;
+    this._isPending = false;
+    this._settleCount = 0;
+    this._successCount = 0;
+    this._timeoutId = null;
+    this._options = {
       ...defaultOptions,
       ...initialOptions
     };
@@ -24,78 +31,120 @@ class AsyncDebouncer {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this.options = {
-      ...this.options,
-      ...newOptions
-    };
-    return this.options;
+    this._options = { ...this._options, ...newOptions };
+    if (!this._options.enabled) {
+      this._isPending = false;
+    }
   }
   /**
-   * 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
    * If a call is already in progress, it will be queued
    */
   async maybeExecute(...args) {
-    this.cancel();
-    this.lastArgs = args;
-    if (this.options.leading && this.canLeadingExecute) {
-      this.canLeadingExecute = false;
+    this._cancel();
+    this._lastArgs = args;
+    if (this._options.leading && this._canLeadingExecute) {
+      this._canLeadingExecute = false;
       await this.executeFunction(...args);
+      return this._lastResult;
+    }
+    if (this._options.trailing) {
+      this._isPending = true;
     }
     return new Promise((resolve) => {
-      this.timeoutId = setTimeout(async () => {
-        if (this.isExecuting) {
-          resolve();
-          return;
-        }
-        this.canLeadingExecute = true;
-        if (this.options.trailing) {
-          this.abortController = new AbortController();
-          try {
-            this.isExecuting = true;
-            if (this.lastArgs) {
-              await this.executeFunction(...this.lastArgs);
-            }
-          } catch (error) {
-            try {
-              this.options.onError(error);
-            } catch {
-            }
-          } finally {
-            this.isExecuting = false;
-            this.abortController = null;
-            resolve();
-          }
-        } else {
-          resolve();
+      this._timeoutId = setTimeout(async () => {
+        if (this._options.trailing && this._lastArgs) {
+          await this.executeFunction(...this._lastArgs);
         }
-      }, this.options.wait);
+        this._canLeadingExecute = true;
+        resolve(this._lastResult);
+      }, this._options.wait);
     });
   }
   async executeFunction(...args) {
-    if (!this.options.enabled) return;
-    this.executionCount++;
-    await this.fn(...args);
+    if (!this._options.enabled) return void 0;
+    this._abortController = new AbortController();
+    try {
+      this._isExecuting = true;
+      this._lastResult = await this.fn(...args);
+      this._successCount++;
+      this._options.onSuccess(this._lastResult, this);
+    } catch (error) {
+      this._errorCount++;
+      this._options.onError(error, this);
+    } finally {
+      this._isExecuting = false;
+      this._isPending = false;
+      this._settleCount++;
+      this._abortController = null;
+      this._options.onSettled(this);
+    }
+    return this._lastResult;
+  }
+  /**
+   * Cancel without resetting _canLeadingExecute
+   */
+  _cancel() {
+    if (this._timeoutId) {
+      clearTimeout(this._timeoutId);
+      this._timeoutId = null;
+    }
+    if (this._abortController) {
+      this._abortController.abort();
+      this._abortController = null;
+    }
+    this._lastArgs = void 0;
+    this._isPending = false;
+    this._isExecuting = false;
+  }
+  /**
+   * Cancels any pending execution or aborts any execution in progress
+   */
+  cancel() {
+    this._canLeadingExecute = true;
+    this._cancel();
+  }
+  /**
+   * Returns the last result of the debounced function
+   */
+  getLastResult() {
+    return this._lastResult;
+  }
+  /**
+   * Returns the number of times the function has been executed successfully
+   */
+  getSuccessCount() {
+    return this._successCount;
+  }
+  /**
+   * Returns the number of times the function has settled (completed or errored)
+   */
+  getSettleCount() {
+    return this._settleCount;
+  }
+  /**
+   * Returns the number of times the function has errored
+   */
+  getErrorCount() {
+    return this._errorCount;
+  }
+  /**
+   * Returns `true` if there is a pending execution queued up for trailing execution
+   */
+  getIsPending() {
+    return this._options.enabled && this._isPending;
+  }
+  /**
+   * Returns `true` if there is currently an execution in progress
+   */
+  getIsExecuting() {
+    return this._isExecuting;
   }
 }
 function asyncDebounce(fn, initialOptions) {

package/dist/esm/async-debouncer.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-debouncer.js","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.js","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<TFn extends AnyAsyncFunction> {\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, debouncer: AsyncDebouncer<TFn>) => void\n  /**\n   * Optional callback to call when the debounced function is executed\n   */\n  onSettled?: (debouncer: AsyncDebouncer<TFn>) => void\n  /**\n   * Optional callback to call when the debounced function is executed\n   */\n  onSuccess?: (result: ReturnType<TFn>, debouncer: AsyncDebouncer<TFn>) => 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>> = {\n  enabled: true,\n  leading: false,\n  onError: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  trailing: true,\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<TFn extends AnyAsyncFunction> {\n  private _abortController: AbortController | null = null\n  private _canLeadingExecute = true\n  private _errorCount = 0\n  private _isExecuting = false\n  private _isPending = false\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastResult: ReturnType<TFn> | undefined\n  private _options: Required<AsyncDebouncerOptions<TFn>>\n  private _settleCount = 0\n  private _successCount = 0\n  private _timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncDebouncerOptions<TFn>,\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(newOptions: Partial<AsyncDebouncerOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n\n    // End the pending state if the debouncer is disabled\n    if (!this._options.enabled) {\n      this._isPending = false\n    }\n  }\n\n  /**\n   * Returns the current debouncer options\n   */\n  getOptions(): Required<AsyncDebouncerOptions<TFn>> {\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(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\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      return this._lastResult\n    }\n\n    // Handle trailing execution\n    if (this._options.trailing) {\n      this._isPending = true\n    }\n\n    return new Promise((resolve) => {\n      this._timeoutId = setTimeout(async () => {\n        // Execute trailing if enabled\n        if (this._options.trailing && this._lastArgs) {\n          await this.executeFunction(...this._lastArgs)\n        }\n\n        // Reset state and resolve\n        this._canLeadingExecute = true\n        resolve(this._lastResult)\n      }, this._options.wait)\n    })\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this._options.enabled) return undefined\n    this._abortController = new AbortController()\n    try {\n      this._isExecuting = true\n      this._lastResult = await this.fn(...args) // EXECUTE!\n      this._successCount++\n      this._options.onSuccess(this._lastResult!, this)\n    } catch (error) {\n      this._errorCount++\n      this._options.onError(error, this)\n    } finally {\n      this._isExecuting = false\n      this._isPending = false\n      this._settleCount++\n      this._abortController = null\n      this._options.onSettled(this)\n    }\n    return this._lastResult\n  }\n\n  /**\n   * Cancel without resetting _canLeadingExecute\n   */\n  private _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._isPending = false\n    this._isExecuting = false\n  }\n\n  /**\n   * Cancels any pending execution or aborts any execution in progress\n   */\n  cancel(): void {\n    this._canLeadingExecute = true\n    this._cancel()\n  }\n\n  /**\n   * Returns the last result of the debounced function\n   */\n  getLastResult(): ReturnType<TFn> | undefined {\n    return this._lastResult\n  }\n\n  /**\n   * Returns the number of times the function has been executed successfully\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has settled (completed or errored)\n   */\n  getSettleCount(): number {\n    return this._settleCount\n  }\n\n  /**\n   * Returns the number of times the function has errored\n   */\n  getErrorCount(): number {\n    return this._errorCount\n  }\n\n  /**\n   * Returns `true` if there is a pending execution queued up for trailing execution\n   */\n  getIsPending(): boolean {\n    return this._options.enabled && this._isPending\n  }\n\n  /**\n   * Returns `true` if there is currently an execution in progress\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\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<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: Omit<AsyncDebouncerOptions<TFn>, 'enabled'>,\n) {\n  const asyncDebouncer = new AsyncDebouncer(fn, initialOptions)\n  return asyncDebouncer.maybeExecute.bind(asyncDebouncer)\n}\n"],"names":[],"mappings":"AAwCA,MAAM,iBAAuD;AAAA,EAC3D,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AAwBO,MAAM,eAA6C;AAAA,EAaxD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAbV,SAAQ,mBAA2C;AACnD,SAAQ,qBAAqB;AAC7B,SAAQ,cAAc;AACtB,SAAQ,eAAe;AACvB,SAAQ,aAAa;AAIrB,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,aAAoC;AAM1C,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAuD;AAChE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,aAAa;AAAA,IAAA;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA,EAMF,aAAmD;AACjD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,MAAM,gBACD,MACmC;AACtC,SAAK,QAAQ;AACb,SAAK,YAAY;AAGjB,QAAI,KAAK,SAAS,WAAW,KAAK,oBAAoB;AACpD,WAAK,qBAAqB;AACpB,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,aAAO,KAAK;AAAA,IAAA;AAIV,QAAA,KAAK,SAAS,UAAU;AAC1B,WAAK,aAAa;AAAA,IAAA;AAGb,WAAA,IAAI,QAAQ,CAAC,YAAY;AACzB,WAAA,aAAa,WAAW,YAAY;AAEvC,YAAI,KAAK,SAAS,YAAY,KAAK,WAAW;AAC5C,gBAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,QAAA;AAI9C,aAAK,qBAAqB;AAC1B,gBAAQ,KAAK,WAAW;AAAA,MAAA,GACvB,KAAK,SAAS,IAAI;AAAA,IAAA,CACtB;AAAA,EAAA;AAAA,EAGH,MAAc,mBACT,MACmC;AACtC,QAAI,CAAC,KAAK,SAAS,QAAgB,QAAA;AAC9B,SAAA,mBAAmB,IAAI,gBAAgB;AACxC,QAAA;AACF,WAAK,eAAe;AACpB,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,WAAK,SAAS,UAAU,KAAK,aAAc,IAAI;AAAA,aACxC,OAAO;AACT,WAAA;AACA,WAAA,SAAS,QAAQ,OAAO,IAAI;AAAA,IAAA,UACjC;AACA,WAAK,eAAe;AACpB,WAAK,aAAa;AACb,WAAA;AACL,WAAK,mBAAmB;AACnB,WAAA,SAAS,UAAU,IAAI;AAAA,IAAA;AAE9B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMN,UAAgB;AACtB,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,aAAa;AAClB,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtB,SAAe;AACb,SAAK,qBAAqB;AAC1B,SAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMf,gBAA6C;AAC3C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,kBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAAyB;AACvB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACf,WAAA,KAAK,SAAS,WAAW,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAEhB;AAmBgB,SAAA,cACd,IACA,gBACA;AACA,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;"}

package/dist/esm/async-queuer.d.ts

@@ -9,6 +9,16 @@ export interface AsyncQueuerOptions<TValue> {
      * Maximum number of concurrent tasks to process
      */
     concurrency?: number;
+    /**
+     * Maximum time in milliseconds that an item can stay in the queue
+     * If not provided, items will never expire
+     */
+    expirationDuration?: number;
+    /**
+     * Function to determine if an item has expired
+     * If provided, this overrides the expirationDuration behavior
+     */
+    getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean;
     /**
      * Default position to get items from during processing
      * @default 'front'
@@ -34,12 +44,24 @@ export interface AsyncQueuerOptions<TValue> {
      * Callback fired whenever an item is removed from the queuer
      */
     onGetNextItem?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Callback fired whenever the queuer's running state changes
+     */
+    onIsRunningChange?: (queuer: AsyncQueuer<TValue>) => void;
     /**
      * Callback fired whenever an item is added or removed from the queuer
      */
-    onUpdate?: (queuer: AsyncQueuer<TValue>) => void;
+    onItemsChange?: (queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Callback fired whenever an item is rejected from being added to the queuer
+     */
+    onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
     /**
-     * Whether the queuer should start processing tasks immediately
+     * Callback fired whenever an item expires in the queuer
+     */
+    onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Whether the queuer should start processing tasks immediately or not.
      */
     started?: boolean;
     /**
@@ -48,54 +70,82 @@ export interface AsyncQueuerOptions<TValue> {
     wait?: number;
 }
 /**
- * A flexible asynchronous queuer that processes tasks with configurable concurrency control.
+ * A flexible asynchronous queue that processes tasks with configurable concurrency control.
  *
  * Features:
- * - Priority queuer support via getPriority option
+ * - Priority queue support via getPriority option
  * - Configurable concurrency limit
  * - Task success/error/completion callbacks
- * - FIFO (First In First Out) or LIFO (Last In First Out) queuer behavior
+ * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
  * - Pause/resume task processing
  * - Task cancellation
+ * - Item expiration to clear stale items from the queue
  *
  * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,
  * the next pending task is processed if below the concurrency limit.
  *
  * @example
  * ```ts
- * const queuer = new AsyncQueuer<string>({ concurrency: 2 });
+ * const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });
  *
- * queuer.addItem(async () => {
+ * asyncQueuer.addItem(async () => {
  *   return 'Hello';
  * });
  *
- * queuer.start();
+ * asyncQueuer.start();
  *
- * queuer.onSuccess((result) => {
+ * asyncQueuer.onSuccess((result) => {
  *   console.log(result); // 'Hello'
  * });
  * ```
  */
 export declare class AsyncQueuer<TValue> {
-    protected options: Required<AsyncQueuerOptions<TValue>>;
-    private items;
-    private activeItems;
-    private onSuccessCallbacks;
-    private onErrorCallbacks;
-    private onSettledCallbacks;
-    private running;
-    private pendingTick;
-    private executionCount;
+    private _options;
+    private _activeItems;
+    private _executionCount;
+    private _rejectionCount;
+    private _expirationCount;
+    private _items;
+    private _itemTimestamps;
+    private _onErrorCallbacks;
+    private _onSettledCallbacks;
+    private _onSuccessCallbacks;
+    private _pendingTick;
+    private _running;
     constructor(initialOptions?: AsyncQueuerOptions<TValue>);
     /**
      * Updates the queuer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): AsyncQueuerOptions<TValue>;
+    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): void;
+    /**
+     * Returns the current queuer options
+     */
+    getOptions(): Required<AsyncQueuerOptions<TValue>>;
     /**
      * Processes items in the queuer
      */
-    protected tick(): void;
+    private tick;
+    /**
+     * Checks for and removes expired items from the queuer
+     */
+    private checkExpiredItems;
+    /**
+     * Starts the queuer and processes items
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the queuer from processing items
+     */
+    stop(): void;
+    /**
+     * Removes all items from the queuer
+     */
+    clear(): void;
+    /**
+     * Resets the queuer to its initial state
+     */
+    reset(withInitialItems?: boolean): void;
     /**
      * Adds a task to the queuer
      */
@@ -109,43 +159,47 @@ export declare class AsyncQueuer<TValue> {
     /**
      * Returns an item without removing it
      */
-    peek(position?: QueuePosition): (() => Promise<TValue>) | undefined;
+    getPeek(position?: QueuePosition): (() => Promise<TValue>) | undefined;
     /**
      * Returns true if the queuer is empty
      */
-    isEmpty(): boolean;
+    getIsEmpty(): boolean;
     /**
      * Returns true if the queuer is full
      */
-    isFull(): boolean;
+    getIsFull(): boolean;
     /**
      * Returns the current size of the queuer
      */
-    size(): number;
+    getSize(): number;
     /**
-     * Removes all items from the queuer
+     * Returns a copy of all items in the queuer
      */
-    clear(): void;
+    getAllItems(): Array<() => Promise<TValue>>;
     /**
-     * Resets the queuer to its initial state
+     * Returns the active items
      */
-    reset(withInitialItems?: boolean): void;
+    getActiveItems(): Array<() => Promise<TValue>>;
     /**
-     * Returns a copy of all items in the queuer
+     * Returns the pending items
      */
-    getAllItems(): Array<() => Promise<TValue>>;
+    getPendingItems(): Array<() => Promise<TValue>>;
     /**
      * Returns the number of items that have been removed from the queuer
      */
     getExecutionCount(): number;
     /**
-     * Returns the active items
+     * Returns the number of items that have been rejected from the queuer
      */
-    getActiveItems(): Array<() => Promise<TValue>>;
+    getRejectionCount(): number;
     /**
-     * Returns the pending items
+     * Returns true if the queuer is running
      */
-    getPendingItems(): Array<() => Promise<TValue>>;
+    getIsRunning(): boolean;
+    /**
+     * Returns true if the queuer is running but has no items to process
+     */
+    getIsIdle(): boolean;
     /**
      * Adds a callback to be called when a task succeeds
      */
@@ -159,21 +213,9 @@ export declare class AsyncQueuer<TValue> {
      */
     onSettled(cb: (result: TValue | Error) => void): () => void;
     /**
-     * Starts the queuer and processes items
-     */
-    start(): Promise<void>;
-    /**
-     * Stops the queuer from processing items
-     */
-    stop(): void;
-    /**
-     * Returns true if the queuer is running
-     */
-    isRunning(): boolean;
-    /**
-     * Returns true if the queuer is running but has no items to process
+     * Returns the number of items that have expired from the queuer
      */
-    isIdle(): boolean;
+    getExpirationCount(): number;
 }
 /**
  * Creates a new AsyncQueuer instance with the given options and returns a bound addItem function.
@@ -192,6 +234,6 @@ export declare class AsyncQueuer<TValue> {
  * @param options - Configuration options for the AsyncQueuer
  * @returns A bound addItem function that can be used to add tasks to the queuer
  */
-export declare function asyncQueue<TValue>(options?: AsyncQueuerOptions<TValue>): (fn: (() => Promise<TValue>) & {
+export declare function asyncQueue<TValue>(options?: Omit<AsyncQueuerOptions<TValue>, 'started'>): (fn: (() => Promise<TValue>) & {
     priority?: number;
 }, position?: QueuePosition, runOnUpdate?: boolean) => Promise<TValue>;