@tanstack/pacer 0.8.0 → 0.9.0

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

@@ -1,206 +1,149 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const store = require("@tanstack/store");
 const utils = require("./utils.cjs");
+function getDefaultAsyncRateLimiterState() {
+  return {
+    errorCount: 0,
+    executionTimes: [],
+    isExecuting: false,
+    lastResult: void 0,
+    rejectionCount: 0,
+    settleCount: 0,
+    successCount: 0
+  };
+}
 const defaultOptions = {
   enabled: true,
-  windowType: "fixed"
+  limit: 1,
+  window: 0,
+  windowType: "fixed",
+  throwOnError: true
 };
 class AsyncRateLimiter {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this._errorCount = 0;
-    this._executionTimes = [];
-    this._rejectionCount = 0;
-    this._settleCount = 0;
-    this._successCount = 0;
-    this._isExecuting = false;
-    this._options = {
-      ...defaultOptions,
-      ...initialOptions,
-      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError
+    this.store = new store.Store(getDefaultAsyncRateLimiterState());
+    this.setOptions = (newOptions) => {
+      this.options = { ...this.options, ...newOptions };
     };
-  }
-  /**
-   * Updates the rate limiter options
-   */
-  setOptions(newOptions) {
-    this._options = { ...this._options, ...newOptions };
-  }
-  /**
-   * Returns the current rate limiter options
-   */
-  getOptions() {
-    return this._options;
-  }
-  /**
-   * Returns the current enabled state of the rate limiter
-   */
-  getEnabled() {
-    return !!utils.parseFunctionOrValue(this._options.enabled, this);
-  }
-  /**
-   * Returns the current limit of executions allowed within the time window
-   */
-  getLimit() {
-    return utils.parseFunctionOrValue(this._options.limit, this);
-  }
-  /**
-   * Returns the current time window in milliseconds
-   */
-  getWindow() {
-    return utils.parseFunctionOrValue(this._options.window, this);
-  }
-  /**
-   * 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.
-   * If execution is allowed, waits for any previous execution to complete before proceeding.
-   *
-   * Error Handling:
-   * - If the rate-limited function throws and no `onError` handler is configured,
-   *   the error will be thrown from this method.
-   * - If an `onError` handler is configured, errors will be caught and passed to the handler,
-   *   and this method will return undefined.
-   * - If the rate limit is exceeded, the execution will be rejected and the `onReject` handler
-   *   will be called if configured.
-   * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.
-   * - Rate limit rejections can be tracked using `getRejectionCount()`.
-   *
-   * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
-   * @throws The error from the rate-limited function if no onError handler is configured
-   *
-   * @example
-   * ```ts
-   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });
-   *
-   * // First 5 calls will execute
-   * await rateLimiter.maybeExecute('arg1', 'arg2');
-   *
-   * // Additional calls within the window will be rejected
-   * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected
-   * ```
-   */
-  async maybeExecute(...args) {
-    this.cleanupOldExecutions();
-    const limit = this.getLimit();
-    const window = this.getWindow();
-    if (this._options.windowType === "sliding") {
-      if (this._executionTimes.length < limit) {
-        await this.execute(...args);
-        return this._lastResult;
+    this.#setState = (newState) => {
+      this.store.setState((state) => {
+        const combinedState = {
+          ...state,
+          ...newState
+        };
+        return combinedState;
+      });
+    };
+    this.#getEnabled = () => {
+      return !!utils.parseFunctionOrValue(this.options.enabled, this);
+    };
+    this.#getLimit = () => {
+      return utils.parseFunctionOrValue(this.options.limit, this);
+    };
+    this.#getWindow = () => {
+      return utils.parseFunctionOrValue(this.options.window, this);
+    };
+    this.maybeExecute = async (...args) => {
+      this.#cleanupOldExecutions();
+      const relevantExecutionTimes = this.#getRelevantExecutionTimes();
+      if (relevantExecutionTimes.length < this.#getLimit()) {
+        await this.#execute(...args);
+        return this.store.state.lastResult;
       }
-    } else {
+      this.#setState({
+        rejectionCount: this.store.state.rejectionCount + 1
+      });
+      this.options.onReject?.(this);
+      return void 0;
+    };
+    this.#execute = async (...args) => {
+      if (!this.#getEnabled()) return;
       const now = Date.now();
-      const oldestExecution = Math.min(...this._executionTimes);
-      const isNewWindow = oldestExecution + window <= now;
-      if (isNewWindow || this._executionTimes.length < limit) {
-        await this.execute(...args);
-        return this._lastResult;
+      const executionTimes = [...this.store.state.executionTimes, now];
+      this.#setState({
+        isExecuting: true,
+        executionTimes
+      });
+      try {
+        const result = await this.fn(...args);
+        this.#setState({
+          successCount: this.store.state.successCount + 1,
+          lastResult: result
+        });
+        this.options.onSuccess?.(result, this);
+      } catch (error) {
+        this.#setState({
+          errorCount: this.store.state.errorCount + 1
+        });
+        this.options.onError?.(error, this);
+        if (this.options.throwOnError) {
+          throw error;
+        }
+      } finally {
+        this.#setState({
+          isExecuting: false,
+          settleCount: this.store.state.settleCount + 1
+        });
+        this.options.onSettled?.(this);
       }
