@tanstack/pacer 0.1.0 → 0.2.0

package/dist/esm/async-rate-limiter.js

@@ -1,11 +1,20 @@
+const defaultOptions = {
+  enabled: true,
+  onReject: () => {
+  },
+  onError: () => {
+  },
+  onExecute: () => {
+  }
+};
 class AsyncRateLimiter {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this.executionCount = 0;
-    this.rejectionCount = 0;
-    this.executionTimes = [];
-    this.options = {
-      enabled: true,
+    this._executionCount = 0;
+    this._executionTimes = [];
+    this._rejectionCount = 0;
+    this._options = {
+      ...defaultOptions,
       ...initialOptions
     };
   }
@@ -14,30 +23,17 @@ class AsyncRateLimiter {
    * 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 rate limiter options
    */
-  getExecutionCount() {
-    return this.executionCount;
-  }
-  /**
-   * Returns the number of times the function has been rejected
-   */
-  getRejectionCount() {
-    return this.rejectionCount;
-  }
-  /**
-   * Returns the number of remaining executions allowed in the current window
-   */
-  getRemainingInWindow() {
-    this.cleanupOldExecutions();
-    return Math.max(0, this.options.limit - this.executionTimes.length);
+  getOptions() {
+    return this._options;
   }
   /**
    * Attempts to execute the rate-limited function if within the configured limits.
@@ -57,7 +53,7 @@ class AsyncRateLimiter {
    */
   async maybeExecute(...args) {
     this.cleanupOldExecutions();
-    if (this.executionTimes.length < this.options.limit) {
+    if (this._executionTimes.length < this._options.limit) {
       await this.executeFunction(...args);
       return true;
     }
@@ -65,50 +61,71 @@ class AsyncRateLimiter {
     return false;
   }
   async executeFunction(...args) {
-    if (!this.options.enabled) return;
+    var _a, _b;
+    if (!this._options.enabled) return;
     const now = Date.now();
-    this.executionCount++;
-    this.executionTimes.push(now);
+    this._executionCount++;
+    this._executionTimes.push(now);
     try {
       await this.fn(...args);
     } catch (error) {
-      if (this.options.onError) {
+      if (this._options.onError) {
         try {
-          this.options.onError(error);
-        } catch {
+          this._options.onError(error);
+        } catch (error2) {
+          console.error("Error in onError handler", error2);
         }
       }
       throw error;
     } finally {
+      (_b = (_a = this._options).onExecute) == null ? void 0 : _b.call(_a, this);
     }
   }
   rejectFunction() {
-    this.rejectionCount++;
-    if (this.options.onReject) {
-      const oldestExecution = Math.min(...this.executionTimes);
-      const msUntilNextWindow = oldestExecution + this.options.window - Date.now();
-      this.options.onReject({
-        msUntilNextWindow,
-        currentExecutions: this.executionTimes.length,
-        limit: this.options.limit,
-        rejectionCount: this.rejectionCount
-      });
+    this._rejectionCount++;
+    if (this._options.onReject) {
+      this._options.onReject(this);
     }
   }
   cleanupOldExecutions() {
     const now = Date.now();
-    const windowStart = now - this.options.window;
-    this.executionTimes = this.executionTimes.filter(
+    const windowStart = now - this._options.window;
+    this._executionTimes = this._executionTimes.filter(
       (time) => time > windowStart
     );
   }
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getExecutionCount() {
+    return this._executionCount;
+  }
+  /**
+   * Returns the number of times the function has been rejected
+   */
+  getRejectionCount() {
+    return this._rejectionCount;
+  }
+  /**
+   * Returns the number of remaining executions allowed in the current window
+   */
+  getRemainingInWindow() {
+    this.cleanupOldExecutions();
+    return Math.max(0, this._options.limit - this._executionTimes.length);
+  }
+  /**
+   * Returns the number of milliseconds until the next execution will be possible
+   */
+  getMsUntilNextWindow() {
+    return this.getRemainingInWindow() * this._options.window;
+  }
   /**
    * Resets the rate limiter state
    */
   reset() {
-    this.executionTimes = [];
-    this.executionCount = 0;
-    this.rejectionCount = 0;
+    this._executionTimes = [];
+    this._executionCount = 0;
+    this._rejectionCount = 0;
   }
 }
 function asyncRateLimit(fn, initialOptions) {

package/dist/esm/async-rate-limiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-rate-limiter.js","sources":["../../src/async-rate-limiter.ts"],"sourcesContent":["import type { RateLimitRejectionInfo } from './rate-limiter'\n\n/**\n * Options for configuring an async rate-limited function\n */\nexport interface AsyncRateLimiterOptions {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Maximum number of executions allowed within the time window\n   */\n  limit: number\n  /**\n   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (info: RateLimitRejectionInfo) => void\n  /**\n   * Optional error handler for when the rate-limited function throws\n   */\n  onError?: (error: unknown) => void\n}\n\n/**\n * A class that creates an async rate-limited function.\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Will execute immediately until limit reached, then block\n * await rateLimiter.maybeExecute('123');\n * ```\n */\nexport class AsyncRateLimiter<\n  TFn extends (...args: Array<any>) => Promise<any>,\n  TArgs extends Parameters<TFn>,\n> {\n  private executionCount = 0\n  private rejectionCount = 0\n  private executionTimes: Array<number> = []\n  private options: AsyncRateLimiterOptions\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions,\n  ) {\n    this.options = {\n      enabled: true,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncRateLimiterOptions>,\n  ): AsyncRateLimiterOptions {\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   * Returns the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this.rejectionCount\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow(): number {\n    this.cleanupOldExecutions()\n    return Math.max(0, this.options.limit - this.executionTimes.length)\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   * If execution is allowed, waits for any previous execution to complete before proceeding.\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will execute\n   * await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will be rejected\n   * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected\n   * ```\n   */\n  async maybeExecute(...args: TArgs): Promise<boolean> {\n    this.cleanupOldExecutions()\n\n    if (this.executionTimes.length < this.options.limit) {\n      await this.executeFunction(...args)\n      return true\n    }\n\n    this.rejectFunction()\n    return false\n  }\n\n  private async executeFunction(...args: TArgs): Promise<void> {\n    if (!this.options.enabled) return\n    const now = Date.now()\n    this.executionCount++\n    this.executionTimes.push(now)\n\n    try {\n      await this.fn(...args)\n    } catch (error) {\n      if (this.options.onError) {\n        try {\n          this.options.onError(error)\n        } catch {\n          // Ignore errors from error handler\n        }\n      }\n      throw error\n    } finally {\n    }\n  }\n\n  private rejectFunction(): void {\n    this.rejectionCount++\n    if (this.options.onReject) {\n      const oldestExecution = Math.min(...this.executionTimes)\n      const msUntilNextWindow =\n        oldestExecution + this.options.window - Date.now()\n\n      this.options.onReject({\n        msUntilNextWindow,\n        currentExecutions: this.executionTimes.length,\n        limit: this.options.limit,\n        rejectionCount: this.rejectionCount,\n      })\n    }\n  }\n\n  private cleanupOldExecutions(): void {\n    const now = Date.now()\n    const windowStart = now - this.options.window\n    this.executionTimes = this.executionTimes.filter(\n      (time) => time > windowStart,\n    )\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this.executionTimes = []\n    this.executionCount = 0\n    this.rejectionCount = 0\n  }\n}\n\n/**\n * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   onReject: ({ msUntilNextWindow }) => {\n *     console.log(`Rate limit exceeded. Try again in ${msUntilNextWindow}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * await rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function asyncRateLimit<\n  TFn extends (...args: Array<any>) => Promise<any>,\n>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions, 'enabled'>) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":"AAsDO,MAAM,iBAGX;AAAA,EAMA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,iBAAiB;AACzB,SAAQ,iBAAiB;AACzB,SAAQ,iBAAgC,CAAC;AAOvC,SAAK,UAAU;AAAA,MACb,SAAS;AAAA,MACT,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACyB;AACzB,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,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,QAAQ,QAAQ,KAAK,eAAe,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBpE,MAAM,gBAAgB,MAA+B;AACnD,SAAK,qBAAqB;AAE1B,QAAI,KAAK,eAAe,SAAS,KAAK,QAAQ,OAAO;AAC7C,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAC3B,aAAA;AAAA,IAAA;AAGT,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBAAmB,MAA4B;AACvD,QAAA,CAAC,KAAK,QAAQ,QAAS;AACrB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,eAAe,KAAK,GAAG;AAExB,QAAA;AACI,YAAA,KAAK,GAAG,GAAG,IAAI;AAAA,aACd,OAAO;AACV,UAAA,KAAK,QAAQ,SAAS;AACpB,YAAA;AACG,eAAA,QAAQ,QAAQ,KAAK;AAAA,QAAA,QACpB;AAAA,QAAA;AAAA,MAER;AAEI,YAAA;AAAA,IAAA,UACN;AAAA,IAAA;AAAA,EACF;AAAA,EAGM,iBAAuB;AACxB,SAAA;AACD,QAAA,KAAK,QAAQ,UAAU;AACzB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,cAAc;AACvD,YAAM,oBACJ,kBAAkB,KAAK,QAAQ,SAAS,KAAK,IAAI;AAEnD,WAAK,QAAQ,SAAS;AAAA,QACpB;AAAA,QACA,mBAAmB,KAAK,eAAe;AAAA,QACvC,OAAO,KAAK,QAAQ;AAAA,QACpB,gBAAgB,KAAK;AAAA,MAAA,CACtB;AAAA,IAAA;AAAA,EACH;AAAA,EAGM,uBAA6B;AAC7B,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,cAAc,MAAM,KAAK,QAAQ;AAClC,SAAA,iBAAiB,KAAK,eAAe;AAAA,MACxC,CAAC,SAAS,OAAO;AAAA,IACnB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,QAAc;AACZ,SAAK,iBAAiB,CAAC;AACvB,SAAK,iBAAiB;AACtB,SAAK,iBAAiB;AAAA,EAAA;AAE1B;AAgCgB,SAAA,eAEd,IAAS,gBAA0D;AACnE,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AACpD,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}
+{"version":3,"file":"async-rate-limiter.js","sources":["../../src/async-rate-limiter.ts"],"sourcesContent":["import type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async rate-limited function\n */\nexport interface AsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Maximum number of executions allowed within the time window\n   */\n  limit: number\n  /**\n   * Optional error handler for when the rate-limited function throws\n   */\n  onError?: (error: unknown) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onExecute?: (rateLimiter: AsyncRateLimiter<TFn, TArgs>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: AsyncRateLimiter<TFn, TArgs>) => void\n  /**\n   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n}\n\nconst defaultOptions: Required<\n  Omit<AsyncRateLimiterOptions<any, any>, 'limit' | 'window'>\n> = {\n  enabled: true,\n  onReject: () => {},\n  onError: () => {},\n  onExecute: () => {},\n}\n\n/**\n * A class that creates an async rate-limited function.\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Will execute immediately until limit reached, then block\n * await rateLimiter.maybeExecute('123');\n * ```\n */\nexport class AsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  private _executionCount = 0\n  private _executionTimes: Array<number> = []\n  private _options: AsyncRateLimiterOptions<TFn, TArgs>\n  private _rejectionCount = 0\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn, TArgs>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncRateLimiterOptions<TFn, TArgs>>,\n  ): AsyncRateLimiterOptions<TFn, TArgs> {\n    this._options = {\n      ...this._options,\n      ...newOptions,\n    }\n    return this._options\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<AsyncRateLimiterOptions<TFn, TArgs>> {\n    return this._options as Required<AsyncRateLimiterOptions<TFn, TArgs>>\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   * If execution is allowed, waits for any previous execution to complete before proceeding.\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will execute\n   * await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will be rejected\n   * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected\n   * ```\n   */\n  async maybeExecute(...args: TArgs): Promise<boolean> {\n    this.cleanupOldExecutions()\n\n    if (this._executionTimes.length < this._options.limit) {\n      await this.executeFunction(...args)\n      return true\n    }\n\n    this.rejectFunction()\n    return false\n  }\n\n  private async executeFunction(...args: TArgs): Promise<void> {\n    if (!this._options.enabled) return\n    const now = Date.now()\n    this._executionCount++\n    this._executionTimes.push(now)\n\n    try {\n      await this.fn(...args)\n    } catch (error) {\n      if (this._options.onError) {\n        try {\n          this._options.onError(error)\n        } catch (error) {\n          console.error('Error in onError handler', error)\n        }\n      }\n      throw error\n    } finally {\n      this._options.onExecute?.(this)\n    }\n  }\n\n  private rejectFunction(): void {\n    this._rejectionCount++\n    if (this._options.onReject) {\n      this._options.onReject(this)\n    }\n  }\n\n  private cleanupOldExecutions(): void {\n    const now = Date.now()\n    const windowStart = now - this._options.window\n    this._executionTimes = this._executionTimes.filter(\n      (time) => time > windowStart,\n    )\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 the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow(): number {\n    this.cleanupOldExecutions()\n    return Math.max(0, this._options.limit - this._executionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   */\n  getMsUntilNextWindow(): number {\n    return this.getRemainingInWindow() * this._options.window\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._executionCount = 0\n    this._rejectionCount = 0\n  }\n}\n\n/**\n * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * await rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function asyncRateLimit<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n>(\n  fn: TFn,\n  initialOptions: Omit<AsyncRateLimiterOptions<TFn, TArgs>, 'enabled'>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":["error"],"mappings":"AAoCA,MAAM,iBAEF;AAAA,EACF,SAAS;AAAA,EACT,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAA;AACnB;AA2BO,MAAM,iBAGX;AAAA,EAMA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiC,CAAC;AAE1C,SAAQ,kBAAkB;AAMxB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACqC;AACrC,SAAK,WAAW;AAAA,MACd,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAA4D;AAC1D,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBd,MAAM,gBAAgB,MAA+B;AACnD,SAAK,qBAAqB;AAE1B,QAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC/C,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAC3B,aAAA;AAAA,IAAA;AAGT,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBAAmB,MAA4B;AAtG/D;AAuGQ,QAAA,CAAC,KAAK,SAAS,QAAS;AACtB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,gBAAgB,KAAK,GAAG;AAEzB,QAAA;AACI,YAAA,KAAK,GAAG,GAAG,IAAI;AAAA,aACd,OAAO;AACV,UAAA,KAAK,SAAS,SAAS;AACrB,YAAA;AACG,eAAA,SAAS,QAAQ,KAAK;AAAA,iBACpBA,QAAO;AACN,kBAAA,MAAM,4BAA4BA,MAAK;AAAA,QAAA;AAAA,MACjD;AAEI,YAAA;AAAA,IAAA,UACN;AACK,uBAAA,UAAS,cAAT,4BAAqB;AAAA,IAAI;AAAA,EAChC;AAAA,EAGM,iBAAuB;AACxB,SAAA;AACD,QAAA,KAAK,SAAS,UAAU;AACrB,WAAA,SAAS,SAAS,IAAI;AAAA,IAAA;AAAA,EAC7B;AAAA,EAGM,uBAA6B;AAC7B,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,cAAc,MAAM,KAAK,SAAS;AACnC,SAAA,kBAAkB,KAAK,gBAAgB;AAAA,MAC1C,CAAC,SAAS,OAAO;AAAA,IACnB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,SAAS,QAAQ,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtE,uBAA+B;AAC7B,WAAO,KAAK,qBAAA,IAAyB,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrD,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,kBAAkB;AACvB,SAAK,kBAAkB;AAAA,EAAA;AAE3B;AAgCgB,SAAA,eAId,IACA,gBACA;AACA,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AACpD,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}

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

@@ -1,21 +1,26 @@
+import { AnyAsyncFunction } from './types.js';
 /**
  * Options for configuring an async throttled function
  */
-export interface AsyncThrottlerOptions {
+export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
     /**
      * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
      */
     enabled?: boolean;
+    /**
+     * Optional error handler for when the throttled function throws
+     */
+    onError?: (error: unknown) => void;
+    /**
+     * Optional function to call when the throttled function is executed
+     */
+    onExecute?: (throttler: AsyncThrottler<TFn, TArgs>) => void;
     /**
      * Time window in milliseconds during which the function can only be executed once
      * Defaults to 0ms
      */
     wait: number;
-    /**
-     * Optional error handler for when the throttled function throws
-     */
-    onError?: (error: unknown) => void;
 }
 /**
  * A class that creates an async throttled function.
@@ -39,40 +44,53 @@ export interface AsyncThrottlerOptions {
  * });
  * ```
  */
-export declare class AsyncThrottler<TFn extends (...args: Array<any>) => Promise<any>, TArgs extends Parameters<TFn>> {
+export declare class AsyncThrottler<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
     private fn;
-    private abortController;
-    private executionCount;
-    private isExecuting;
-    private isScheduled;
-    private lastArgs;
-    private nextExecutionTime;
-    private options;
-    constructor(fn: TFn, initialOptions: AsyncThrottlerOptions);
+    private _options;
+    private _abortController;
+    private _executionCount;
+    private _isExecuting;
+    private _isPending;
+    private _lastArgs;
+    private _lastExecutionTime;
+    private _nextExecutionTime;
+    constructor(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn, TArgs>);
     /**
      * Updates the throttler options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncThrottlerOptions>): Required<AsyncThrottlerOptions>;
+    setOptions(newOptions: Partial<AsyncThrottlerOptions<TFn, TArgs>>): Required<AsyncThrottlerOptions<TFn, TArgs>>;
     /**
-     * Returns the number of times the function has been executed
+     * Returns the current options
      */
-    getExecutionCount(): number;
+    getOptions(): Required<AsyncThrottlerOptions<TFn, TArgs>>;
     /**
-     * Returns the next execution time
+     * Attempts to execute the throttled function
+     * If a call is already in progress, it may be blocked or queued depending on the `wait` option
      */
-    getNextExecutionTime(): number;
+    maybeExecute(...args: TArgs): Promise<void>;
+    private delay;
+    private executeFunction;
     /**
      * Cancels any pending execution
      */
     cancel(): void;
     /**
-     * Attempts to execute the throttled function
-     * If a call is already in progress, it may be blocked or queued depending on the `wait` option
+     * Returns the number of times the function has been executed
      */
-    maybeExecute(...args: TArgs): Promise<void>;
-    private delay;
-    private executeFunction;
+    getExecutionCount(): number;
+    /**
+     * Returns the last execution time
+     */
+    getLastExecutionTime(): number;
+    /**
+     * Returns the next execution time
+     */
+    getNextExecutionTime(): number;
+    /**
+     * Returns the current pending state
+     */
+    getIsPending(): boolean;
 }
 /**
  * Creates an async throttled function that limits how often the function can execute.
@@ -90,4 +108,4 @@ export declare class AsyncThrottler<TFn extends (...args: Array<any>) => Promise
  * await throttled(); // Waits 1 second before executing
  * ```
  */
-export declare function asyncThrottle<TFn extends (...args: Array<any>) => Promise<any>>(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions, 'enabled'>): (...args: Parameters<TFn>) => Promise<void>;
+export declare function asyncThrottle<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions<TFn, TArgs>, 'enabled'>): (...args: TArgs) => Promise<void>;

package/dist/esm/async-throttler.js

@@ -2,17 +2,20 @@ const defaultOptions = {
   enabled: true,
   onError: () => {
   },
+  onExecute: () => {
+  },
   wait: 0
 };
 class AsyncThrottler {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this.abortController = null;
-    this.executionCount = 0;
-    this.isExecuting = false;
-    this.isScheduled = false;
-    this.nextExecutionTime = 0;
-    this.options = {
+    this._abortController = null;
+    this._executionCount = 0;
+    this._isExecuting = false;
+    this._isPending = false;
+    this._lastExecutionTime = 0;
+    this._nextExecutionTime = 0;
+    this._options = {
       ...defaultOptions,
       ...initialOptions
     };
@@ -22,67 +25,51 @@ class AsyncThrottler {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this.options = {
-      ...this.options,
+    this._options = {
+      ...this._options,
       ...newOptions
     };
-    return this.options;
-  }
-  /**
-   * Returns the number of times the function has been executed
-   */
-  getExecutionCount() {
-    return this.executionCount;
-  }
-  /**
-   * Returns the next execution time
-   */
-  getNextExecutionTime() {
-    return this.nextExecutionTime;
+    return this._options;
   }
   /**
-   * Cancels any pending execution
+   * Returns the current options
    */
-  cancel() {
-    if (this.abortController) {
-      this.abortController.abort();
-      this.abortController = null;
-    }
-    this.isScheduled = false;
-    this.lastArgs = void 0;
+  getOptions() {
+    return this._options;
   }
   /**
    * Attempts to execute the throttled function
    * If a call is already in progress, it may be blocked or queued depending on the `wait` option
    */
   async maybeExecute(...args) {
-    this.lastArgs = args;
-    if (this.isScheduled) return;
-    this.isScheduled = true;
-    this.abortController = new AbortController();
-    const signal = this.abortController.signal;
+    this._lastArgs = args;
+    if (this._isPending) return;
+    this._isPending = true;
+    this._abortController = new AbortController();
+    const signal = this._abortController.signal;
     try {
-      while (this.isExecuting) {
-        await this.delay(this.options.wait, signal);
+      while (this._isExecuting) {
+        await this.delay(this._options.wait, signal);
       }
-      while (Date.now() < this.nextExecutionTime) {
-        await this.delay(this.nextExecutionTime - Date.now(), signal);
+      while (Date.now() < this._nextExecutionTime) {
+        await this.delay(this._nextExecutionTime - Date.now(), signal);
       }
-      this.isScheduled = false;
-      this.isExecuting = true;
-      await this.executeFunction(...this.lastArgs);
+      this._isPending = false;
+      this._isExecuting = true;
+      await this.executeFunction(...this._lastArgs);
     } catch (error) {
       if (error instanceof Error && error.name === "AbortError") {
         return;
       }
       try {
-        this.options.onError(error);
+        this._options.onError(error);
       } catch {
       }
     } finally {
-      this.nextExecutionTime = Date.now() + this.options.wait;
-      this.isExecuting = false;
-      this.abortController = null;
+      this._lastExecutionTime = Date.now();
+      this._nextExecutionTime = this._lastExecutionTime + this._options.wait;
+      this._isExecuting = false;
+      this._abortController = null;
     }
   }
   delay(ms, signal) {
@@ -99,9 +86,45 @@ class AsyncThrottler {
     });
   }
   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._abortController) {
+      this._abortController.abort();
+      this._abortController = null;
+    }
+    this._isPending = false;
+    this._lastArgs = void 0;
+  }
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getExecutionCount() {
+    return this._executionCount;
+  }
+  /**
+   * Returns the last execution time
+   */
+  getLastExecutionTime() {
+    return this._lastExecutionTime;
+  }
+  /**
+   * Returns the next execution time
+   */
+  getNextExecutionTime() {
+    return this._nextExecutionTime;
+  }
+  /**
+   * Returns the current pending state
+   */
+  getIsPending() {
+    return this._isPending;
   }
 }
 function asyncThrottle(fn, initialOptions) {

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

@@ -1 +1 @@
-{"version":3,"file":"async-throttler.js","sources":["../../src/async-throttler.ts"],"sourcesContent":["/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions {\n  /**\n   * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once\n   * Defaults to 0ms\n   */\n  wait: number\n  /**\n   * Optional error handler for when the throttled function throws\n   */\n  onError?: (error: unknown) => void\n}\n\nconst defaultOptions: Required<AsyncThrottlerOptions> = {\n  enabled: true,\n  onError: () => {},\n  wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n *   await saveToAPI(value);\n * }, { wait: 1000 });\n *\n * // Will only execute once per second no matter how often called\n * inputElement.addEventListener('input', () => {\n *   throttler.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class AsyncThrottler<\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 isScheduled = false\n  private lastArgs: TArgs | undefined\n  private nextExecutionTime = 0\n  private options: Required<AsyncThrottlerOptions>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncThrottlerOptions,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncThrottlerOptions>,\n  ): Required<AsyncThrottlerOptions> {\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   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this.nextExecutionTime\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this.abortController) {\n      this.abortController.abort()\n      this.abortController = null\n    }\n    this.isScheduled = false\n    this.lastArgs = undefined\n  }\n\n  /**\n   * Attempts to execute the throttled function\n   * If a call is already in progress, it may be blocked or queued depending on the `wait` option\n   */\n  async maybeExecute(...args: TArgs): Promise<void> {\n    this.lastArgs = args\n    if (this.isScheduled) return\n    this.isScheduled = true\n\n    this.abortController = new AbortController()\n    const signal = this.abortController.signal\n\n    try {\n      while (this.isExecuting) {\n        await this.delay(this.options.wait, signal)\n      }\n\n      while (Date.now() < this.nextExecutionTime) {\n        await this.delay(this.nextExecutionTime - Date.now(), signal)\n      }\n\n      this.isScheduled = false\n      this.isExecuting = true\n\n      await this.executeFunction(...this.lastArgs)\n    } catch (error) {\n      if (error instanceof Error && error.name === 'AbortError') {\n        return // Silent return on cancellation\n      }\n      try {\n        this.options.onError(error)\n      } catch {\n        // Ignore errors from error handler\n      }\n    } finally {\n      this.nextExecutionTime = Date.now() + this.options.wait\n      this.isExecuting = false\n      this.abortController = null\n    }\n  }\n\n  private delay(ms: number, signal: AbortSignal): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const timeout = setTimeout(resolve, ms)\n      signal.addEventListener(\n        'abort',\n        () => {\n          clearTimeout(timeout)\n          reject(new Error('AbortError'))\n        },\n        { once: true },\n      )\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 throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * @example\n * ```ts\n * const throttled = asyncThrottle(async () => {\n *   await someAsyncOperation();\n * }, { wait: 1000 });\n *\n * // This will execute at most once per second\n * await throttled();\n * await throttled(); // Waits 1 second before executing\n * ```\n */\nexport function asyncThrottle<\n  TFn extends (...args: Array<any>) => Promise<any>,\n>(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions, 'enabled'>) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute.bind(asyncThrottler)\n}\n"],"names":[],"mappings":"AAoBA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,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;AACtB,SAAQ,cAAc;AAEtB,SAAQ,oBAAoB;AAO1B,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,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAe;AACb,QAAI,KAAK,iBAAiB;AACxB,WAAK,gBAAgB,MAAM;AAC3B,WAAK,kBAAkB;AAAA,IAAA;AAEzB,SAAK,cAAc;AACnB,SAAK,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOlB,MAAM,gBAAgB,MAA4B;AAChD,SAAK,WAAW;AAChB,QAAI,KAAK,YAAa;AACtB,SAAK,cAAc;AAEd,SAAA,kBAAkB,IAAI,gBAAgB;AACrC,UAAA,SAAS,KAAK,gBAAgB;AAEhC,QAAA;AACF,aAAO,KAAK,aAAa;AACvB,cAAM,KAAK,MAAM,KAAK,QAAQ,MAAM,MAAM;AAAA,MAAA;AAG5C,aAAO,KAAK,QAAQ,KAAK,mBAAmB;AAC1C,cAAM,KAAK,MAAM,KAAK,oBAAoB,KAAK,OAAO,MAAM;AAAA,MAAA;AAG9D,WAAK,cAAc;AACnB,WAAK,cAAc;AAEnB,YAAM,KAAK,gBAAgB,GAAG,KAAK,QAAQ;AAAA,aACpC,OAAO;AACd,UAAI,iBAAiB,SAAS,MAAM,SAAS,cAAc;AACzD;AAAA,MAAA;AAEE,UAAA;AACG,aAAA,QAAQ,QAAQ,KAAK;AAAA,MAAA,QACpB;AAAA,MAAA;AAAA,IAER,UACA;AACA,WAAK,oBAAoB,KAAK,IAAI,IAAI,KAAK,QAAQ;AACnD,WAAK,cAAc;AACnB,WAAK,kBAAkB;AAAA,IAAA;AAAA,EACzB;AAAA,EAGM,MAAM,IAAY,QAAoC;AAC5D,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AAChC,YAAA,UAAU,WAAW,SAAS,EAAE;AAC/B,aAAA;AAAA,QACL;AAAA,QACA,MAAM;AACJ,uBAAa,OAAO;AACb,iBAAA,IAAI,MAAM,YAAY,CAAC;AAAA,QAChC;AAAA,QACA,EAAE,MAAM,KAAK;AAAA,MACf;AAAA,IAAA,CACD;AAAA,EAAA;AAAA,EAGH,MAAc,mBAAmB,MAA4B;AACvD,QAAA,CAAC,KAAK,QAAQ,QAAS;AACtB,SAAA;AACC,UAAA,KAAK,GAAG,GAAG,IAAI;AAAA,EAAA;AAEzB;AAkBgB,SAAA,cAEd,IAAS,gBAAwD;AACjE,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;"}
+{"version":3,"file":"async-throttler.js","sources":["../../src/async-throttler.ts"],"sourcesContent":["import type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  /**\n   * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Optional error handler for when the throttled function throws\n   */\n  onError?: (error: unknown) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onExecute?: (throttler: AsyncThrottler<TFn, TArgs>) => void\n  /**\n   * Time window in milliseconds during which the function can only be executed once\n   * Defaults to 0ms\n   */\n  wait: number\n}\n\nconst defaultOptions: Required<AsyncThrottlerOptions<any, any>> = {\n  enabled: true,\n  onError: () => {},\n  onExecute: () => {},\n  wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n *   await saveToAPI(value);\n * }, { wait: 1000 });\n *\n * // Will only execute once per second no matter how often called\n * inputElement.addEventListener('input', () => {\n *   throttler.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class AsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  private _options: Required<AsyncThrottlerOptions<TFn, TArgs>>\n  private _abortController: AbortController | null = null\n  private _executionCount = 0\n  private _isExecuting = false\n  private _isPending = false\n  private _lastArgs: TArgs | undefined\n  private _lastExecutionTime = 0\n  private _nextExecutionTime = 0\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncThrottlerOptions<TFn, TArgs>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncThrottlerOptions<TFn, TArgs>>,\n  ): Required<AsyncThrottlerOptions<TFn, TArgs>> {\n    this._options = {\n      ...this._options,\n      ...newOptions,\n    }\n    return this._options\n  }\n\n  /**\n   * Returns the current options\n   */\n  getOptions(): Required<AsyncThrottlerOptions<TFn, TArgs>> {\n    return this._options\n  }\n\n  /**\n   * Attempts to execute the throttled function\n   * If a call is already in progress, it may be blocked or queued depending on the `wait` option\n   */\n  async maybeExecute(...args: TArgs): Promise<void> {\n    this._lastArgs = args\n    if (this._isPending) return\n    this._isPending = true\n\n    this._abortController = new AbortController()\n    const signal = this._abortController.signal\n\n    try {\n      while (this._isExecuting) {\n        await this.delay(this._options.wait, signal)\n      }\n\n      while (Date.now() < this._nextExecutionTime) {\n        await this.delay(this._nextExecutionTime - Date.now(), signal)\n      }\n\n      this._isPending = false\n      this._isExecuting = true\n\n      await this.executeFunction(...this._lastArgs)\n    } catch (error) {\n      if (error instanceof Error && error.name === 'AbortError') {\n        return // Silent return on cancellation\n      }\n      try {\n        this._options.onError(error)\n      } catch {\n        // Ignore errors from error handler\n      }\n    } finally {\n      this._lastExecutionTime = Date.now()\n      this._nextExecutionTime = this._lastExecutionTime + this._options.wait\n      this._isExecuting = false\n      this._abortController = null\n    }\n  }\n\n  private delay(ms: number, signal: AbortSignal): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const timeout = setTimeout(resolve, ms)\n      signal.addEventListener(\n        'abort',\n        () => {\n          clearTimeout(timeout)\n          reject(new Error('AbortError'))\n        },\n        { once: true },\n      )\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._abortController) {\n      this._abortController.abort()\n      this._abortController = null\n    }\n    this._isPending = false\n    this._lastArgs = undefined\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 the last execution time\n   */\n  getLastExecutionTime(): number {\n    return this._lastExecutionTime\n  }\n\n  /**\n   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this._nextExecutionTime\n  }\n\n  /**\n   * Returns the current pending state\n   */\n  getIsPending(): boolean {\n    return this._isPending\n  }\n}\n\n/**\n * Creates an async throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * @example\n * ```ts\n * const throttled = asyncThrottle(async () => {\n *   await someAsyncOperation();\n * }, { wait: 1000 });\n *\n * // This will execute at most once per second\n * await throttled();\n * await throttled(); // Waits 1 second before executing\n * ```\n */\nexport function asyncThrottle<\n  TFn extends AnyAsyncFunction,\n  TArgs extends Parameters<TFn>,\n>(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions<TFn, TArgs>, 'enabled'>) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute.bind(asyncThrottler)\n}\n"],"names":[],"mappings":"AA6BA,MAAM,iBAA4D;AAAA,EAChE,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,MAAM;AACR;AAwBO,MAAM,eAGX;AAAA,EAUA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,mBAA2C;AACnD,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AACvB,SAAQ,aAAa;AAErB,SAAQ,qBAAqB;AAC7B,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,YAAY;AACjB,QAAI,KAAK,WAAY;AACrB,SAAK,aAAa;AAEb,SAAA,mBAAmB,IAAI,gBAAgB;AACtC,UAAA,SAAS,KAAK,iBAAiB;AAEjC,QAAA;AACF,aAAO,KAAK,cAAc;AACxB,cAAM,KAAK,MAAM,KAAK,SAAS,MAAM,MAAM;AAAA,MAAA;AAG7C,aAAO,KAAK,QAAQ,KAAK,oBAAoB;AAC3C,cAAM,KAAK,MAAM,KAAK,qBAAqB,KAAK,OAAO,MAAM;AAAA,MAAA;AAG/D,WAAK,aAAa;AAClB,WAAK,eAAe;AAEpB,YAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,aACrC,OAAO;AACd,UAAI,iBAAiB,SAAS,MAAM,SAAS,cAAc;AACzD;AAAA,MAAA;AAEE,UAAA;AACG,aAAA,SAAS,QAAQ,KAAK;AAAA,MAAA,QACrB;AAAA,MAAA;AAAA,IAER,UACA;AACK,WAAA,qBAAqB,KAAK,IAAI;AACnC,WAAK,qBAAqB,KAAK,qBAAqB,KAAK,SAAS;AAClE,WAAK,eAAe;AACpB,WAAK,mBAAmB;AAAA,IAAA;AAAA,EAC1B;AAAA,EAGM,MAAM,IAAY,QAAoC;AAC5D,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AAChC,YAAA,UAAU,WAAW,SAAS,EAAE;AAC/B,aAAA;AAAA,QACL;AAAA,QACA,MAAM;AACJ,uBAAa,OAAO;AACb,iBAAA,IAAI,MAAM,YAAY,CAAC;AAAA,QAChC;AAAA,QACA,EAAE,MAAM,KAAK;AAAA,MACf;AAAA,IAAA,CACD;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,kBAAkB;AACzB,WAAK,iBAAiB,MAAM;AAC5B,WAAK,mBAAmB;AAAA,IAAA;AAE1B,SAAK,aAAa;AAClB,SAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMnB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAEhB;AAkBgB,SAAA,cAGd,IAAS,gBAAoE;AAC7E,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;"}

package/dist/esm/debouncer.d.ts

@@ -1,7 +1,8 @@
+import { AnyFunction } from './types.js';
 /**
  * Options for configuring a debounced function
  */
-export interface DebouncerOptions {
+export interface DebouncerOptions<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
     /**
      * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -12,6 +13,10 @@ export interface DebouncerOptions {
      * Defaults to false.
      */
     leading?: boolean;
+    /**
+     * Callback function that is called after the function is executed
+     */
+    onExecute?: (debouncer: Debouncer<TFn, TArgs>) => void;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.
@@ -46,22 +51,23 @@ export interface DebouncerOptions {
  * });
  * ```
  */
-export declare class Debouncer<TFn extends (...args: Array<any>) => any, TArgs extends Parameters<TFn>> {
+export declare class Debouncer<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
     private fn;
-    private canLeadingExecute;
-    private executionCount;
-    private options;
-    private timeoutId;
-    constructor(fn: TFn, initialOptions: DebouncerOptions);
+    private _canLeadingExecute;
+    private _isPending;
+    private _executionCount;
+    private _options;
+    private _timeoutId;
+    constructor(fn: TFn, initialOptions: DebouncerOptions<TFn, TArgs>);
     /**
      * Updates the debouncer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<DebouncerOptions>): Required<DebouncerOptions>;
+    setOptions(newOptions: Partial<DebouncerOptions<TFn, TArgs>>): Required<DebouncerOptions<TFn, TArgs>>;
     /**
-     * Returns the number of times the function has been executed
+     * Returns the current debouncer options
      */
-    getExecutionCount(): number;
+    getOptions(): Required<DebouncerOptions<TFn, TArgs>>;
     /**
      * Attempts to execute the debounced function
      * If a call is already in progress, it will be queued
@@ -72,6 +78,14 @@ export declare class Debouncer<TFn extends (...args: Array<any>) => any, TArgs e
      * Cancels any pending execution
      */
     cancel(): void;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns `true` if debouncing
+     */
+    getIsPending(): boolean;
 }
 /**
  * Creates a debounced function that delays invoking the provided function until after a specified wait time.
@@ -93,4 +107,4 @@ export declare class Debouncer<TFn extends (...args: Array<any>) => any, TArgs e
  * inputElement.addEventListener('input', debounced);
  * ```
  */
-export declare function debounce<TFn extends (...args: Array<any>) => any>(fn: TFn, initialOptions: Omit<DebouncerOptions, 'enabled'>): (...args: Parameters<TFn>) => void;
+export declare function debounce<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<DebouncerOptions<TFn, Parameters<TFn>>, 'enabled'>): (...args: Parameters<TFn>) => void;