@tanstack/pacer 0.2.0 → 0.4.0

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

@@ -9,6 +9,16 @@ export interface AsyncQueuerOptions<TValue> {
      * Maximum number of concurrent tasks to process
      */
     concurrency?: number;
+    /**
+     * Maximum time in milliseconds that an item can stay in the queue
+     * If not provided, items will never expire
+     */
+    expirationDuration?: number;
+    /**
+     * Function to determine if an item has expired
+     * If provided, this overrides the expirationDuration behavior
+     */
+    getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean;
     /**
      * Default position to get items from during processing
      * @default 'front'
@@ -47,7 +57,11 @@ export interface AsyncQueuerOptions<TValue> {
      */
     onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
     /**
-     * Whether the queuer should start processing tasks immediately
+     * Callback fired whenever an item expires in the queuer
+     */
+    onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Whether the queuer should start processing tasks immediately or not.
      */
     started?: boolean;
     /**
@@ -65,6 +79,7 @@ export interface AsyncQueuerOptions<TValue> {
  * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
  * - Pause/resume task processing
  * - Task cancellation
+ * - Item expiration to clear stale items from the queue
  *
  * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,
  * the next pending task is processed if below the concurrency limit.
@@ -89,7 +104,9 @@ export declare class AsyncQueuer<TValue> {
     private _activeItems;
     private _executionCount;
     private _rejectionCount;
+    private _expirationCount;
     private _items;
+    private _itemTimestamps;
     private _onErrorCallbacks;
     private _onSettledCallbacks;
     private _onSuccessCallbacks;
@@ -100,7 +117,7 @@ export declare class AsyncQueuer<TValue> {
      * Updates the queuer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): AsyncQueuerOptions<TValue>;
+    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): void;
     /**
      * Returns the current queuer options
      */
@@ -109,6 +126,10 @@ export declare class AsyncQueuer<TValue> {
      * Processes items in the queuer
      */
     private tick;
+    /**
+     * Checks for and removes expired items from the queuer
+     */
+    private checkExpiredItems;
     /**
      * Starts the queuer and processes items
      */
@@ -191,6 +212,10 @@ export declare class AsyncQueuer<TValue> {
      * Adds a callback to be called when a task is settled
      */
     onSettled(cb: (result: TValue | Error) => void): () => void;
+    /**
+     * Returns the number of items that have expired from the queuer
+     */
+    getExpirationCount(): number;
 }
 /**
  * Creates a new AsyncQueuer instance with the given options and returns a bound addItem function.
@@ -209,6 +234,6 @@ export declare class AsyncQueuer<TValue> {
  * @param options - Configuration options for the AsyncQueuer
  * @returns A bound addItem function that can be used to add tasks to the queuer
  */
-export declare function asyncQueue<TValue>(options?: AsyncQueuerOptions<TValue>): (fn: (() => Promise<TValue>) & {
+export declare function asyncQueue<TValue>(options?: Omit<AsyncQueuerOptions<TValue>, 'started'>): (fn: (() => Promise<TValue>) & {
     priority?: number;
 }, position?: QueuePosition, runOnUpdate?: boolean) => Promise<TValue>;

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

@@ -2,19 +2,25 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const defaultOptions = {
   enabled: true,
+  onError: () => {
+  },
   onReject: () => {
   },
-  onError: () => {
+  onSettled: () => {
   },
-  onExecute: () => {
-  }
+  onSuccess: () => {
+  },
+  windowType: "fixed"
 };
 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._isExecuting = false;
     this._options = {
       ...defaultOptions,
       ...initialOptions
@@ -25,11 +31,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
@@ -55,33 +57,42 @@ class AsyncRateLimiter {
    */
   async maybeExecute(...args) {
     this.cleanupOldExecutions();
-    if (this._executionTimes.length < this._options.limit) {
-      await this.executeFunction(...args);
-      return true;
+    if (this._options.windowType === "sliding") {
+      if (this._executionTimes.length < this._options.limit) {
+        await this.executeFunction(...args);
+        return this._lastResult;
+      }
+    } else {
+      const now = Date.now();
+      const oldestExecution = Math.min(...this._executionTimes);
+      const isNewWindow = oldestExecution + this._options.window <= now;
+      if (isNewWindow || this._executionTimes.length < this._options.limit) {
+        await this.executeFunction(...args);
+        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;
+    this._isExecuting = true;
     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._isExecuting = false;
+      this._settleCount++;
+      (_f = (_e = this._options).onSettled) == null ? void 0 : _f.call(_e, this);
     }
+    return this._lastResult;
   }
   rejectFunction() {
     this._rejectionCount++;
@@ -96,38 +107,64 @@ class AsyncRateLimiter {
       (time) => time > windowStart
     );
   }
+  /**
+   * 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
+   * For fixed windows, this is the time until the current window resets
+   * For sliding windows, this is the time until the oldest execution expires
+   */
+  getMsUntilNextWindow() {
+    if (this.getRemainingInWindow() > 0) {
+      return 0;
+    }
+    const oldestExecution = Math.min(...this._executionTimes);
+    return oldestExecution + this._options.window - Date.now();
+  }
   /**
    * Returns the number of times the function has been executed
    */
-  getExecutionCount() {
-    return this._executionCount;
+  getSuccessCount() {
+    return this._successCount;
   }
   /**
-   * Returns the number of times the function has been rejected
+   * Returns the number of times the function has been settled
    */
-  getRejectionCount() {
-    return this._rejectionCount;
+  getSettleCount() {
+    return this._settleCount;
   }
   /**
-   * Returns the number of remaining executions allowed in the current window
+   * Returns the number of times the function has errored
    */
-  getRemainingInWindow() {
-    this.cleanupOldExecutions();
-    return Math.max(0, this._options.limit - this._executionTimes.length);
+  getErrorCount() {
+    return this._errorCount;
   }
   /**
-   * Returns the number of milliseconds until the next execution will be possible
+   * Returns the number of times the function has been rejected
    */
-  getMsUntilNextWindow() {
-    return this.getRemainingInWindow() * this._options.window;
+  getRejectionCount() {
+    return this._rejectionCount;
+  }
+  /**
+   * Returns whether the function is currently executing
+   */
+  getIsExecuting() {
+    return this._isExecuting;
   }
   /**
    * 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 callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (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   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\nconst defaultOptions: Required<\n  Omit<AsyncRateLimiterOptions<any>, 'limit' | 'window'>\n> = {\n  enabled: true,\n  onError: () => {},\n  onReject: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  windowType: 'fixed',\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 * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\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, windowType: 'sliding' } // 5 calls per second with sliding window\n * );\n *\n * // Will execute immediately until limit reached, then block\n * // Returns the API response directly\n * const data = 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  private _isExecuting = false\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._options.windowType === 'sliding') {\n      // For sliding window, we can execute if we have capacity in the current window\n      if (this._executionTimes.length < this._options.limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\n    } else {\n      // For fixed window, we need to check if we're in a new window\n      const now = Date.now()\n      const oldestExecution = Math.min(...this._executionTimes)\n      const isNewWindow = oldestExecution + this._options.window <= now\n\n      if (isNewWindow || this._executionTimes.length < this._options.limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\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    this._isExecuting = true\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._isExecuting = false\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   * For fixed windows, this is the time until the current window resets\n   * For sliding windows, this is the time until the oldest execution expires\n   */\n  getMsUntilNextWindow(): number {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = Math.min(...this._executionTimes)\n    return oldestExecution + this._options.window - Date.now()\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   * Returns whether the function is currently executing\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\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 * Unlike the non-async rate limiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\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 with a sliding window\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\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 * // Returns the API response directly\n * const result = 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":";;AA+CA,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,EAAC;AAAA,EAClB,YAAY;AACd;AAsCO,MAAM,iBAA+C;AAAA,EAU1D,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,cAAc;AACtB,SAAQ,kBAAiC,CAAC;AAE1C,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,eAAe;AAMrB,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;AAEtB,QAAA,KAAK,SAAS,eAAe,WAAW;AAE1C,UAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC/C,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,YAAM,cAAc,kBAAkB,KAAK,SAAS,UAAU;AAE9D,UAAI,eAAe,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC9D,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBACT,MACmC;;AAClC,QAAA,CAAC,KAAK,SAAS,QAAS;AAC5B,SAAK,eAAe;AACd,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;AACA,WAAK,eAAe;AACf,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;AAAA;AAAA,EAQtE,uBAA+B;AACzB,QAAA,KAAK,qBAAqB,IAAI,GAAG;AAC5B,aAAA;AAAA,IAAA;AAET,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,SAAS,SAAS,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,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,iBAA0B;AACxB,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;AA4CgB,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,19 +15,30 @@ 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 callback function that is called when an execution is rejected due to rate limiting
+     */
+    onReject?: (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 callback function that is called when an execution is rejected due to rate limiting
+     * Optional function to call when the rate-limited function is executed
      */
-    onReject?: (rateLimiter: AsyncRateLimiter<TFn, TArgs>) => void;
+    onSuccess?: (result: ReturnType<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
      * Time window in milliseconds within which the limit applies
      */
     window: number;
+    /**
+     * Type of window to use for rate limiting
+     * - 'fixed': Uses a fixed window that resets after the window period
+     * - 'sliding': Uses a sliding window that allows executions as old ones expire
+     * Defaults to 'fixed'
+     */
+    windowType?: 'fixed' | 'sliding';
 }
 /**
  * A class that creates an async rate-limited function.
@@ -36,6 +47,16 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TArgs ext
  * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
  * all executions happen immediately, followed by a complete block.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+ *   consistent rate of execution over time.
+ *
+ * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
  * For smoother execution patterns, consider using:
  * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
  * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
@@ -47,29 +68,34 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TArgs ext
  * ```ts
  * const rateLimiter = new AsyncRateLimiter(
  *   async (id: string) => await api.getData(id),
- *   { limit: 5, window: 1000 } // 5 calls per second
+ *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window
  * );
  *
  * // Will execute immediately until limit reached, then block
- * await rateLimiter.maybeExecute('123');
+ * // Returns the API response directly
+ * const data = 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;
+    private _isExecuting;
+    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 +112,40 @@ 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
+     * For fixed windows, this is the time until the current window resets
+     * For sliding windows, this is the time until the oldest execution expires
+     */
+    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;
+    /**
+     * Returns whether the function is currently executing
+     */
+    getIsExecuting(): boolean;
     /**
      * Resets the rate limiter state
      */
@@ -114,6 +154,16 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extend
 /**
  * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.
  *
+ * Unlike the non-async rate limiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+ *   consistent rate of execution over time.
+ *
  * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:
  * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets
  * - A throttler ensures even spacing between executions, which can be better for consistent performance
@@ -124,10 +174,11 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extend
  *
  * @example
  * ```ts
- * // Rate limit to 5 calls per minute
+ * // Rate limit to 5 calls per minute with a sliding window
  * const rateLimited = asyncRateLimit(makeApiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding',
  *   onReject: (rateLimiter) => {
  *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }
@@ -135,10 +186,11 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction, TArgs extend
  *
  * // First 5 calls will execute immediately
  * // Additional calls will be rejected until the minute window resets
- * await rateLimited();
+ * // Returns the API response directly
+ * const result = await rateLimited();
  *
  * // For more even execution, consider using throttle instead:
  * 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>;