-    }
-    this.rejectFunction();
-    return void 0;
-  }
-  async execute(...args) {
-    var _a, _b, _c, _d, _e, _f;
-    if (!this.getEnabled()) return;
-    this._isExecuting = true;
-    const now = Date.now();
-    this._executionTimes.push(now);
-    try {
-      this._lastResult = await this.fn(...args);
-      this._successCount++;
-      (_b = (_a = this._options).onSuccess) == null ? void 0 : _b.call(_a, this._lastResult, this);
-    } catch (error) {
-      this._errorCount++;
-      (_d = (_c = this._options).onError) == null ? void 0 : _d.call(_c, error, this);
-      if (this._options.throwOnError) {
-        throw error;
+      return this.store.state.lastResult;
+    };
+    this.#getRelevantExecutionTimes = () => {
+      if (this.options.windowType === "sliding") {
+        return this.store.state.executionTimes.filter(
+          (time) => time > Date.now() - this.#getWindow()
+        );
       } else {
-        console.error(error);
+        const oldestExecution = Math.min(...this.store.state.executionTimes);
+        const windowStart = oldestExecution;
+        return this.store.state.executionTimes.filter(
+          (time) => time >= windowStart && time <= windowStart + this.#getWindow()
+        );
       }
-    } finally {
-      this._isExecuting = false;
-      this._settleCount++;
-      (_f = (_e = this._options).onSettled) == null ? void 0 : _f.call(_e, this);
-    }
-    return this._lastResult;
-  }
-  rejectFunction() {
-    this._rejectionCount++;
-    if (this._options.onReject) {
-      this._options.onReject(this);
-    }
-  }
-  cleanupOldExecutions() {
-    const now = Date.now();
-    const windowStart = now - this.getWindow();
-    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.getLimit() - 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.getWindow() - Date.now();
-  }
-  /**
-   * 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;
-  }
-  /**
-   * Returns whether the function is currently executing
-   */
-  getIsExecuting() {
-    return this._isExecuting;
-  }
-  /**
-   * Resets the rate limiter state
-   */
-  reset() {
-    this._executionTimes = [];
-    this._successCount = 0;
-    this._errorCount = 0;
-    this._rejectionCount = 0;
-    this._settleCount = 0;
-  }
+    };
+    this.#cleanupOldExecutions = () => {
+      const now = Date.now();
+      const windowStart = now - this.#getWindow();
+      this.#setState({
+        executionTimes: this.store.state.executionTimes.filter(
+          (time) => time > windowStart
+        )
+      });
+    };
+    this.getRemainingInWindow = () => {
+      const relevantExecutionTimes = this.#getRelevantExecutionTimes();
+      return Math.max(0, this.#getLimit() - relevantExecutionTimes.length);
+    };
+    this.getMsUntilNextWindow = () => {
+      if (this.getRemainingInWindow() > 0) {
+        return 0;
+      }
+      const oldestExecution = this.store.state.executionTimes[0] ?? Infinity;
+      return oldestExecution + this.#getWindow() - Date.now();
+    };
+    this.reset = () => {
+      this.#setState(getDefaultAsyncRateLimiterState());
+    };
+    this.options = {
+      ...defaultOptions,
+      ...initialOptions,
+      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError
+    };
+    this.#setState(this.options.initialState ?? {});
+  }
+  #setState;
+  #getEnabled;
+  #getLimit;
+  #getWindow;
+  #execute;
+  #getRelevantExecutionTimes;
+  #cleanupOldExecutions;
 }
 function asyncRateLimit(fn, initialOptions) {
   const rateLimiter = new AsyncRateLimiter(fn, initialOptions);
-  return rateLimiter.maybeExecute.bind(rateLimiter);
+  return rateLimiter.maybeExecute;
 }
 exports.AsyncRateLimiter = AsyncRateLimiter;
 exports.asyncRateLimit = asyncRateLimit;

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 { parseFunctionOrValue } from './utils'\nimport type { AnyAsyncFunction, OptionalKeys } 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   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean)\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a function that returns a number.\n   */\n  limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Optional error handler for when the rate-limited function throws.\n   * If provided, the handler will be called with the error and rate limiter instance.\n   * This can be used alongside throwOnError - the handler will be called before any error is thrown.\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   * Whether to throw errors when they occur.\n   * Defaults to true if no onError handler is provided, false if an onError handler is provided.\n   * Can be explicitly set to override these defaults.\n   */\n  throwOnError?: boolean\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a function that returns a number.\n   */\n  window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => 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\ntype AsyncRateLimiterOptionsWithOptionalCallbacks = OptionalKeys<\n  AsyncRateLimiterOptions<any>,\n  'onError' | 'onReject' | 'onSettled' | 'onSuccess'\n>\n\nconst defaultOptions: Omit<\n  AsyncRateLimiterOptionsWithOptionalCallbacks,\n  'limit' | 'window'\n> = {\n  enabled: true,\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 * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     },\n *     onReject: (limiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${limiter.getMsUntilNextWindow()}ms`);\n *     }\n *   }\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: AsyncRateLimiterOptionsWithOptionalCallbacks\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      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\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(): AsyncRateLimiterOptions<TFn> {\n    return this._options\n  }\n\n  /**\n   * Returns the current enabled state of the rate limiter\n   */\n  getEnabled(): boolean {\n    return !!parseFunctionOrValue(this._options.enabled, this)\n  }\n\n  /**\n   * Returns the current limit of executions allowed within the time window\n   */\n  getLimit(): number {\n    return parseFunctionOrValue(this._options.limit, this)\n  }\n\n  /**\n   * Returns the current time window in milliseconds\n   */\n  getWindow(): number {\n    return parseFunctionOrValue(this._options.window, this)\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   * Error Handling:\n   * - If the rate-limited function throws and no `onError` handler is configured,\n   *   the error will be thrown from this method.\n   * - If an `onError` handler is configured, errors will be caught and passed to the handler,\n   *   and this method will return undefined.\n   * - If the rate limit is exceeded, the execution will be rejected and the `onReject` handler\n   *   will be called if configured.\n   * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.\n   * - Rate limit rejections can be tracked using `getRejectionCount()`.\n   *\n   * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError\n   * @throws The error from the rate-limited function if no onError handler is configured\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    const limit = this.getLimit()\n    const window = this.getWindow()\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 < limit) {\n        await this.execute(...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 + window <= now\n\n      if (isNewWindow || this._executionTimes.length < limit) {\n        await this.execute(...args)\n        return this._lastResult\n      }\n    }\n\n    this.rejectFunction()\n    return undefined\n  }\n\n  private async execute(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this.getEnabled()) 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      if (this._options.throwOnError) {\n        throw error\n      } else {\n        console.error(error)\n      }\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.getWindow()\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.getLimit() - 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.getWindow() - 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 * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 *   onError: (error) => {\n *     console.error('API call failed:', error);\n *   },\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: AsyncRateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":["parseFunctionOrValue"],"mappings":";;;AAgEA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,YAAY;AACd;AAwDO,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,MACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;AAAA,IAC/D;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,WAAW,YAAyD;AAClE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAA2C;AACzC,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAO,CAAC,CAACA,MAAAA,qBAAqB,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,WAAmB;AACjB,WAAOA,MAAqB,qBAAA,KAAK,SAAS,OAAO,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvD,YAAoB;AAClB,WAAOA,MAAqB,qBAAA,KAAK,SAAS,QAAQ,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgCxD,MAAM,gBACD,MACmC;AACtC,SAAK,qBAAqB;AAEpB,UAAA,QAAQ,KAAK,SAAS;AACtB,UAAA,SAAS,KAAK,UAAU;AAE1B,QAAA,KAAK,SAAS,eAAe,WAAW;AAEtC,UAAA,KAAK,gBAAgB,SAAS,OAAO;AACjC,cAAA,KAAK,QAAQ,GAAG,IAAI;AAC1B,eAAO,KAAK;AAAA,MAAA;AAAA,IACd,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AAClD,YAAA,cAAc,kBAAkB,UAAU;AAEhD,UAAI,eAAe,KAAK,gBAAgB,SAAS,OAAO;AAChD,cAAA,KAAK,QAAQ,GAAG,IAAI;AAC1B,eAAO,KAAK;AAAA,MAAA;AAAA,IACd;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,WACT,MACmC;;AAClC,QAAA,CAAC,KAAK,aAAc;AACxB,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;AAC3B,UAAA,KAAK,SAAS,cAAc;AACxB,cAAA;AAAA,MAAA,OACD;AACL,gBAAQ,MAAM,KAAK;AAAA,MAAA;AAAA,IACrB,UACA;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,UAAU;AACpC,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,aAAa,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlE,uBAA+B;AACzB,QAAA,KAAK,qBAAqB,IAAI,GAAG;AAC5B,aAAA;AAAA,IAAA;AAET,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,UAAU,IAAI,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvD,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;AAuDgB,SAAA,eACd,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 { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport type { AnyAsyncFunction } from './types'\n\nexport interface AsyncRateLimiterState<TFn extends AnyAsyncFunction> {\n  /**\n   * Number of function executions that have resulted in errors\n   */\n  errorCount: number\n  /**\n   * Array of timestamps when executions occurred for rate limiting calculations\n   */\n  executionTimes: Array<number>\n  /**\n   * Whether the rate-limited function is currently executing asynchronously\n   */\n  isExecuting: boolean\n  /**\n   * The result from the most recent successful function execution\n   */\n  lastResult: ReturnType<TFn> | undefined\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: number\n  /**\n   * Number of function executions that have completed (either successfully or with errors)\n   */\n  settleCount: number\n  /**\n   * Number of function executions that have completed successfully\n   */\n  successCount: number\n}\n\nfunction getDefaultAsyncRateLimiterState<\n  TFn extends AnyAsyncFunction,\n>(): AsyncRateLimiterState<TFn> {\n  return {\n    errorCount: 0,\n    executionTimes: [],\n    isExecuting: false,\n    lastResult: undefined,\n    rejectionCount: 0,\n    settleCount: 0,\n    successCount: 0,\n  }\n}\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   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean)\n  /**\n   * Initial state for the rate limiter\n   */\n  initialState?: Partial<AsyncRateLimiterState<TFn>>\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a function that returns a number.\n   */\n  limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Optional error handler for when the rate-limited function throws.\n   * If provided, the handler will be called with the error and rate limiter instance.\n   * This can be used alongside throwOnError - the handler will be called before any error is thrown.\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   * Whether to throw errors when they occur.\n   * Defaults to true if no onError handler is provided, false if an onError handler is provided.\n   * Can be explicitly set to override these defaults.\n   */\n  throwOnError?: boolean\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a function that returns a number.\n   */\n  window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => 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: Omit<\n  Required<AsyncRateLimiterOptions<any>>,\n  'initialState' | 'onError' | 'onReject' | 'onSettled' | 'onSuccess'\n> = {\n  enabled: true,\n  limit: 1,\n  window: 0,\n  windowType: 'fixed',\n  throwOnError: true,\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - `initialState` can be a partial state object\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution times, success/error counts, and current execution status\n * - State can be accessed via `asyncRateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `asyncRateLimiter.state`\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     },\n *     onReject: (limiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${limiter.getMsUntilNextWindow()}ms`);\n *     }\n *   }\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  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>> = new Store<\n    AsyncRateLimiterState<TFn>\n  >(getDefaultAsyncRateLimiterState<TFn>())\n  options: AsyncRateLimiterOptions<TFn>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn>,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n    }\n    this.#setState(this.options.initialState ?? {})\n  }\n\n  /**\n   * Updates the async rate limiter options\n   */\n  setOptions = (newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<AsyncRateLimiterState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      return combinedState\n    })\n  }\n\n  /**\n   * Returns the current enabled state of the async rate limiter\n   */\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  /**\n   * Returns the current limit of executions allowed within the time window\n   */\n  #getLimit = (): number => {\n    return parseFunctionOrValue(this.options.limit, this)\n  }\n\n  /**\n   * Returns the current time window in milliseconds\n   */\n  #getWindow = (): number => {\n    return parseFunctionOrValue(this.options.window, this)\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   *\n   * Error Handling:\n   * - If the rate-limited function throws and no `onError` handler is configured,\n   *   the error will be thrown from this method.\n   * - If an `onError` handler is configured, errors will be caught and passed to the handler,\n   *   and this method will return undefined.\n   * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.\n   *\n   * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError\n   * @throws The error from the rate-limited function if no onError handler is configured\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return a promise that resolves with the result\n   * const result = await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will return undefined\n   * const result2 = await rateLimiter.maybeExecute('arg1', 'arg2'); // undefined\n   * ```\n   */\n  maybeExecute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    this.#cleanupOldExecutions()\n\n    const relevantExecutionTimes = this.#getRelevantExecutionTimes()\n\n    if (relevantExecutionTimes.length < this.#getLimit()) {\n      await this.#execute(...args)\n      return this.store.state.lastResult\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return undefined\n  }\n\n  #execute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    if (!this.#getEnabled()) return\n\n    const now = Date.now()\n    const executionTimes = [...this.store.state.executionTimes, now]\n    this.#setState({\n      isExecuting: true,\n      executionTimes,\n    })\n\n    try {\n      const result = await this.fn(...args)\n      this.#setState({\n        successCount: this.store.state.successCount + 1,\n        lastResult: result,\n      })\n      this.options.onSuccess?.(result, this)\n    } catch (error) {\n      this.#setState({\n        errorCount: this.store.state.errorCount + 1,\n      })\n      this.options.onError?.(error, this)\n      if (this.options.throwOnError) {\n        throw error\n      }\n    } finally {\n      this.#setState({\n        isExecuting: false,\n        settleCount: this.store.state.settleCount + 1,\n      })\n      this.options.onSettled?.(this)\n    }\n\n    return this.store.state.lastResult\n  }\n\n  #getRelevantExecutionTimes = (): Array<number> => {\n    if (this.options.windowType === 'sliding') {\n      // For sliding window, return all executions within the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time > Date.now() - this.#getWindow(),\n      )\n    } else {\n      // For fixed window, return all executions in the current window\n      // The window starts from the oldest execution time\n      const oldestExecution = Math.min(...this.store.state.executionTimes)\n      const windowStart = oldestExecution\n      return this.store.state.executionTimes.filter(\n        (time) =>\n          time >= windowStart && time <= windowStart + this.#getWindow(),\n      )\n    }\n  }\n\n  #cleanupOldExecutions = (): void => {\n    const now = Date.now()\n    const windowStart = now - this.#getWindow()\n    this.#setState({\n      executionTimes: this.store.state.executionTimes.filter(\n        (time) => time > windowStart,\n      ),\n    })\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow = (): number => {\n    const relevantExecutionTimes = this.#getRelevantExecutionTimes()\n    return Math.max(0, this.#getLimit() - relevantExecutionTimes.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 = this.store.state.executionTimes[0] ?? Infinity\n    return oldestExecution + this.#getWindow() - Date.now()\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset = (): void => {\n    this.#setState(getDefaultAsyncRateLimiterState())\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - `initialState` can be a partial state object\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution times, success/error counts, and current execution status\n * - State can be accessed via the underlying AsyncRateLimiter instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\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 * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 *   onError: (error) => {\n *     console.error('API call failed:', error);\n *   },\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: AsyncRateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute\n}\n"],"names":["Store","parseFunctionOrValue"],"mappings":";;;;AAmCA,SAAS,kCAEuB;AAC9B,SAAO;AAAA,IACL,YAAY;AAAA,IACZ,gBAAgB,CAAA;AAAA,IAChB,aAAa;AAAA,IACb,YAAY;AAAA,IACZ,gBAAgB;AAAA,IAChB,aAAa;AAAA,IACb,cAAc;AAAA,EAAA;AAElB;AA8DA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,YAAY;AAAA,EACZ,cAAc;AAChB;AAoEO,MAAM,iBAA+C;AAAA,EAM1D,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAS,QAAqD,IAAIA,MAAAA,MAEhE,gCAAA,CAAsC;AAkBxC,SAAA,aAAa,CAAC,eAA4D;AACxE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAAA,IAAW;AAGlD,SAAA,YAAY,CAAC,aAAwD;AACnE,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,eAAO;AAAA,MAAA,CACR;AAAA,IAAA;AAMH,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAACC,MAAAA,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAAA;AAM1D,SAAA,YAAY,MAAc;AACxB,aAAOA,MAAAA,qBAAqB,KAAK,QAAQ,OAAO,IAAI;AAAA,IAAA;AAMtD,SAAA,aAAa,MAAc;AACzB,aAAOA,MAAAA,qBAAqB,KAAK,QAAQ,QAAQ,IAAI;AAAA,IAAA;AA4BvD,SAAA,eAAe,UACV,SACsC;AACzC,WAAK,sBAAA;AAEL,YAAM,yBAAyB,KAAK,2BAAA;AAEpC,UAAI,uBAAuB,SAAS,KAAK,UAAA,GAAa;AACpD,cAAM,KAAK,SAAS,GAAG,IAAI;AAC3B,eAAO,KAAK,MAAM,MAAM;AAAA,MAAA;AAG1B,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,MAAA,CACnD;AACD,WAAK,QAAQ,WAAW,IAAI;AAC5B,aAAO;AAAA,IAAA;AAGT,SAAA,WAAW,UACN,SACsC;AACzC,UAAI,CAAC,KAAK,cAAe;AAEzB,YAAM,MAAM,KAAK,IAAA;AACjB,YAAM,iBAAiB,CAAC,GAAG,KAAK,MAAM,MAAM,gBAAgB,GAAG;AAC/D,WAAK,UAAU;AAAA,QACb,aAAa;AAAA,QACb;AAAA,MAAA,CACD;AAED,UAAI;AACF,cAAM,SAAS,MAAM,KAAK,GAAG,GAAG,IAAI;AACpC,aAAK,UAAU;AAAA,UACb,cAAc,KAAK,MAAM,MAAM,eAAe;AAAA,UAC9C,YAAY;AAAA,QAAA,CACb;AACD,aAAK,QAAQ,YAAY,QAAQ,IAAI;AAAA,MAAA,SAC9B,OAAO;AACd,aAAK,UAAU;AAAA,UACb,YAAY,KAAK,MAAM,MAAM,aAAa;AAAA,QAAA,CAC3C;AACD,aAAK,QAAQ,UAAU,OAAO,IAAI;AAClC,YAAI,KAAK,QAAQ,cAAc;AAC7B,gBAAM;AAAA,QAAA;AAAA,MACR,UACF;AACE,aAAK,UAAU;AAAA,UACb,aAAa;AAAA,UACb,aAAa,KAAK,MAAM,MAAM,cAAc;AAAA,QAAA,CAC7C;AACD,aAAK,QAAQ,YAAY,IAAI;AAAA,MAAA;AAG/B,aAAO,KAAK,MAAM,MAAM;AAAA,IAAA;AAG1B,SAAA,6BAA6B,MAAqB;AAChD,UAAI,KAAK,QAAQ,eAAe,WAAW;AAEzC,eAAO,KAAK,MAAM,MAAM,eAAe;AAAA,UACrC,CAAC,SAAS,OAAO,KAAK,IAAA,IAAQ,KAAK,WAAA;AAAA,QAAW;AAAA,MAChD,OACK;AAGL,cAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,cAAc;AACnE,cAAM,cAAc;AACpB,eAAO,KAAK,MAAM,MAAM,eAAe;AAAA,UACrC,CAAC,SACC,QAAQ,eAAe,QAAQ,cAAc,KAAK,WAAA;AAAA,QAAW;AAAA,MACjE;AAAA,IACF;AAGF,SAAA,wBAAwB,MAAY;AAClC,YAAM,MAAM,KAAK,IAAA;AACjB,YAAM,cAAc,MAAM,KAAK,WAAA;AAC/B,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,eAAe;AAAA,UAC9C,CAAC,SAAS,OAAO;AAAA,QAAA;AAAA,MACnB,CACD;AAAA,IAAA;AAMH,SAAA,uBAAuB,MAAc;AACnC,YAAM,yBAAyB,KAAK,2BAAA;AACpC,aAAO,KAAK,IAAI,GAAG,KAAK,UAAA,IAAc,uBAAuB,MAAM;AAAA,IAAA;AAQrE,SAAA,uBAAuB,MAAc;AACnC,UAAI,KAAK,qBAAA,IAAyB,GAAG;AACnC,eAAO;AAAA,MAAA;AAET,YAAM,kBAAkB,KAAK,MAAM,MAAM,eAAe,CAAC,KAAK;AAC9D,aAAO,kBAAkB,KAAK,WAAA,IAAe,KAAK,IAAA;AAAA,IAAI;AAMxD,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,iCAAiC;AAAA,IAAA;AArLhD,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,MACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;AAAA,IAAA;AAE/D,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAAA,EAAA;AAAA,EAUhD;AAAA,EAaA;AAAA,EAOA;AAAA,EAOA;AAAA,EAgDA;AAAA,EAsCA;AAAA,EAkBA;AAqCF;AAmEO,SAAS,eACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AAC3D,SAAO,YAAY;AACrB;;;"}

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

@@ -1,4 +1,35 @@
+import { Store } from '@tanstack/store';
 import { AnyAsyncFunction } from './types.cjs';
+export interface AsyncRateLimiterState<TFn extends AnyAsyncFunction> {
+    /**
+     * Number of function executions that have resulted in errors
+     */
+    errorCount: number;
+    /**
+     * Array of timestamps when executions occurred for rate limiting calculations
+     */
+    executionTimes: Array<number>;
+    /**
+     * Whether the rate-limited function is currently executing asynchronously
+     */
+    isExecuting: boolean;
+    /**
+     * The result from the most recent successful function execution
+     */
+    lastResult: ReturnType<TFn> | undefined;
+    /**
+     * Number of function executions that have been rejected due to rate limiting
+     */
+    rejectionCount: number;
+    /**
+     * Number of function executions that have completed (either successfully or with errors)
+     */
+    settleCount: number;
+    /**
+     * Number of function executions that have completed successfully
+     */
+    successCount: number;
+}
 /**
  * Options for configuring an async rate-limited function
  */
@@ -9,6 +40,10 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
      * Defaults to true.
      */
     enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean);
