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

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

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

@@ -1,8 +1,8 @@
-import { RateLimitRejectionInfo } from './rate-limiter.cjs';
+import { AnyAsyncFunction } from './types.cjs';
 /**
  * Options for configuring an async rate-limited function
  */
-export interface AsyncRateLimiterOptions {
+export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -13,17 +13,25 @@ export interface AsyncRateLimiterOptions {
      */
     limit: number;
     /**
-     * Time window in milliseconds within which the limit applies
+     * Optional error handler for when the rate-limited function throws
      */
-    window: number;
+    onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void;
+    /**
+     * Optional function to call when the rate-limited function is executed
+     */
+    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?: (info: RateLimitRejectionInfo) => void;
+    onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
-     * Optional error handler for when the rate-limited function throws
+     * Time window in milliseconds within which the limit applies
      */
-    onError?: (error: unknown) => void;
+    window: number;
 }
 /**
  * A class that creates an async rate-limited function.
@@ -50,30 +58,25 @@ export interface AsyncRateLimiterOptions {
  * await rateLimiter.maybeExecute('123');
  * ```
  */
-export declare class AsyncRateLimiter<TFn extends (...args: Array<any>) => Promise<any>, TArgs extends Parameters<TFn>> {
+export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
     private fn;
-    private executionCount;
-    private rejectionCount;
-    private executionTimes;
-    private options;
-    constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions);
+    private _options;
+    private _errorCount;
+    private _executionTimes;
+    private _lastResult;
+    private _rejectionCount;
+    private _settleCount;
+    private _successCount;
+    constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>);
     /**
      * Updates the rate limiter options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncRateLimiterOptions>): AsyncRateLimiterOptions;
+    setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void;
     /**
-     * Returns the number of times the function has been executed
-     */
-    getExecutionCount(): number;
-    /**
-     * Returns the number of times the function has been rejected
-     */
-    getRejectionCount(): number;
-    /**
-     * Returns the number of remaining executions allowed in the current window
+     * Returns the current rate limiter options
      */
-    getRemainingInWindow(): number;
+    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.
@@ -90,10 +93,34 @@ export declare class AsyncRateLimiter<TFn extends (...args: Array<any>) => Promi
      * 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
+     */
+    getSuccessCount(): number;
+    /**
+     * Returns the number of times the function has been settled
+     */
+    getSettleCount(): number;
+    /**
+     * Returns the number of times the function has errored
+     */
+    getErrorCount(): number;
+    /**
+     * Returns the number of times the function has been rejected
+     */
+    getRejectionCount(): number;
     /**
      * Resets the rate limiter state
      */
@@ -116,8 +143,8 @@ export declare class AsyncRateLimiter<TFn extends (...args: Array<any>) => Promi
  * const rateLimited = asyncRateLimit(makeApiCall, {
  *   limit: 5,
  *   window: 60000,
- *   onReject: ({ msUntilNextWindow }) => {
- *     console.log(`Rate limit exceeded. Try again in ${msUntilNextWindow}ms`);
+ *   onReject: (rateLimiter) => {
+ *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }
  * });
  *
@@ -129,4 +156,4 @@ export declare class AsyncRateLimiter<TFn extends (...args: Array<any>) => Promi
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function asyncRateLimit<TFn extends (...args: Array<any>) => Promise<any>>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions, 'enabled'>): (...args: Parameters<TFn>) => Promise<boolean>;
+export declare function asyncRateLimit<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;