@tanstack/pacer 0.2.0 → 0.3.0

package/dist/cjs/async-rate-limiter.cjs

@@ -2,19 +2,23 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const defaultOptions = {
   enabled: true,
+  onError: () => {
+  },
   onReject: () => {
   },
-  onError: () => {
+  onSettled: () => {
   },
-  onExecute: () => {
+  onSuccess: () => {
   }
 };
 class AsyncRateLimiter {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this._executionCount = 0;
+    this._errorCount = 0;
     this._executionTimes = [];
     this._rejectionCount = 0;
+    this._settleCount = 0;
+    this._successCount = 0;
     this._options = {
       ...defaultOptions,
       ...initialOptions
@@ -25,11 +29,7 @@ class AsyncRateLimiter {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this._options = {
-      ...this._options,
-      ...newOptions
-    };
-    return this._options;
+    this._options = { ...this._options, ...newOptions };
   }
   /**
    * Returns the current rate limiter options
@@ -57,31 +57,28 @@ class AsyncRateLimiter {
     this.cleanupOldExecutions();
     if (this._executionTimes.length < this._options.limit) {
       await this.executeFunction(...args);
-      return true;
+      return this._lastResult;
     }
     this.rejectFunction();
-    return false;
+    return void 0;
   }
   async executeFunction(...args) {
-    var _a, _b;
+    var _a, _b, _c, _d, _e, _f;
     if (!this._options.enabled) return;
     const now = Date.now();
-    this._executionCount++;
     this._executionTimes.push(now);
     try {
-      await this.fn(...args);
+      this._lastResult = await this.fn(...args);
+      this._successCount++;
+      (_b = (_a = this._options).onSuccess) == null ? void 0 : _b.call(_a, this._lastResult, this);
     } catch (error) {
-      if (this._options.onError) {
-        try {
-          this._options.onError(error);
-        } catch (error2) {
-          console.error("Error in onError handler", error2);
-        }
-      }
-      throw error;
+      this._errorCount++;
+      (_d = (_c = this._options).onError) == null ? void 0 : _d.call(_c, error, this);
     } finally {
-      (_b = (_a = this._options).onExecute) == null ? void 0 : _b.call(_a, this);
+      this._settleCount++;
+      (_f = (_e = this._options).onSettled) == null ? void 0 : _f.call(_e, this);
     }
+    return this._lastResult;
   }
   rejectFunction() {
     this._rejectionCount++;
@@ -96,18 +93,6 @@ class AsyncRateLimiter {
       (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
    */
@@ -121,13 +106,39 @@ class AsyncRateLimiter {
   getMsUntilNextWindow() {
     return this.getRemainingInWindow() * this._options.window;
   }
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getSuccessCount() {
+    return this._successCount;
+  }
+  /**
+   * Returns the number of times the function has been settled
+   */
+  getSettleCount() {
+    return this._settleCount;
+  }
+  /**
+   * Returns the number of times the function has errored
+   */
+  getErrorCount() {
+    return this._errorCount;
+  }
+  /**
+   * Returns the number of times the function has been rejected
+   */
+  getRejectionCount() {
+    return this._rejectionCount;
+  }
   /**
    * Resets the rate limiter state
    */
   reset() {
     this._executionTimes = [];
-    this._executionCount = 0;
+    this._successCount = 0;
+    this._errorCount = 0;
     this._rejectionCount = 0;
+    this._settleCount = 0;
   }
 }
 function asyncRateLimit(fn, initialOptions) {

package/dist/cjs/async-rate-limiter.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"async-rate-limiter.cjs","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;;AACvD,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;;;"}
+{"version":3,"file":"async-rate-limiter.cjs","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<TFn extends AnyAsyncFunction> {\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, rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => 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>, 'limit' | 'window'>\n> = {\n  enabled: true,\n  onError: () => {},\n  onReject: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\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<TFn extends AnyAsyncFunction> {\n  private _options: AsyncRateLimiterOptions<TFn>\n  private _errorCount = 0\n  private _executionTimes: Array<number> = []\n  private _lastResult: ReturnType<TFn> | undefined\n  private _rejectionCount = 0\n  private _settleCount = 0\n  private _successCount = 0\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn>,\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(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<AsyncRateLimiterOptions<TFn>> {\n    return this._options as Required<AsyncRateLimiterOptions<TFn>>\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(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    this.cleanupOldExecutions()\n\n    if (this._executionTimes.length < this._options.limit) {\n      await this.executeFunction(...args)\n      return this._lastResult\n    }\n\n    this.rejectFunction()\n    return undefined\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this._options.enabled) return\n    const now = Date.now()\n    this._executionTimes.push(now)\n\n    try {\n      this._lastResult = await this.fn(...args)\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._settleCount++\n      this._options.onSettled?.(this)\n    }\n\n    return this._lastResult\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 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   * Returns the number of times the function has been executed\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has been settled\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 the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._successCount = 0\n    this._errorCount = 0\n    this._rejectionCount = 0\n    this._settleCount = 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<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":";;AAwCA,MAAM,iBAEF;AAAA,EACF,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAA;AACnB;AA2BO,MAAM,iBAA+C;AAAA,EAS1D,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AARV,SAAQ,cAAc;AACtB,SAAQ,kBAAiC,CAAC;AAE1C,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AAMtB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAyD;AAClE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAqD;AACnD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBd,MAAM,gBACD,MACmC;AACtC,SAAK,qBAAqB;AAE1B,QAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC/C,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,aAAO,KAAK;AAAA,IAAA;AAGd,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBACT,MACmC;;AAClC,QAAA,CAAC,KAAK,SAAS,QAAS;AACtB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA,gBAAgB,KAAK,GAAG;AAEzB,QAAA;AACF,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,uBAAK,UAAS,cAAd,4BAA0B,KAAK,aAAc;AAAA,aACtC,OAAO;AACT,WAAA;AACA,uBAAA,UAAS,YAAT,4BAAmB,OAAO;AAAA,IAAI,UACnC;AACK,WAAA;AACA,uBAAA,UAAS,cAAT,4BAAqB;AAAA,IAAI;AAGhC,WAAO,KAAK;AAAA,EAAA;AAAA,EAGN,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,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,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,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,gBAAgB;AACrB,SAAK,cAAc;AACnB,SAAK,kBAAkB;AACvB,SAAK,eAAe;AAAA,EAAA;AAExB;AAgCgB,SAAA,eACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AACpD,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;;;"}

package/dist/cjs/async-rate-limiter.d.cts

@@ -2,7 +2,7 @@ import { AnyAsyncFunction } from './types.cjs';
 /**
  * Options for configuring an async rate-limited function
  */
-export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
+export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -15,15 +15,19 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TArgs ext
     /**
      * Optional error handler for when the rate-limited function throws
      */
-    onError?: (error: unknown) => void;
+    onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
      * Optional function to call when the rate-limited function is executed
      */
-    onExecute?: (rateLimiter: AsyncRateLimiter<TFn, TArgs>) => void;
+    onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void;
+    /**
+     * Optional function to call when the rate-limited function is executed
+     */
+    onSuccess?: (result: ReturnType<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
      * Optional callback function that is called when an execution is rejected due to rate limiting
      */
-    onReject?: (rateLimiter: AsyncRateLimiter<TFn, TArgs>) => void;
+    onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
      * Time window in milliseconds within which the limit applies
      */
@@ -54,22 +58,25 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TArgs ext
  * await rateLimiter.maybeExecute('123');
  * ```
  */
-export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>> {
+export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
     private fn;
-    private _executionCount;
-    private _executionTimes;
     private _options;
+    private _errorCount;
+    private _executionTimes;
+    private _lastResult;
     private _rejectionCount;
-    constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn, TArgs>);
+    private _settleCount;
+    private _successCount;
+    constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>);
     /**
      * Updates the rate limiter options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn, TArgs>>): AsyncRateLimiterOptions<TFn, TArgs>;
+    setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void;
     /**
      * Returns the current rate limiter options
      */
-    getOptions(): Required<AsyncRateLimiterOptions<TFn, TArgs>>;
+    getOptions(): Required<AsyncRateLimiterOptions<TFn>>;
     /**
      * Attempts to execute the rate-limited function if within the configured limits.
      * Will reject execution if the number of calls in the current window exceeds the limit.
@@ -86,26 +93,34 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extend
      * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected
      * ```
      */
-    maybeExecute(...args: TArgs): Promise<boolean>;
+    maybeExecute(...args: Parameters<TFn>): Promise<ReturnType<TFn> | undefined>;
     private executeFunction;
     private rejectFunction;
     private cleanupOldExecutions;
+    /**
+     * Returns the number of remaining executions allowed in the current window
+     */
+    getRemainingInWindow(): number;
+    /**
+     * Returns the number of milliseconds until the next execution will be possible
+     */
+    getMsUntilNextWindow(): number;
     /**
      * Returns the number of times the function has been executed
      */
-    getExecutionCount(): number;
+    getSuccessCount(): number;
     /**
-     * Returns the number of times the function has been rejected
+     * Returns the number of times the function has been settled
      */
-    getRejectionCount(): number;
+    getSettleCount(): number;
     /**
-     * Returns the number of remaining executions allowed in the current window
+     * Returns the number of times the function has errored
      */
-    getRemainingInWindow(): number;
+    getErrorCount(): number;
     /**
-     * Returns the number of milliseconds until the next execution will be possible
+     * Returns the number of times the function has been rejected
      */
-    getMsUntilNextWindow(): number;
+    getRejectionCount(): number;
     /**
      * Resets the rate limiter state
      */
@@ -141,4 +156,4 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extend
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function asyncRateLimit<TFn extends AnyAsyncFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions<TFn, TArgs>, 'enabled'>): (...args: TArgs) => Promise<boolean>;
+export declare function asyncRateLimit<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;

package/dist/cjs/async-throttler.cjs

@@ -2,21 +2,27 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const defaultOptions = {
   enabled: true,
+  leading: true,
   onError: () => {
   },
-  onExecute: () => {
+  onSettled: () => {
   },
+  onSuccess: () => {
+  },
+  trailing: true,
   wait: 0
 };
 class AsyncThrottler {
   constructor(fn, initialOptions) {
     this.fn = fn;
     this._abortController = null;
-    this._executionCount = 0;
+    this._errorCount = 0;
     this._isExecuting = false;
-    this._isPending = false;
     this._lastExecutionTime = 0;
     this._nextExecutionTime = 0;
+    this._settleCount = 0;
+    this._successCount = 0;
+    this._timeoutId = null;
     this._options = {
       ...defaultOptions,
       ...initialOptions
@@ -27,11 +33,10 @@ class AsyncThrottler {
    * 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.cancel();
+    }
   }
   /**
    * Returns the current options
@@ -44,72 +49,65 @@ class AsyncThrottler {
    * 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._isPending) return;
-    this._isPending = true;
+    const now = Date.now();
+    const timeSinceLastExecution = now - this._lastExecutionTime;
+    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {
+      await this.executeFunction(...args);
+      return this._lastResult;
+    } else {
+      this._lastArgs = args;
+      return new Promise((resolve) => {
+        if (this._timeoutId) {
+          clearTimeout(this._timeoutId);
+        }
+        if (this._options.trailing) {
+          const _timeSinceLastExecution = this._lastExecutionTime ? now - this._lastExecutionTime : 0;
+          const timeoutDuration = this._options.wait - _timeSinceLastExecution;
+          this._timeoutId = setTimeout(async () => {
+            if (this._lastArgs !== void 0) {
+              await this.executeFunction(...this._lastArgs);
+            }
+            resolve(this._lastResult);
+          }, timeoutDuration);
+        }
+      });
+    }
+  }
+  async executeFunction(...args) {
+    if (!this._options.enabled || this._isExecuting) return void 0;
     this._abortController = new AbortController();
-    const signal = this._abortController.signal;
     try {
-      while (this._isExecuting) {
-        await this.delay(this._options.wait, signal);
-      }
-      while (Date.now() < this._nextExecutionTime) {
-        await this.delay(this._nextExecutionTime - Date.now(), signal);
-      }
-      this._isPending = false;
       this._isExecuting = true;
-      await this.executeFunction(...this._lastArgs);
+      this._lastResult = await this.fn(...args);
+      this._successCount++;
+      this._options.onSuccess(this._lastResult, this);
     } catch (error) {
-      if (error instanceof Error && error.name === "AbortError") {
-        return;
-      }
-      try {
-        this._options.onError(error);
-      } catch {
-      }
+      this._errorCount++;
+      this._options.onError(error, this);
     } finally {
-      this._lastExecutionTime = Date.now();
-      this._nextExecutionTime = this._lastExecutionTime + this._options.wait;
       this._isExecuting = false;
+      this._settleCount++;
       this._abortController = null;
+      this._lastExecutionTime = Date.now();
+      this._nextExecutionTime = this._lastExecutionTime + this._options.wait;
+      this._options.onSettled(this);
     }
-  }
-  delay(ms, signal) {
-    return new Promise((resolve, reject) => {
-      const timeout = setTimeout(resolve, ms);
-      signal.addEventListener(
-        "abort",
-        () => {
-          clearTimeout(timeout);
-          reject(new Error("AbortError"));
-        },
-        { once: true }
-      );
-    });
-  }
-  async executeFunction(...args) {
-    if (!this._options.enabled) return;
-    this._executionCount++;
-    await this.fn(...args);
-    this._options.onExecute(this);
+    return this._lastResult;
   }
   /**
-   * Cancels any pending execution
+   * Cancels any pending execution or aborts any execution in progress
    */
   cancel() {
+    if (this._timeoutId) {
+      clearTimeout(this._timeoutId);
+      this._timeoutId = null;
+    }
     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
    */
@@ -122,11 +120,41 @@ class AsyncThrottler {
   getNextExecutionTime() {
     return this._nextExecutionTime;
   }
+  /**
+   * 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 the current pending state
    */
   getIsPending() {
-    return this._isPending;
+    return this._options.enabled && !!this._timeoutId;
+  }
+  /**
+   * Returns the current executing state
+   */
+  getIsExecuting() {
+    return this._isExecuting;
   }
 }
 function asyncThrottle(fn, initialOptions) {

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

@@ -1 +1 @@
-{"version":3,"file":"async-throttler.cjs","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;;;"}
+{"version":3,"file":"async-throttler.cjs","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<TFn extends AnyAsyncFunction> {\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   * Whether to execute the function immediately when called\n   * Defaults to true\n   */\n  leading?: boolean\n  /**\n   * Optional error handler for when the throttled function throws\n   */\n  onError?: (error: unknown, asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSettled?: (asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\n  /**\n   * Whether to execute the function on the trailing edge of the wait period\n   * Defaults to true\n   */\n  trailing?: 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\nconst defaultOptions: Required<AsyncThrottlerOptions<any>> = {\n  enabled: true,\n  leading: true,\n  onError: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  trailing: true,\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<TFn extends AnyAsyncFunction> {\n  private _options: Required<AsyncThrottlerOptions<TFn>>\n  private _abortController: AbortController | null = null\n  private _errorCount = 0\n  private _isExecuting = false\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastExecutionTime = 0\n  private _lastResult: ReturnType<TFn> | undefined\n  private _nextExecutionTime = 0\n  private _settleCount = 0\n  private _successCount = 0\n  private _timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncThrottlerOptions<TFn>,\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(newOptions: Partial<AsyncThrottlerOptions<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.cancel()\n    }\n  }\n\n  /**\n   * Returns the current options\n   */\n  getOptions(): Required<AsyncThrottlerOptions<TFn>> {\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(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    const now = Date.now()\n    const timeSinceLastExecution = now - this._lastExecutionTime\n\n    // Handle leading execution\n    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {\n      await this.executeFunction(...args)\n      return this._lastResult\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this._lastArgs = args\n\n      return new Promise((resolve) => {\n        // Clear any existing timeout to ensure we use the latest arguments\n        if (this._timeoutId) {\n          clearTimeout(this._timeoutId)\n        }\n\n        // Set up trailing execution if enabled\n        if (this._options.trailing) {\n          const _timeSinceLastExecution = this._lastExecutionTime\n            ? now - this._lastExecutionTime\n            : 0\n          const timeoutDuration = this._options.wait - _timeSinceLastExecution\n          this._timeoutId = setTimeout(async () => {\n            if (this._lastArgs !== undefined) {\n              await this.executeFunction(...this._lastArgs)\n            }\n            resolve(this._lastResult)\n          }, timeoutDuration)\n        }\n      })\n    }\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this._options.enabled || this._isExecuting) 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._settleCount++\n      this._abortController = null\n      this._lastExecutionTime = Date.now()\n      this._nextExecutionTime = this._lastExecutionTime + this._options.wait\n      this._options.onSettled(this)\n    }\n    return this._lastResult\n  }\n\n  /**\n   * Cancels any pending execution or aborts any execution in progress\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  }\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 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 the current pending state\n   */\n  getIsPending(): boolean {\n    return this._options.enabled && !!this._timeoutId\n  }\n\n  /**\n   * Returns the current executing state\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\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<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: Omit<AsyncThrottlerOptions<TFn>, 'enabled'>,\n) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute.bind(asyncThrottler)\n}\n"],"names":[],"mappings":";;AA2CA,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;AAZV,SAAQ,mBAA2C;AACnD,SAAQ,cAAc;AACtB,SAAQ,eAAe;AAEvB,SAAQ,qBAAqB;AAE7B,SAAQ,qBAAqB;AAC7B,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,OAAO;AAAA,IAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAMF,aAAmD;AACjD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,MAAM,gBACD,MACmC;AAChC,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,yBAAyB,MAAM,KAAK;AAG1C,QAAI,KAAK,SAAS,WAAW,0BAA0B,KAAK,SAAS,MAAM;AACnE,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,aAAO,KAAK;AAAA,IAAA,OACP;AAEL,WAAK,YAAY;AAEV,aAAA,IAAI,QAAQ,CAAC,YAAY;AAE9B,YAAI,KAAK,YAAY;AACnB,uBAAa,KAAK,UAAU;AAAA,QAAA;AAI1B,YAAA,KAAK,SAAS,UAAU;AAC1B,gBAAM,0BAA0B,KAAK,qBACjC,MAAM,KAAK,qBACX;AACE,gBAAA,kBAAkB,KAAK,SAAS,OAAO;AACxC,eAAA,aAAa,WAAW,YAAY;AACnC,gBAAA,KAAK,cAAc,QAAW;AAChC,oBAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,YAAA;AAE9C,oBAAQ,KAAK,WAAW;AAAA,aACvB,eAAe;AAAA,QAAA;AAAA,MACpB,CACD;AAAA,IAAA;AAAA,EACH;AAAA,EAGF,MAAc,mBACT,MACmC;AACtC,QAAI,CAAC,KAAK,SAAS,WAAW,KAAK,aAAqB,QAAA;AACnD,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;AACf,WAAA;AACL,WAAK,mBAAmB;AACnB,WAAA,qBAAqB,KAAK,IAAI;AACnC,WAAK,qBAAqB,KAAK,qBAAqB,KAAK,SAAS;AAC7D,WAAA,SAAS,UAAU,IAAI;AAAA,IAAA;AAE9B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,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;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMnB,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,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;AACtB,WAAO,KAAK,SAAS,WAAW,CAAC,CAAC,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAEhB;AAkBgB,SAAA,cACd,IACA,gBACA;AACA,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;;;"}