+    /**
+     * Initial state for the rate limiter
+     */
+    initialState?: Partial<AsyncRateLimiterState<TFn>>;
     /**
      * Maximum number of executions allowed within the time window.
      * Can be a number or a function that returns a number.
@@ -75,6 +110,18 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
  * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
  * smoothing out frequent events, throttling or debouncing usually provide better user experience.
  *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the rate limiter
+ * - `initialState` can be a partial state object
+ * - Use `onSuccess` callback to react to successful function execution and implement custom logic
+ * - Use `onError` callback to react to function execution errors and implement custom error handling
+ * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
+ * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
+ * - The state includes execution times, success/error counts, and current execution status
+ * - State can be accessed via `asyncRateLimiter.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `asyncRateLimiter.state`
+ *
  * Error Handling:
  * - If an `onError` handler is provided, it will be called with the error and rate limiter instance
  * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
@@ -106,50 +153,25 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
  * ```
  */
 export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
+    #private;
     private fn;
-    private _options;
-    private _errorCount;
-    private _executionTimes;
-    private _lastResult;
-    private _rejectionCount;
-    private _settleCount;
-    private _successCount;
-    private _isExecuting;
+    readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
+    options: AsyncRateLimiterOptions<TFn>;
     constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>);
     /**
-     * Updates the rate limiter options
+     * Updates the async rate limiter options
      */
