@tanstack/pacer 0.4.0 → 0.6.0

package/dist/cjs/rate-limiter.cjs

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const utils = require("./utils.cjs");
 const defaultOptions = {
   enabled: true,
   limit: 1,
@@ -34,6 +35,24 @@ class RateLimiter {
   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.
@@ -52,15 +71,15 @@ class RateLimiter {
   maybeExecute(...args) {
     this.cleanupOldExecutions();
     if (this._options.windowType === "sliding") {
-      if (this._executionTimes.length < this._options.limit) {
+      if (this._executionTimes.length < this.getLimit()) {
         this.executeFunction(...args);
         return true;
       }
     } else {
       const now = Date.now();
       const oldestExecution = Math.min(...this._executionTimes);
-      const isNewWindow = oldestExecution + this._options.window <= now;
-      if (isNewWindow || this._executionTimes.length < this._options.limit) {
+      const isNewWindow = oldestExecution + this.getWindow() <= now;
+      if (isNewWindow || this._executionTimes.length < this.getLimit()) {
         this.executeFunction(...args);
         return true;
       }
@@ -70,7 +89,7 @@ class RateLimiter {
   }
   executeFunction(...args) {
     var _a, _b;
-    if (!this._options.enabled) return;
+    if (!this.getEnabled()) return;
     const now = Date.now();
     this._executionCount++;
     this._executionTimes.push(now);
@@ -85,7 +104,7 @@ class RateLimiter {
   }
   cleanupOldExecutions() {
     const now = Date.now();
-    const windowStart = now - this._options.window;
+    const windowStart = now - this.getWindow();
     this._executionTimes = this._executionTimes.filter(
       (time) => time > windowStart
     );
@@ -107,7 +126,7 @@ class RateLimiter {
    */
   getRemainingInWindow() {
     this.cleanupOldExecutions();
-    return Math.max(0, this._options.limit - this._executionTimes.length);
+    return Math.max(0, this.getLimit() - this._executionTimes.length);
   }
   /**
    * Returns the number of milliseconds until the next execution will be possible
@@ -117,7 +136,7 @@ class RateLimiter {
       return 0;
     }
     const oldestExecution = Math.min(...this._executionTimes);
-    return oldestExecution + this._options.window - Date.now();
+    return oldestExecution + this.getWindow() - Date.now();
   }
   /**
    * Resets the rate limiter state

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

@@ -1 +1 @@
-{"version":3,"file":"rate-limiter.cjs","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import type { AnyFunction } from './types'\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\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   * Callback function that is called after the function is executed\n   */\n  onExecute?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\nconst defaultOptions: Required<RateLimiterOptions<any>> = {\n  enabled: true,\n  limit: 1,\n  onExecute: () => {},\n  onReject: () => {},\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a 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 * 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 RateLimiter(\n *   (id: string) => api.getData(id),\n *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _executionTimes: Array<number> = []\n  private _options: RateLimiterOptions<TFn>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<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<RateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<RateLimiterOptions<TFn>> {\n    return this._options as Required<RateLimiterOptions<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   *\n   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute(...args: Parameters<TFn>): boolean {\n    this.cleanupOldExecutions()\n\n    if (this._options.windowType === 'sliding') {\n      // For sliding window, we can execute if we have capacity in the current window\n      if (this._executionTimes.length < this._options.limit) {\n        this.executeFunction(...args)\n        return true\n      }\n    } else {\n      // For fixed window, we need to check if we're in a new window\n      const now = Date.now()\n      const oldestExecution = Math.min(...this._executionTimes)\n      const isNewWindow = oldestExecution + this._options.window <= now\n\n      if (isNewWindow || this._executionTimes.length < this._options.limit) {\n        this.executeFunction(...args)\n        return true\n      }\n    }\n\n    this.rejectFunction()\n    return false\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this._options.enabled) return\n    const now = Date.now()\n    this._executionCount++\n    this._executionTimes.push(now)\n    this.fn(...args) // execute the function\n    this._options.onExecute?.(this)\n  }\n\n  private rejectFunction(): void {\n    this._rejectionCount++\n    if (this._options.onReject) {\n      this._options.onReject(this)\n    }\n  }\n\n  private cleanupOldExecutions(): void {\n    const now = Date.now()\n    const windowStart = now - this._options.window\n    this._executionTimes = this._executionTimes.filter(\n      (time) => time > windowStart,\n    )\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this._executionCount\n  }\n\n  /**\n   * Returns the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow(): number {\n    this.cleanupOldExecutions()\n    return Math.max(0, this._options.limit - this._executionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   */\n  getMsUntilNextWindow(): number {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = Math.min(...this._executionTimes)\n    return oldestExecution + this._options.window - Date.now()\n  }\n\n  /**\n   * 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 a 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 * 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 * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: Omit<RateLimiterOptions<TFn>, 'enabled'>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":";;AAoCA,MAAM,iBAAoD;AAAA,EACxD,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,QAAQ;AAAA,EACR,YAAY;AACd;AAiCO,MAAM,YAAqC;AAAA,EAMhD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiC,CAAC;AAOxC,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAoD;AAC7D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAgD;AAC9C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBd,gBAAgB,MAAgC;AAC9C,SAAK,qBAAqB;AAEtB,QAAA,KAAK,SAAS,eAAe,WAAW;AAE1C,UAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAChD,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,YAAM,cAAc,kBAAkB,KAAK,SAAS,UAAU;AAE9D,UAAI,eAAe,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC/D,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGD,mBAAmB,MAA6B;;AAClD,QAAA,CAAC,KAAK,SAAS,QAAS;AACtB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,gBAAgB,KAAK,GAAG;AACxB,SAAA,GAAG,GAAG,IAAI;AACV,qBAAA,UAAS,cAAT,4BAAqB;AAAA,EAAI;AAAA,EAGxB,iBAAuB;AACxB,SAAA;AACD,QAAA,KAAK,SAAS,UAAU;AACrB,WAAA,SAAS,SAAS,IAAI;AAAA,IAAA;AAAA,EAC7B;AAAA,EAGM,uBAA6B;AAC7B,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,cAAc,MAAM,KAAK,SAAS;AACnC,SAAA,kBAAkB,KAAK,gBAAgB;AAAA,MAC1C,CAAC,SAAS,OAAO;AAAA,IACnB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,SAAS,QAAQ,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtE,uBAA+B;AACzB,QAAA,KAAK,qBAAqB,IAAI,GAAG;AAC5B,aAAA;AAAA,IAAA;AAET,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,SAAS,SAAS,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,kBAAkB;AACvB,SAAK,kBAAkB;AAAA,EAAA;AAE3B;AAuCgB,SAAA,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AAC/C,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;;;"}
+{"version":3,"file":"rate-limiter.cjs","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean)\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  limit: number | ((rateLimiter: RateLimiter<TFn>) => number)\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  window: number | ((rateLimiter: RateLimiter<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: Required<RateLimiterOptions<any>> = {\n  enabled: true,\n  limit: 1,\n  onExecute: () => {},\n  onReject: () => {},\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a 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 * 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 RateLimiter(\n *   (id: string) => api.getData(id),\n *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _executionTimes: Array<number> = []\n  private _options: RateLimiterOptions<TFn>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<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<RateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<RateLimiterOptions<TFn>> {\n    return this._options as Required<RateLimiterOptions<TFn>>\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   *\n   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute(...args: Parameters<TFn>): boolean {\n    this.cleanupOldExecutions()\n\n    if (this._options.windowType === 'sliding') {\n      // For sliding window, we can execute if we have capacity in the current window\n      if (this._executionTimes.length < this.getLimit()) {\n        this.executeFunction(...args)\n        return true\n      }\n    } else {\n      // For fixed window, we need to check if we're in a new window\n      const now = Date.now()\n      const oldestExecution = Math.min(...this._executionTimes)\n      const isNewWindow = oldestExecution + this.getWindow() <= now\n\n      if (isNewWindow || this._executionTimes.length < this.getLimit()) {\n        this.executeFunction(...args)\n        return true\n      }\n    }\n\n    this.rejectFunction()\n    return false\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this.getEnabled()) return\n    const now = Date.now()\n    this._executionCount++\n    this._executionTimes.push(now)\n    this.fn(...args) // execute the function\n    this._options.onExecute?.(this)\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 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.getLimit() - this._executionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\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   * 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 a 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 * 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 * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":["parseFunctionOrValue"],"mappings":";;;AAuCA,MAAM,iBAAoD;AAAA,EACxD,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,QAAQ;AAAA,EACR,YAAY;AACd;AAiCO,MAAM,YAAqC;AAAA,EAMhD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiC,CAAC;AAOxC,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAoD;AAC7D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAgD;AAC9C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAOA,MAAqB,qBAAA,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,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,EAkBxD,gBAAgB,MAAgC;AAC9C,SAAK,qBAAqB;AAEtB,QAAA,KAAK,SAAS,eAAe,WAAW;AAE1C,UAAI,KAAK,gBAAgB,SAAS,KAAK,YAAY;AAC5C,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,YAAM,cAAc,kBAAkB,KAAK,UAAe,KAAA;AAE1D,UAAI,eAAe,KAAK,gBAAgB,SAAS,KAAK,YAAY;AAC3D,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGD,mBAAmB,MAA6B;;AAClD,QAAA,CAAC,KAAK,aAAc;AAClB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,gBAAgB,KAAK,GAAG;AACxB,SAAA,GAAG,GAAG,IAAI;AACV,qBAAA,UAAS,cAAT,4BAAqB;AAAA,EAAI;AAAA,EAGxB,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,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,aAAa,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMlE,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,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,kBAAkB;AACvB,SAAK,kBAAkB;AAAA,EAAA;AAE3B;AAuCgB,SAAA,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AAC/C,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;;;"}

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

@@ -7,11 +7,12 @@ export interface RateLimiterOptions<TFn extends AnyFunction> {
      * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean);
     /**
-     * Maximum number of executions allowed within the time window
+     * Maximum number of executions allowed within the time window.
+     * Can be a number or a callback function that receives the rate limiter instance and returns a number.
      */
-    limit: number;
+    limit: number | ((rateLimiter: RateLimiter<TFn>) => number);
     /**
      * Callback function that is called after the function is executed
      */
@@ -21,9 +22,10 @@ export interface RateLimiterOptions<TFn extends AnyFunction> {
      */
     onReject?: (rateLimiter: RateLimiter<TFn>) => void;
     /**
-     * Time window in milliseconds within which the limit applies
+     * Time window in milliseconds within which the limit applies.
+     * Can be a number or a callback function that receives the rate limiter instance and returns a number.
      */
-    window: number;
+    window: number | ((rateLimiter: RateLimiter<TFn>) => number);
     /**
      * Type of window to use for rate limiting
      * - 'fixed': Uses a fixed window that resets after the window period
@@ -79,6 +81,18 @@ export declare class RateLimiter<TFn extends AnyFunction> {
      * Returns the current rate limiter options
      */
     getOptions(): Required<RateLimiterOptions<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;
     /**
      * 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.
@@ -156,4 +170,4 @@ export declare class RateLimiter<TFn extends AnyFunction> {
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<RateLimiterOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => boolean;
+export declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: RateLimiterOptions<TFn>): (...args: Parameters<TFn>) => boolean;

package/dist/cjs/throttler.cjs

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const utils = require("./utils.cjs");
 const defaultOptions = {
   enabled: true,
   leading: true,
@@ -34,6 +35,18 @@ class Throttler {
   getOptions() {
     return this._options;
   }
+  /**
+   * Returns the current enabled state of the throttler
+   */
+  getEnabled() {
+    return utils.parseFunctionOrValue(this._options.enabled, this);
+  }
+  /**
+   * Returns the current wait time in milliseconds
+   */
+  getWait() {
+    return utils.parseFunctionOrValue(this._options.wait, this);
+  }
   /**
    * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
    *
@@ -59,13 +72,14 @@ class Throttler {
   maybeExecute(...args) {
     const now = Date.now();
     const timeSinceLastExecution = now - this._lastExecutionTime;
-    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {
+    const wait = this.getWait();
+    if (this._options.leading && timeSinceLastExecution >= wait) {
       this.executeFunction(...args);
     } else {
       this._lastArgs = args;
       if (!this._timeoutId && this._options.trailing) {
         const _timeSinceLastExecution = this._lastExecutionTime ? now - this._lastExecutionTime : 0;
-        const timeoutDuration = this._options.wait - _timeSinceLastExecution;
+        const timeoutDuration = wait - _timeSinceLastExecution;
         this._timeoutId = setTimeout(() => {
           if (this._lastArgs !== void 0) {
             this.executeFunction(...this._lastArgs);
@@ -75,7 +89,7 @@ class Throttler {
     }
   }
   executeFunction(...args) {
-    if (!this._options.enabled) return;
+    if (!this.getEnabled()) return;
     this.fn(...args);
     this._executionCount++;
     this._lastExecutionTime = Date.now();
@@ -109,7 +123,7 @@ class Throttler {
    * Returns the next execution time
    */
   getNextExecutionTime() {
-    return this._lastExecutionTime + this._options.wait;
+    return this._lastExecutionTime + this.getWait();
   }
   /**
    * Returns the number of times the function has been executed
@@ -121,7 +135,7 @@ class Throttler {
    * Returns `true` if there is a pending execution
    */
   getIsPending() {
-    return this._options.enabled && !!this._timeoutId;
+    return this.getEnabled() && !!this._timeoutId;
   }
 }
 function throttle(fn, initialOptions) {

package/dist/cjs/throttler.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.cjs","sources":["../../src/throttler.ts"],"sourcesContent":["import type { AnyFunction } from './types'\n\n/**\n * Options for configuring a throttled function\n */\nexport interface ThrottlerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * Defaults to true.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (throttler: Throttler<TFn>) => void\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once\n   */\n  wait: number\n}\n\nconst defaultOptions: Required<ThrottlerOptions<any>> = {\n  enabled: true,\n  leading: true,\n  onExecute: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a throttled function.\n *\n * Throttling ensures a function is called at most once within a specified time window.\n * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent\n * execution timing regardless of call frequency.\n *\n * Supports both leading and trailing edge execution:\n * - Leading: Execute immediately on first call (default: true)\n * - Trailing: Execute after wait period if called during throttle (default: true)\n *\n * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.\n *\n * @example\n * ```ts\n * const throttler = new Throttler(\n *   (id: string) => api.getData(id),\n *   { wait: 1000 } // Execute at most once per second\n * );\n *\n * // First call executes immediately\n * throttler.maybeExecute('123');\n *\n * // Subsequent calls within 1000ms are throttled\n * throttler.maybeExecute('123'); // Throttled\n * ```\n */\nexport class Throttler<TFn extends AnyFunction> {\n  private _executionCount = 0\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastExecutionTime = 0\n  private _options: Required<ThrottlerOptions<TFn>>\n  private _timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    private fn: TFn,\n    initialOptions: ThrottlerOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<ThrottlerOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n\n    // End the pending state if the debouncer is disabled\n    if (!this._options.enabled) {\n      this.cancel()\n    }\n  }\n\n  /**\n   * Returns the current throttler options\n   */\n  getOptions(): Required<ThrottlerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:\n   *\n   * - If enough time has passed since the last execution (>= wait period):\n   *   - With leading=true: Executes immediately\n   *   - With leading=false: Waits for the next trailing execution\n   *\n   * - If within the wait period:\n   *   - With trailing=true: Schedules execution for end of wait period\n   *   - With trailing=false: Drops the execution\n   *\n   * @example\n   * ```ts\n   * const throttled = new Throttler(fn, { wait: 1000 });\n   *\n   * // First call executes immediately\n   * throttled.maybeExecute('a', 'b');\n   *\n   * // Call during wait period - gets throttled\n   * throttled.maybeExecute('c', 'd');\n   * ```\n   */\n  maybeExecute(...args: Parameters<TFn>): void {\n    const now = Date.now()\n    const timeSinceLastExecution = now - this._lastExecutionTime\n\n    // Handle leading execution\n    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {\n      this.executeFunction(...args)\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this._lastArgs = args\n\n      // Set up trailing execution if not already scheduled\n      if (!this._timeoutId && this._options.trailing) {\n        const _timeSinceLastExecution = this._lastExecutionTime\n          ? now - this._lastExecutionTime\n          : 0\n        const timeoutDuration = this._options.wait - _timeSinceLastExecution\n        this._timeoutId = setTimeout(() => {\n          if (this._lastArgs !== undefined) {\n            this.executeFunction(...this._lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this._options.enabled) return\n    this.fn(...args) // EXECUTE!\n    this._executionCount++\n    this._lastExecutionTime = Date.now()\n    this._timeoutId = undefined\n    this._lastArgs = undefined\n    this._options.onExecute(this)\n  }\n\n  /**\n   * Cancels any pending trailing execution and clears internal state.\n   *\n   * If a trailing execution is scheduled (due to throttling with trailing=true),\n   * this will prevent that execution from occurring. The internal timeout and\n   * stored arguments will be cleared.\n   *\n   * Has no effect if there is no pending execution.\n   */\n  cancel(): void {\n    if (this._timeoutId) {\n      clearTimeout(this._timeoutId)\n      this._timeoutId = undefined\n      this._lastArgs = undefined\n    }\n  }\n\n  /**\n   * Returns the last execution time\n   */\n  getLastExecutionTime(): number {\n    return this._lastExecutionTime\n  }\n\n  /**\n   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this._lastExecutionTime + this._options.wait\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 `true` if there is a pending execution\n   */\n  getIsPending(): boolean {\n    return this._options.enabled && !!this._timeoutId\n  }\n}\n\n/**\n * Creates a throttled function that limits how often the provided function can execute.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * The throttled function can be configured to execute on the leading and/or trailing\n * edge of the throttle window via options.\n *\n * For handling bursts of events, consider using debounce() instead. For hard execution\n * limits, consider using rateLimit().\n *\n * @example\n * ```ts\n * // Basic throttling - max once per second\n * const throttled = throttle(updateUI, { wait: 1000 });\n *\n * // Configure leading/trailing execution\n * const throttled = throttle(saveData, {\n *   wait: 2000,\n *   leading: true,  // Execute immediately on first call\n *   trailing: true  // Execute again after delay if called during wait\n * });\n * ```\n */\nexport function throttle<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: Omit<ThrottlerOptions<TFn>, 'enabled'>,\n) {\n  const throttler = new Throttler(fn, initialOptions)\n  return throttler.maybeExecute.bind(throttler)\n}\n"],"names":[],"mappings":";;AA+BA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AA6BO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAQ,kBAAkB;AAE1B,SAAQ,qBAAqB;AAQ3B,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAkD;AAC3D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,OAAO;AAAA,IAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAMF,aAA8C;AAC5C,WAAO,KAAK;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,EAyBd,gBAAgB,MAA6B;AACrC,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,yBAAyB,MAAM,KAAK;AAG1C,QAAI,KAAK,SAAS,WAAW,0BAA0B,KAAK,SAAS,MAAM;AACpE,WAAA,gBAAgB,GAAG,IAAI;AAAA,IAAA,OACvB;AAEL,WAAK,YAAY;AAGjB,UAAI,CAAC,KAAK,cAAc,KAAK,SAAS,UAAU;AAC9C,cAAM,0BAA0B,KAAK,qBACjC,MAAM,KAAK,qBACX;AACE,cAAA,kBAAkB,KAAK,SAAS,OAAO;AACxC,aAAA,aAAa,WAAW,MAAM;AAC7B,cAAA,KAAK,cAAc,QAAW;AAC3B,iBAAA,gBAAgB,GAAG,KAAK,SAAS;AAAA,UAAA;AAAA,WAEvC,eAAe;AAAA,MAAA;AAAA,IACpB;AAAA,EACF;AAAA,EAGM,mBAAmB,MAA6B;AAClD,QAAA,CAAC,KAAK,SAAS,QAAS;AACvB,SAAA,GAAG,GAAG,IAAI;AACV,SAAA;AACA,SAAA,qBAAqB,KAAK,IAAI;AACnC,SAAK,aAAa;AAClB,SAAK,YAAY;AACZ,SAAA,SAAS,UAAU,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,aAAa;AAClB,WAAK,YAAY;AAAA,IAAA;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA,EAMF,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AACtB,WAAA,KAAK,qBAAqB,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMjD,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK,SAAS,WAAW,CAAC,CAAC,KAAK;AAAA,EAAA;AAE3C;AA4BgB,SAAA,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAC3C,SAAA,UAAU,aAAa,KAAK,SAAS;AAC9C;;;"}
+{"version":3,"file":"throttler.cjs","sources":["../../src/throttler.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\n/**\n * Options for configuring a throttled function\n */\nexport interface ThrottlerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the throttler 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 | ((throttler: Throttler<TFn>) => boolean)\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * Defaults to true.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (throttler: Throttler<TFn>) => void\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((throttler: Throttler<TFn>) => number)\n}\n\nconst defaultOptions: Required<ThrottlerOptions<any>> = {\n  enabled: true,\n  leading: true,\n  onExecute: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a throttled function.\n *\n * Throttling ensures a function is called at most once within a specified time window.\n * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent\n * execution timing regardless of call frequency.\n *\n * Supports both leading and trailing edge execution:\n * - Leading: Execute immediately on first call (default: true)\n * - Trailing: Execute after wait period if called during throttle (default: true)\n *\n * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.\n *\n * @example\n * ```ts\n * const throttler = new Throttler(\n *   (id: string) => api.getData(id),\n *   { wait: 1000 } // Execute at most once per second\n * );\n *\n * // First call executes immediately\n * throttler.maybeExecute('123');\n *\n * // Subsequent calls within 1000ms are throttled\n * throttler.maybeExecute('123'); // Throttled\n * ```\n */\nexport class Throttler<TFn extends AnyFunction> {\n  private _executionCount = 0\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastExecutionTime = 0\n  private _options: Required<ThrottlerOptions<TFn>>\n  private _timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    private fn: TFn,\n    initialOptions: ThrottlerOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<ThrottlerOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n\n    // End the pending state if the debouncer is disabled\n    if (!this._options.enabled) {\n      this.cancel()\n    }\n  }\n\n  /**\n   * Returns the current throttler options\n   */\n  getOptions(): Required<ThrottlerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Returns the current enabled state of the throttler\n   */\n  getEnabled(): boolean {\n    return parseFunctionOrValue(this._options.enabled, this)\n  }\n\n  /**\n   * Returns the current wait time in milliseconds\n   */\n  getWait(): number {\n    return parseFunctionOrValue(this._options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:\n   *\n   * - If enough time has passed since the last execution (>= wait period):\n   *   - With leading=true: Executes immediately\n   *   - With leading=false: Waits for the next trailing execution\n   *\n   * - If within the wait period:\n   *   - With trailing=true: Schedules execution for end of wait period\n   *   - With trailing=false: Drops the execution\n   *\n   * @example\n   * ```ts\n   * const throttled = new Throttler(fn, { wait: 1000 });\n   *\n   * // First call executes immediately\n   * throttled.maybeExecute('a', 'b');\n   *\n   * // Call during wait period - gets throttled\n   * throttled.maybeExecute('c', 'd');\n   * ```\n   */\n  maybeExecute(...args: Parameters<TFn>): void {\n    const now = Date.now()\n    const timeSinceLastExecution = now - this._lastExecutionTime\n    const wait = this.getWait()\n\n    // Handle leading execution\n    if (this._options.leading && timeSinceLastExecution >= wait) {\n      this.executeFunction(...args)\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this._lastArgs = args\n\n      // Set up trailing execution if not already scheduled\n      if (!this._timeoutId && this._options.trailing) {\n        const _timeSinceLastExecution = this._lastExecutionTime\n          ? now - this._lastExecutionTime\n          : 0\n        const timeoutDuration = wait - _timeSinceLastExecution\n        this._timeoutId = setTimeout(() => {\n          if (this._lastArgs !== undefined) {\n            this.executeFunction(...this._lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this.getEnabled()) return\n    this.fn(...args) // EXECUTE!\n    this._executionCount++\n    this._lastExecutionTime = Date.now()\n    this._timeoutId = undefined\n    this._lastArgs = undefined\n    this._options.onExecute(this)\n  }\n\n  /**\n   * Cancels any pending trailing execution and clears internal state.\n   *\n   * If a trailing execution is scheduled (due to throttling with trailing=true),\n   * this will prevent that execution from occurring. The internal timeout and\n   * stored arguments will be cleared.\n   *\n   * Has no effect if there is no pending execution.\n   */\n  cancel(): void {\n    if (this._timeoutId) {\n      clearTimeout(this._timeoutId)\n      this._timeoutId = undefined\n      this._lastArgs = undefined\n    }\n  }\n\n  /**\n   * Returns the last execution time\n   */\n  getLastExecutionTime(): number {\n    return this._lastExecutionTime\n  }\n\n  /**\n   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this._lastExecutionTime + this.getWait()\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 `true` if there is a pending execution\n   */\n  getIsPending(): boolean {\n    return this.getEnabled() && !!this._timeoutId\n  }\n}\n\n/**\n * Creates a throttled function that limits how often the provided function can execute.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * The throttled function can be configured to execute on the leading and/or trailing\n * edge of the throttle window via options.\n *\n * For handling bursts of events, consider using debounce() instead. For hard execution\n * limits, consider using rateLimit().\n *\n * @example\n * ```ts\n * // Basic throttling - max once per second\n * const throttled = throttle(updateUI, { wait: 1000 });\n *\n * // Configure leading/trailing execution\n * const throttled = throttle(saveData, {\n *   wait: 2000,\n *   leading: true,  // Execute immediately on first call\n *   trailing: true  // Execute again after delay if called during wait\n * });\n * ```\n */\nexport function throttle<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: ThrottlerOptions<TFn>,\n) {\n  const throttler = new Throttler(fn, initialOptions)\n  return throttler.maybeExecute.bind(throttler)\n}\n"],"names":["parseFunctionOrValue"],"mappings":";;;AAmCA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AA6BO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAQ,kBAAkB;AAE1B,SAAQ,qBAAqB;AAQ3B,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAkD;AAC3D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,OAAO;AAAA,IAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAMF,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAOA,MAAqB,qBAAA,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,UAAkB;AAChB,WAAOA,MAAqB,qBAAA,KAAK,SAAS,MAAM,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,EAyBtD,gBAAgB,MAA6B;AACrC,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,yBAAyB,MAAM,KAAK;AACpC,UAAA,OAAO,KAAK,QAAQ;AAG1B,QAAI,KAAK,SAAS,WAAW,0BAA0B,MAAM;AACtD,WAAA,gBAAgB,GAAG,IAAI;AAAA,IAAA,OACvB;AAEL,WAAK,YAAY;AAGjB,UAAI,CAAC,KAAK,cAAc,KAAK,SAAS,UAAU;AAC9C,cAAM,0BAA0B,KAAK,qBACjC,MAAM,KAAK,qBACX;AACJ,cAAM,kBAAkB,OAAO;AAC1B,aAAA,aAAa,WAAW,MAAM;AAC7B,cAAA,KAAK,cAAc,QAAW;AAC3B,iBAAA,gBAAgB,GAAG,KAAK,SAAS;AAAA,UAAA;AAAA,WAEvC,eAAe;AAAA,MAAA;AAAA,IACpB;AAAA,EACF;AAAA,EAGM,mBAAmB,MAA6B;AAClD,QAAA,CAAC,KAAK,aAAc;AACnB,SAAA,GAAG,GAAG,IAAI;AACV,SAAA;AACA,SAAA,qBAAqB,KAAK,IAAI;AACnC,SAAK,aAAa;AAClB,SAAK,YAAY;AACZ,SAAA,SAAS,UAAU,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,aAAa;AAClB,WAAK,YAAY;AAAA,IAAA;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA,EAMF,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AACtB,WAAA,KAAK,qBAAqB,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhD,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK,WAAA,KAAgB,CAAC,CAAC,KAAK;AAAA,EAAA;AAEvC;AA4BgB,SAAA,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAC3C,SAAA,UAAU,aAAa,KAAK,SAAS;AAC9C;;;"}

package/dist/cjs/throttler.d.cts

@@ -5,9 +5,10 @@ import { AnyFunction } from './types.cjs';
 export interface ThrottlerOptions<TFn extends AnyFunction> {
     /**
      * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Can be a boolean or a function that returns a boolean.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((throttler: Throttler<TFn>) => boolean);
     /**
      * Whether to execute on the leading edge of the timeout.
      * Defaults to true.
@@ -23,9 +24,11 @@ export interface ThrottlerOptions<TFn extends AnyFunction> {
      */
     trailing?: boolean;
     /**
-     * Time window in milliseconds during which the function can only be executed once
+     * Time window in milliseconds during which the function can only be executed once.
+     * Can be a number or a function that returns a number.
+     * Defaults to 0ms
      */
-    wait: number;
+    wait: number | ((throttler: Throttler<TFn>) => number);
 }
 /**
  * A class that creates a throttled function.
@@ -71,6 +74,14 @@ export declare class Throttler<TFn extends AnyFunction> {
      * Returns the current throttler options
      */
     getOptions(): Required<ThrottlerOptions<TFn>>;
+    /**
+     * Returns the current enabled state of the throttler
+     */
+    getEnabled(): boolean;
+    /**
+     * Returns the current wait time in milliseconds
+     */
+    getWait(): number;
     /**
      * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
      *
@@ -148,4 +159,4 @@ export declare class Throttler<TFn extends AnyFunction> {
  * });
  * ```
  */
-export declare function throttle<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<ThrottlerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => void;
+export declare function throttle<TFn extends AnyFunction>(fn: TFn, initialOptions: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;

package/dist/cjs/types.d.cts

@@ -6,3 +6,4 @@ export type AnyFunction = (...args: Array<any>) => any;
  * Represents an asynchronous function that can be called with any arguments and returns a promise.
  */
 export type AnyAsyncFunction = (...args: Array<any>) => Promise<any>;
+export type OptionalKeys<T, TKey extends keyof T> = Omit<T, TKey> & Partial<Pick<T, TKey>>;

package/dist/cjs/utils.cjs

@@ -1,13 +1,24 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function isFunction(value) {
+  return typeof value === "function";
+}
+function parseFunctionOrValue(value, ...args) {
+  return isFunction(value) ? value(...args) : value;
+}
 function bindInstanceMethods(instance) {
-  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance)).filter((key) => typeof instance[key] === "function").reduce((acc, key) => {
-    const method = instance[key];
-    if (typeof method === "function") {
-      acc[key] = method.bind(instance);
-    }
-    return acc;
-  }, {});
+  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance)).reduce(
+    (acc, key) => {
+      const method = instance[key];
+      if (isFunction(method)) {
+        acc[key] = method.bind(instance);
+      }
+      return acc;
+    },
+    instance
+  );
 }
 exports.bindInstanceMethods = bindInstanceMethods;
+exports.isFunction = isFunction;
+exports.parseFunctionOrValue = parseFunctionOrValue;
 //# sourceMappingURL=utils.cjs.map

package/dist/cjs/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs","sources":["../../src/utils.ts"],"sourcesContent":["export function bindInstanceMethods<T extends Record<string, any>>(\n  instance: T,\n): T {\n  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance))\n    .filter((key) => typeof instance[key as keyof T] === 'function')\n    .reduce((acc: any, key) => {\n      const method = instance[key as keyof T]\n      if (typeof method === 'function') {\n        acc[key] = method.bind(instance)\n      }\n      return acc\n    }, {} as T)\n}\n"],"names":[],"mappings":";;AAAO,SAAS,oBACd,UACG;AACH,SAAO,OAAO,oBAAoB,OAAO,eAAe,QAAQ,CAAC,EAC9D,OAAO,CAAC,QAAQ,OAAO,SAAS,GAAc,MAAM,UAAU,EAC9D,OAAO,CAAC,KAAU,QAAQ;AACnB,UAAA,SAAS,SAAS,GAAc;AAClC,QAAA,OAAO,WAAW,YAAY;AAChC,UAAI,GAAG,IAAI,OAAO,KAAK,QAAQ;AAAA,IAAA;AAE1B,WAAA;AAAA,EACT,GAAG,EAAO;AACd;;"}
+{"version":3,"file":"utils.cjs","sources":["../../src/utils.ts"],"sourcesContent":["import type { AnyFunction } from './types'\n\nexport function isFunction<T extends AnyFunction>(value: any): value is T {\n  return typeof value === 'function'\n}\n\nexport function parseFunctionOrValue<T, TArgs extends Array<any>>(\n  value: T | ((...args: TArgs) => T),\n  ...args: TArgs\n): T {\n  return isFunction(value) ? value(...args) : value\n}\n\nexport function bindInstanceMethods<T extends Record<string, any>>(\n  instance: T,\n): T {\n  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance)).reduce(\n    (acc: any, key) => {\n      const method = instance[key as keyof T]\n      if (isFunction(method)) {\n        acc[key] = method.bind(instance)\n      }\n      return acc\n    },\n    instance,\n  )\n}\n"],"names":[],"mappings":";;AAEO,SAAS,WAAkC,OAAwB;AACxE,SAAO,OAAO,UAAU;AAC1B;AAEgB,SAAA,qBACd,UACG,MACA;AACH,SAAO,WAAW,KAAK,IAAI,MAAM,GAAG,IAAI,IAAI;AAC9C;AAEO,SAAS,oBACd,UACG;AACH,SAAO,OAAO,oBAAoB,OAAO,eAAe,QAAQ,CAAC,EAAE;AAAA,IACjE,CAAC,KAAU,QAAQ;AACX,YAAA,SAAS,SAAS,GAAc;AAClC,UAAA,WAAW,MAAM,GAAG;AACtB,YAAI,GAAG,IAAI,OAAO,KAAK,QAAQ;AAAA,MAAA;AAE1B,aAAA;AAAA,IACT;AAAA,IACA;AAAA,EACF;AACF;;;;"}

package/dist/cjs/utils.d.cts

@@ -1 +1,4 @@
+import { AnyFunction } from './types.cjs';
+export declare function isFunction<T extends AnyFunction>(value: any): value is T;
+export declare function parseFunctionOrValue<T, TArgs extends Array<any>>(value: T | ((...args: TArgs) => T), ...args: TArgs): T;
 export declare function bindInstanceMethods<T extends Record<string, any>>(instance: T): T;

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

@@ -5,16 +5,19 @@ import { AnyAsyncFunction } from './types.js';
 export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Can be a boolean or a function that returns a boolean.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((debouncer: AsyncDebouncer<TFn>) => boolean);
     /**
      * Whether to execute on the leading edge of the timeout.
      * Defaults to false.
      */
     leading?: boolean;
     /**
-     * Optional error handler for when the debounced function throws
+     * Optional error handler for when the debounced function throws.
+     * If provided, the handler will be called with the error and debouncer instance.
+     * This can be used alongside throwOnError - the handler will be called before any error is thrown.
      */
     onError?: (error: unknown, debouncer: AsyncDebouncer<TFn>) => void;
     /**
@@ -25,16 +28,23 @@ export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
      * Optional callback to call when the debounced function is executed
      */
     onSuccess?: (result: ReturnType<TFn>, debouncer: AsyncDebouncer<TFn>) => void;
+    /**
+     * Whether to throw errors when they occur.
+     * Defaults to true if no onError handler is provided, false if an onError handler is provided.
+     * Can be explicitly set to override these defaults.
+     */
+    throwOnError?: boolean;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.
      */
     trailing?: boolean;
     /**
-     * Delay in milliseconds to wait after the last call before executing
+     * Delay in milliseconds to wait after the last call before executing.
+     * Can be a number or a function that returns a number.
      * Defaults to 0ms
      */
-    wait: number;
+    wait: number | ((debouncer: AsyncDebouncer<TFn>) => number);
 }
 /**
  * A class that creates an async debounced function.
@@ -50,12 +60,23 @@ export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
  * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
  * instead of setting the result on a state variable from within the debounced function.
  *
+ * Error Handling:
+ * - If an error occurs during execution and no `onError` handler is provided, the error will be thrown and propagate up to the caller.
+ * - If an `onError` handler is provided, errors will be caught and passed to the handler instead of being thrown.
+ * - The error count can be tracked using `getErrorCount()`.
+ * - The debouncer maintains its state and can continue to be used after an error occurs.
+ *
  * @example
  * ```ts
  * const asyncDebouncer = new AsyncDebouncer(async (value: string) => {
  *   const results = await searchAPI(value);
  *   return results; // Return value is preserved
- * }, { wait: 500 });
+ * }, {
+ *   wait: 500,
+ *   onError: (error) => {
+ *     console.error('Search failed:', error);
+ *   }
+ * });
  *
  * // Called on each keystroke but only executes after 500ms of no typing
  * // Returns the API response directly
@@ -64,6 +85,7 @@ export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
  */
 export declare class AsyncDebouncer<TFn extends AnyAsyncFunction> {
     private fn;
+    private _options;
     private _abortController;
     private _canLeadingExecute;
     private _errorCount;
@@ -71,7 +93,6 @@ export declare class AsyncDebouncer<TFn extends AnyAsyncFunction> {
     private _isPending;
     private _lastArgs;
     private _lastResult;
-    private _options;
     private _settleCount;
     private _successCount;
     private _timeoutId;
@@ -84,10 +105,28 @@ export declare class AsyncDebouncer<TFn extends AnyAsyncFunction> {
     /**
      * Returns the current debouncer options
      */
-    getOptions(): Required<AsyncDebouncerOptions<TFn>>;
+    getOptions(): AsyncDebouncerOptions<TFn>;
     /**
-     * Attempts to execute the debounced function
-     * If a call is already in progress, it will be queued
+     * Returns the current debouncer enabled state
+     */
+    getEnabled(): boolean;
+    /**
+     * Returns the current debouncer wait state
+     */
+    getWait(): number;
+    /**
+     * Attempts to execute the debounced function.
+     * If a call is already in progress, it will be queued.
+     *
+     * Error Handling:
+     * - If the debounced 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.
+     * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.
+     *
+     * @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 debounced function if no onError handler is configured
      */
     maybeExecute(...args: Parameters<TFn>): Promise<ReturnType<TFn> | undefined>;
     private executeFunction;
@@ -133,16 +172,29 @@ export declare class AsyncDebouncer<TFn extends AnyAsyncFunction> {
  * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
  * instead of setting the result on a state variable from within the debounced function.
  *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - The error state can be checked using the underlying AsyncDebouncer instance
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ *
  * @example
  * ```ts
  * const debounced = asyncDebounce(async (value: string) => {
  *   const result = await saveToAPI(value);
  *   return result; // Return value is preserved
- * }, { wait: 1000 });
+ * }, {
+ *   wait: 1000,
+ *   onError: (error) => {
+ *     console.error('API call failed:', error);
+ *   },
+ *   throwOnError: true // Will both log the error and throw it
+ * });
  *
  * // Will only execute once, 1 second after the last call
  * // Returns the API response directly
  * const result = await debounced("third");
  * ```
  */
-export declare function asyncDebounce<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
+export declare function asyncDebounce<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;