-    setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void;
-    /**
-     * Returns the current rate limiter options
-     */
-    getOptions(): AsyncRateLimiterOptions<TFn>;
-    /**
-     * Returns the current enabled state of the rate limiter
-     */
-    getEnabled(): boolean;
-    /**
-     * Returns the current limit of executions allowed within the time window
-     */
-    getLimit(): number;
-    /**
-     * Returns the current time window in milliseconds
-     */
-    getWindow(): number;
+    setOptions: (newOptions: Partial<AsyncRateLimiterOptions<TFn>>) => void;
     /**
      * 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.
-     * If execution is allowed, waits for any previous execution to complete before proceeding.
      *
      * Error Handling:
      * - If the rate-limited function throws and no `onError` handler is configured,
      *   the error will be thrown from this method.
      * - If an `onError` handler is configured, errors will be caught and passed to the handler,
      *   and this method will return undefined.
-     * - If the rate limit is exceeded, the execution will be rejected and the `onReject` handler
-     *   will be called if configured.
      * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.
-     * - Rate limit rejections can be tracked using `getRejectionCount()`.
      *
      * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
      * @throws The error from the rate-limited function if no onError handler is configured
@@ -158,51 +180,28 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
      * ```ts
      * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });
      *
-     * // First 5 calls will execute
-     * await rateLimiter.maybeExecute('arg1', 'arg2');
+     * // First 5 calls will return a promise that resolves with the result
+     * const result = await rateLimiter.maybeExecute('arg1', 'arg2');
      *
-     * // Additional calls within the window will be rejected
-     * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected
+     * // Additional calls within the window will return undefined
+     * const result2 = await rateLimiter.maybeExecute('arg1', 'arg2'); // undefined
      * ```
      */
-    maybeExecute(...args: Parameters<TFn>): Promise<ReturnType<TFn> | undefined>;
-    private execute;
-    private rejectFunction;
-    private cleanupOldExecutions;
+    maybeExecute: (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
     /**
      * Returns the number of remaining executions allowed in the current window
      */
-    getRemainingInWindow(): number;
+    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
-     */
-    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;
-    /**
-     * Returns whether the function is currently executing
-     */
-    getIsExecuting(): boolean;
+    getMsUntilNextWindow: () => number;
     /**
      * Resets the rate limiter state
      */
-    reset(): void;
+    reset: () => void;
 }
 /**
  * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.
@@ -222,6 +221,18 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
  * - A throttler ensures even spacing between executions, which can be better for consistent performance
  * - A debouncer collapses multiple calls into one, which is better for handling bursts of events
  *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the rate limiter
+ * - `initialState` can be a partial state object
+ * - Use `onSuccess` callback to react to successful function execution and implement custom logic
+ * - Use `onError` callback to react to function execution errors and implement custom error handling
+ * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
+ * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
+ * - The state includes execution times, success/error counts, and current execution status
+ * - State can be accessed via the underlying AsyncRateLimiter instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
  * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically
  * need to enforce a hard limit on the number of executions within a time period.
  *