@tanstack/pacer 0.11.0 → 0.13.0

package/dist/esm/rate-limiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"rate-limiter.js","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\nexport interface RateLimiterState {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Array of timestamps when executions occurred for rate limiting calculations\n   */\n  executionTimes: Array<number>\n  /**\n   * Whether the rate limiter has exceeded the limit\n   */\n  isExceeded: boolean\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: number\n  /**\n   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded\n   */\n  status: 'disabled' | 'exceeded' | 'idle'\n}\n\nfunction getDefaultRateLimiterState(): RateLimiterState {\n  return structuredClone({\n    executionCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    rejectionCount: 0,\n    status: 'idle',\n  })\n}\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   * Initial state for the rate limiter\n   */\n  initialState?: Partial<RateLimiterState>\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: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject'\n> = {\n  enabled: true,\n  limit: 1,\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via `rateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`\n *\n * @example\n * ```ts\n * const rateLimiter = new RateLimiter(\n *   (id: string) => api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<RateLimiterState>> =\n    new Store<RateLimiterState>(getDefaultRateLimiterState())\n  options: RateLimiterOptions<TFn>\n  #timeoutIds: Set<NodeJS.Timeout> = new Set()\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<TFn>,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n    for (const executionTime of this.#getExecutionTimesInWindow()) {\n      this.#setCleanupTimeout(executionTime)\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   */\n  setOptions = (newOptions: Partial<RateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<RateLimiterState>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const isExceeded = combinedState.executionTimes.length >= this.#getLimit()\n      const status = !this.#getEnabled()\n        ? 'disabled'\n        : isExceeded\n          ? 'exceeded'\n          : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\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    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n\n    if (relevantExecutionTimes.length < this.#getLimit()) {\n      this.#execute(...args)\n      return true\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return false\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    const now = Date.now()\n    this.fn(...args) // EXECUTE!\n    this.store.state.executionTimes.push(now) // mutate state directly for performance\n\n    this.#setCleanupTimeout(now)\n\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n    })\n    this.options.onExecute?.(this)\n  }\n\n  #getExecutionTimesInWindow = (): 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      if (this.store.state.executionTimes.length === 0) {\n        return []\n      }\n      const oldestExecution = Math.min(...this.store.state.executionTimes)\n      const windowStart = oldestExecution\n      const windowEnd = windowStart + this.#getWindow()\n      const now = Date.now()\n\n      // If the window has expired, return empty array\n      if (now > windowEnd) {\n        return []\n      }\n\n      // Otherwise, return all executions in the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time >= windowStart && time <= windowEnd,\n      )\n    }\n  }\n\n  #setCleanupTimeout = (executionTime: number): void => {\n    if (\n      this.options.windowType === 'sliding' ||\n      this.#timeoutIds.size === 0 // new fixed window\n    ) {\n      const now = Date.now()\n      const timeUntilExpiration = executionTime - now + this.#getWindow() + 1\n      const timeoutId = setTimeout(() => {\n        this.#cleanupOldExecutions()\n        this.#clearTimeout(timeoutId)\n      }, timeUntilExpiration)\n      this.#timeoutIds.add(timeoutId)\n    }\n  }\n\n  #clearTimeout = (timeoutId: NodeJS.Timeout): void => {\n    clearTimeout(timeoutId)\n    this.#timeoutIds.delete(timeoutId)\n  }\n\n  #clearTimeouts = (): void => {\n    this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId))\n    this.#timeoutIds.clear()\n  }\n\n  #cleanupOldExecutions = (): void => {\n    this.#setState({\n      executionTimes: this.#getExecutionTimesInWindow(),\n    })\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow = (): number => {\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\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   */\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(getDefaultRateLimiterState())\n    this.#clearTimeouts()\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via the underlying RateLimiter 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 * @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\n}\n"],"names":[],"mappings":";;AA2BA,SAAS,6BAA+C;AACtD,SAAO,gBAAgB;AAAA,IACrB,gBAAgB;AAAA,IAChB,gBAAgB,CAAA;AAAA,IAChB,YAAY;AAAA,IACZ,gBAAgB;AAAA,IAChB,QAAQ;AAAA,EAAA,CACT;AACH;AA0CA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,YAAY;AACd;AA8CO,MAAM,YAAqC;AAAA,EAMhD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAS,QACP,IAAI,MAAwB,2BAAA,CAA4B;AAE1D,SAAA,kCAAuC,IAAA;AAmBvC,SAAA,aAAa,CAAC,eAAuD;AACnE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAAA,IAAW;AAGlD,SAAA,YAAY,CAAC,aAA8C;AACzD,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,aAAa,cAAc,eAAe,UAAU,KAAK,UAAA;AAC/D,cAAM,SAAS,CAAC,KAAK,gBACjB,aACA,aACE,aACA;AACN,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IAAA;AAMH,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAAA;AAM1D,SAAA,YAAY,MAAc;AACxB,aAAO,qBAAqB,KAAK,QAAQ,OAAO,IAAI;AAAA,IAAA;AAMtD,SAAA,aAAa,MAAc;AACzB,aAAO,qBAAqB,KAAK,QAAQ,QAAQ,IAAI;AAAA,IAAA;AAkBvD,SAAA,eAAe,IAAI,SAAmC;AACpD,WAAK,sBAAA;AAEL,YAAM,yBAAyB,KAAK,2BAAA;AAEpC,UAAI,uBAAuB,SAAS,KAAK,UAAA,GAAa;AACpD,aAAK,SAAS,GAAG,IAAI;AACrB,eAAO;AAAA,MAAA;AAGT,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,MAAA,CACnD;AACD,WAAK,QAAQ,WAAW,IAAI;AAC5B,aAAO;AAAA,IAAA;AAGT,SAAA,WAAW,IAAI,SAAgC;AAC7C,UAAI,CAAC,KAAK,cAAe;AACzB,YAAM,MAAM,KAAK,IAAA;AACjB,WAAK,GAAG,GAAG,IAAI;AACf,WAAK,MAAM,MAAM,eAAe,KAAK,GAAG;AAExC,WAAK,mBAAmB,GAAG;AAE3B,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,MAAA,CACnD;AACD,WAAK,QAAQ,YAAY,IAAI;AAAA,IAAA;AAG/B,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,YAAI,KAAK,MAAM,MAAM,eAAe,WAAW,GAAG;AAChD,iBAAO,CAAA;AAAA,QAAC;AAEV,cAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,cAAc;AACnE,cAAM,cAAc;AACpB,cAAM,YAAY,cAAc,KAAK,WAAA;AACrC,cAAM,MAAM,KAAK,IAAA;AAGjB,YAAI,MAAM,WAAW;AACnB,iBAAO,CAAA;AAAA,QAAC;AAIV,eAAO,KAAK,MAAM,MAAM,eAAe;AAAA,UACrC,CAAC,SAAS,QAAQ,eAAe,QAAQ;AAAA,QAAA;AAAA,MAC3C;AAAA,IACF;AAGF,SAAA,qBAAqB,CAAC,kBAAgC;AACpD,UACE,KAAK,QAAQ,eAAe,aAC5B,KAAK,YAAY,SAAS,GAC1B;AACA,cAAM,MAAM,KAAK,IAAA;AACjB,cAAM,sBAAsB,gBAAgB,MAAM,KAAK,eAAe;AACtE,cAAM,YAAY,WAAW,MAAM;AACjC,eAAK,sBAAA;AACL,eAAK,cAAc,SAAS;AAAA,QAAA,GAC3B,mBAAmB;AACtB,aAAK,YAAY,IAAI,SAAS;AAAA,MAAA;AAAA,IAChC;AAGF,SAAA,gBAAgB,CAAC,cAAoC;AACnD,mBAAa,SAAS;AACtB,WAAK,YAAY,OAAO,SAAS;AAAA,IAAA;AAGnC,SAAA,iBAAiB,MAAY;AAC3B,WAAK,YAAY,QAAQ,CAAC,cAAc,aAAa,SAAS,CAAC;AAC/D,WAAK,YAAY,MAAA;AAAA,IAAM;AAGzB,SAAA,wBAAwB,MAAY;AAClC,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,2BAAA;AAAA,MAA2B,CACjD;AAAA,IAAA;AAMH,SAAA,uBAAuB,MAAc;AACnC,YAAM,yBAAyB,KAAK,2BAAA;AACpC,aAAO,KAAK,IAAI,GAAG,KAAK,UAAA,IAAc,uBAAuB,MAAM;AAAA,IAAA;AAMrE,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,4BAA4B;AAC3C,WAAK,eAAA;AAAA,IAAe;AA5LpB,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAC9C,eAAW,iBAAiB,KAAK,8BAA8B;AAC7D,WAAK,mBAAmB,aAAa;AAAA,IAAA;AAAA,EACvC;AAAA,EAbF;AAAA,EAuBA;AAAA,EAuBA;AAAA,EAOA;AAAA,EAOA;AAAA,EAoCA;AAAA,EAcA;AAAA,EA6BA;AAAA,EAeA;AAAA,EAKA;AAAA,EAKA;AAgCF;AAgDO,SAAS,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AACtD,SAAO,YAAY;AACrB;"}
+{"version":3,"file":"rate-limiter.js","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\nexport interface RateLimiterState {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Array of timestamps when executions occurred for rate limiting calculations\n   */\n  executionTimes: Array<number>\n  /**\n   * Whether the rate limiter has exceeded the limit\n   */\n  isExceeded: boolean\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: number\n  /**\n   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded\n   */\n  status: 'disabled' | 'exceeded' | 'idle'\n}\n\nfunction getDefaultRateLimiterState(): RateLimiterState {\n  return structuredClone({\n    executionCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    rejectionCount: 0,\n    status: 'idle',\n  })\n}\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   * Initial state for the rate limiter\n   */\n  initialState?: Partial<RateLimiterState>\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?: (args: Parameters<TFn>, 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: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject'\n> = {\n  enabled: true,\n  limit: 1,\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via `rateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`\n *\n * @example\n * ```ts\n * const rateLimiter = new RateLimiter(\n *   (id: string) => api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<RateLimiterState>> =\n    new Store<RateLimiterState>(getDefaultRateLimiterState())\n  options: RateLimiterOptions<TFn>\n  #timeoutIds: Set<NodeJS.Timeout> = new Set()\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<TFn>,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n    for (const executionTime of this.#getExecutionTimesInWindow()) {\n      this.#setCleanupTimeout(executionTime)\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   */\n  setOptions = (newOptions: Partial<RateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<RateLimiterState>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const isExceeded = combinedState.executionTimes.length >= this.#getLimit()\n      const status = !this.#getEnabled()\n        ? 'disabled'\n        : isExceeded\n          ? 'exceeded'\n          : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\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    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n\n    if (relevantExecutionTimes.length < this.#getLimit()) {\n      this.#execute(...args)\n      return true\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return false\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    const now = Date.now()\n    this.fn(...args) // EXECUTE!\n    this.store.state.executionTimes.push(now) // mutate state directly for performance\n\n    this.#setCleanupTimeout(now)\n\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n    })\n    this.options.onExecute?.(args, this)\n  }\n\n  #getExecutionTimesInWindow = (): 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      if (this.store.state.executionTimes.length === 0) {\n        return []\n      }\n      const oldestExecution = Math.min(...this.store.state.executionTimes)\n      const windowStart = oldestExecution\n      const windowEnd = windowStart + this.#getWindow()\n      const now = Date.now()\n\n      // If the window has expired, return empty array\n      if (now > windowEnd) {\n        return []\n      }\n\n      // Otherwise, return all executions in the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time >= windowStart && time <= windowEnd,\n      )\n    }\n  }\n\n  #setCleanupTimeout = (executionTime: number): void => {\n    if (\n      this.options.windowType === 'sliding' ||\n      this.#timeoutIds.size === 0 // new fixed window\n    ) {\n      const now = Date.now()\n      const timeUntilExpiration = executionTime - now + this.#getWindow() + 1\n      const timeoutId = setTimeout(() => {\n        this.#cleanupOldExecutions()\n        this.#clearTimeout(timeoutId)\n      }, timeUntilExpiration)\n      this.#timeoutIds.add(timeoutId)\n    }\n  }\n\n  #clearTimeout = (timeoutId: NodeJS.Timeout): void => {\n    clearTimeout(timeoutId)\n    this.#timeoutIds.delete(timeoutId)\n  }\n\n  #clearTimeouts = (): void => {\n    this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId))\n    this.#timeoutIds.clear()\n  }\n\n  #cleanupOldExecutions = (): void => {\n    this.#setState({\n      executionTimes: this.#getExecutionTimesInWindow(),\n    })\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow = (): number => {\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\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   */\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(getDefaultRateLimiterState())\n    this.#clearTimeouts()\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via the underlying RateLimiter 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 * @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\n}\n"],"names":[],"mappings":";;AA2BA,SAAS,6BAA+C;AACtD,SAAO,gBAAgB;AAAA,IACrB,gBAAgB;AAAA,IAChB,gBAAgB,CAAA;AAAA,IAChB,YAAY;AAAA,IACZ,gBAAgB;AAAA,IAChB,QAAQ;AAAA,EAAA,CACT;AACH;AA0CA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,YAAY;AACd;AA8CO,MAAM,YAAqC;AAAA,EAMhD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAS,QACP,IAAI,MAAwB,2BAAA,CAA4B;AAE1D,SAAA,kCAAuC,IAAA;AAmBvC,SAAA,aAAa,CAAC,eAAuD;AACnE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAAA,IAAW;AAGlD,SAAA,YAAY,CAAC,aAA8C;AACzD,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,aAAa,cAAc,eAAe,UAAU,KAAK,UAAA;AAC/D,cAAM,SAAS,CAAC,KAAK,gBACjB,aACA,aACE,aACA;AACN,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IAAA;AAMH,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAAA;AAM1D,SAAA,YAAY,MAAc;AACxB,aAAO,qBAAqB,KAAK,QAAQ,OAAO,IAAI;AAAA,IAAA;AAMtD,SAAA,aAAa,MAAc;AACzB,aAAO,qBAAqB,KAAK,QAAQ,QAAQ,IAAI;AAAA,IAAA;AAkBvD,SAAA,eAAe,IAAI,SAAmC;AACpD,WAAK,sBAAA;AAEL,YAAM,yBAAyB,KAAK,2BAAA;AAEpC,UAAI,uBAAuB,SAAS,KAAK,UAAA,GAAa;AACpD,aAAK,SAAS,GAAG,IAAI;AACrB,eAAO;AAAA,MAAA;AAGT,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,MAAA,CACnD;AACD,WAAK,QAAQ,WAAW,IAAI;AAC5B,aAAO;AAAA,IAAA;AAGT,SAAA,WAAW,IAAI,SAAgC;AAC7C,UAAI,CAAC,KAAK,cAAe;AACzB,YAAM,MAAM,KAAK,IAAA;AACjB,WAAK,GAAG,GAAG,IAAI;AACf,WAAK,MAAM,MAAM,eAAe,KAAK,GAAG;AAExC,WAAK,mBAAmB,GAAG;AAE3B,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,MAAA,CACnD;AACD,WAAK,QAAQ,YAAY,MAAM,IAAI;AAAA,IAAA;AAGrC,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,YAAI,KAAK,MAAM,MAAM,eAAe,WAAW,GAAG;AAChD,iBAAO,CAAA;AAAA,QAAC;AAEV,cAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,cAAc;AACnE,cAAM,cAAc;AACpB,cAAM,YAAY,cAAc,KAAK,WAAA;AACrC,cAAM,MAAM,KAAK,IAAA;AAGjB,YAAI,MAAM,WAAW;AACnB,iBAAO,CAAA;AAAA,QAAC;AAIV,eAAO,KAAK,MAAM,MAAM,eAAe;AAAA,UACrC,CAAC,SAAS,QAAQ,eAAe,QAAQ;AAAA,QAAA;AAAA,MAC3C;AAAA,IACF;AAGF,SAAA,qBAAqB,CAAC,kBAAgC;AACpD,UACE,KAAK,QAAQ,eAAe,aAC5B,KAAK,YAAY,SAAS,GAC1B;AACA,cAAM,MAAM,KAAK,IAAA;AACjB,cAAM,sBAAsB,gBAAgB,MAAM,KAAK,eAAe;AACtE,cAAM,YAAY,WAAW,MAAM;AACjC,eAAK,sBAAA;AACL,eAAK,cAAc,SAAS;AAAA,QAAA,GAC3B,mBAAmB;AACtB,aAAK,YAAY,IAAI,SAAS;AAAA,MAAA;AAAA,IAChC;AAGF,SAAA,gBAAgB,CAAC,cAAoC;AACnD,mBAAa,SAAS;AACtB,WAAK,YAAY,OAAO,SAAS;AAAA,IAAA;AAGnC,SAAA,iBAAiB,MAAY;AAC3B,WAAK,YAAY,QAAQ,CAAC,cAAc,aAAa,SAAS,CAAC;AAC/D,WAAK,YAAY,MAAA;AAAA,IAAM;AAGzB,SAAA,wBAAwB,MAAY;AAClC,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,2BAAA;AAAA,MAA2B,CACjD;AAAA,IAAA;AAMH,SAAA,uBAAuB,MAAc;AACnC,YAAM,yBAAyB,KAAK,2BAAA;AACpC,aAAO,KAAK,IAAI,GAAG,KAAK,UAAA,IAAc,uBAAuB,MAAM;AAAA,IAAA;AAMrE,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,4BAA4B;AAC3C,WAAK,eAAA;AAAA,IAAe;AA5LpB,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAC9C,eAAW,iBAAiB,KAAK,8BAA8B;AAC7D,WAAK,mBAAmB,aAAa;AAAA,IAAA;AAAA,EACvC;AAAA,EAbF;AAAA,EAuBA;AAAA,EAuBA;AAAA,EAOA;AAAA,EAOA;AAAA,EAoCA;AAAA,EAcA;AAAA,EA6BA;AAAA,EAeA;AAAA,EAKA;AAAA,EAKA;AAgCF;AAgDO,SAAS,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AACtD,SAAO,YAAY;AACrB;"}

package/dist/esm/throttler.d.ts

@@ -48,7 +48,7 @@ export interface ThrottlerOptions<TFn extends AnyFunction> {
     /**
      * Callback function that is called after the function is executed
      */
-    onExecute?: (throttler: Throttler<TFn>) => void;
+    onExecute?: (args: Parameters<TFn>, throttler: Throttler<TFn>) => void;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.

package/dist/esm/throttler.js

@@ -83,7 +83,7 @@ class Throttler {
         isPending: false,
         lastArgs: void 0
       });
-      this.options.onExecute?.(this);
+      this.options.onExecute?.(args, this);
       setTimeout(() => {
         if (!this.store.state.isPending) {
           this.#setState({ nextExecutionTime: void 0 });

package/dist/esm/throttler.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.js","sources":["../../src/throttler.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\nexport interface ThrottlerState<TFn extends AnyFunction> {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the throttler is waiting for the timeout to trigger execution\n   */\n  isPending: boolean\n  /**\n   * The arguments from the most recent call to maybeExecute\n   */\n  lastArgs: Parameters<TFn> | undefined\n  /**\n   * Timestamp of the last function execution in milliseconds\n   */\n  lastExecutionTime: number\n  /**\n   * Timestamp when the next execution can occur in milliseconds\n   */\n  nextExecutionTime: number | undefined\n  /**\n   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout\n   */\n  status: 'disabled' | 'idle' | 'pending'\n}\n\nfunction getDefaultThrottlerState<\n  TFn extends AnyFunction,\n>(): ThrottlerState<TFn> {\n  return structuredClone({\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    nextExecutionTime: 0,\n    status: 'idle',\n  })\n}\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   * Initial state for the throttler\n   */\n  initialState?: Partial<ThrottlerState<TFn>>\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: Omit<\n  Required<ThrottlerOptions<any>>,\n  'initialState' | 'onExecute'\n> = {\n  enabled: true,\n  leading: true,\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via `throttler.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `throttler.state`\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  readonly store: Store<Readonly<ThrottlerState<TFn>>> = new Store(\n    getDefaultThrottlerState(),\n  )\n  options: ThrottlerOptions<TFn>\n  #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    this.#setState(this.options.initialState ?? {})\n  }\n\n  /**\n   * Updates the throttler options\n   */\n  setOptions = (newOptions: Partial<ThrottlerOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n\n    // Cancel pending execution if the throttler is disabled\n    if (!this.#getEnabled()) {\n      this.cancel()\n    }\n  }\n\n  #setState = (newState: Partial<ThrottlerState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending } = combinedState\n      return {\n        ...combinedState,\n        status: !this.#getEnabled()\n          ? 'disabled'\n          : isPending\n            ? 'pending'\n            : 'idle',\n      }\n    })\n  }\n\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\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.store.state.lastExecutionTime\n    const wait = this.#getWait()\n\n    // Handle leading execution\n    if (this.options.leading && timeSinceLastExecution >= wait) {\n      this.#execute(...args)\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this.#setState({\n        lastArgs: args,\n      })\n      // Set up trailing execution if not already scheduled\n      if (!this.#timeoutId && this.options.trailing) {\n        // prevent large number if lastExecutionTime is undefined\n        const _timeSinceLastExecution = this.store.state.lastExecutionTime\n          ? now - this.store.state.lastExecutionTime\n          : 0\n        const timeoutDuration = wait - _timeSinceLastExecution\n        this.#setState({ isPending: true })\n        this.#timeoutId = setTimeout(() => {\n          const { lastArgs } = this.store.state\n          if (lastArgs !== undefined) {\n            this.#execute(...lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    this.fn(...args) // EXECUTE!\n    const lastExecutionTime = Date.now()\n    const nextExecutionTime = lastExecutionTime + this.#getWait()\n    this.#clearTimeout()\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      lastExecutionTime,\n      nextExecutionTime,\n      isPending: false,\n      lastArgs: undefined,\n    })\n    this.options.onExecute?.(this)\n    setTimeout(() => {\n      if (!this.store.state.isPending) {\n        this.#setState({ nextExecutionTime: undefined })\n      }\n    }, this.#getWait())\n  }\n\n  /**\n   * Processes the current pending execution immediately\n   */\n  flush = (): void => {\n    if (this.store.state.isPending && this.store.state.lastArgs) {\n      this.#execute(...this.store.state.lastArgs)\n    }\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = undefined\n    }\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    this.#clearTimeout()\n    this.#setState({\n      lastArgs: undefined,\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the throttler state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultThrottlerState<TFn>())\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via the underlying Throttler instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\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\n}\n"],"names":[],"mappings":";;AA+BA,SAAS,2BAEgB;AACvB,SAAO,gBAAgB;AAAA,IACrB,gBAAgB;AAAA,IAChB,WAAW;AAAA,IACX,UAAU;AAAA,IACV,mBAAmB;AAAA,IACnB,mBAAmB;AAAA,IACnB,QAAQ;AAAA,EAAA,CACT;AACH;AAsCA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,MAAM;AACR;AAqCO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAS,QAA8C,IAAI;AAAA,MACzD,yBAAA;AAAA,IAAyB;AAmB3B,SAAA,aAAa,CAAC,eAAqD;AACjE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAGrC,UAAI,CAAC,KAAK,eAAe;AACvB,aAAK,OAAA;AAAA,MAAO;AAAA,IACd;AAGF,SAAA,YAAY,CAAC,aAAiD;AAC5D,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,EAAE,cAAc;AACtB,eAAO;AAAA,UACL,GAAG;AAAA,UACH,QAAQ,CAAC,KAAK,gBACV,aACA,YACE,YACA;AAAA,QAAA;AAAA,MACR,CACD;AAAA,IAAA;AAGH,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAAA;AAG1D,SAAA,WAAW,MAAc;AACvB,aAAO,qBAAqB,KAAK,QAAQ,MAAM,IAAI;AAAA,IAAA;AAyBrD,SAAA,eAAe,IAAI,SAAgC;AACjD,YAAM,MAAM,KAAK,IAAA;AACjB,YAAM,yBAAyB,MAAM,KAAK,MAAM,MAAM;AACtD,YAAM,OAAO,KAAK,SAAA;AAGlB,UAAI,KAAK,QAAQ,WAAW,0BAA0B,MAAM;AAC1D,aAAK,SAAS,GAAG,IAAI;AAAA,MAAA,OAChB;AAEL,aAAK,UAAU;AAAA,UACb,UAAU;AAAA,QAAA,CACX;AAED,YAAI,CAAC,KAAK,cAAc,KAAK,QAAQ,UAAU;AAE7C,gBAAM,0BAA0B,KAAK,MAAM,MAAM,oBAC7C,MAAM,KAAK,MAAM,MAAM,oBACvB;AACJ,gBAAM,kBAAkB,OAAO;AAC/B,eAAK,UAAU,EAAE,WAAW,KAAA,CAAM;AAClC,eAAK,aAAa,WAAW,MAAM;AACjC,kBAAM,EAAE,SAAA,IAAa,KAAK,MAAM;AAChC,gBAAI,aAAa,QAAW;AAC1B,mBAAK,SAAS,GAAG,QAAQ;AAAA,YAAA;AAAA,UAC3B,GACC,eAAe;AAAA,QAAA;AAAA,MACpB;AAAA,IACF;AAGF,SAAA,WAAW,IAAI,SAAgC;AAC7C,UAAI,CAAC,KAAK,cAAe;AACzB,WAAK,GAAG,GAAG,IAAI;AACf,YAAM,oBAAoB,KAAK,IAAA;AAC/B,YAAM,oBAAoB,oBAAoB,KAAK,SAAA;AACnD,WAAK,cAAA;AACL,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,QAClD;AAAA,QACA;AAAA,QACA,WAAW;AAAA,QACX,UAAU;AAAA,MAAA,CACX;AACD,WAAK,QAAQ,YAAY,IAAI;AAC7B,iBAAW,MAAM;AACf,YAAI,CAAC,KAAK,MAAM,MAAM,WAAW;AAC/B,eAAK,UAAU,EAAE,mBAAmB,OAAA,CAAW;AAAA,QAAA;AAAA,MACjD,GACC,KAAK,UAAU;AAAA,IAAA;AAMpB,SAAA,QAAQ,MAAY;AAClB,UAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;AAC3D,aAAK,SAAS,GAAG,KAAK,MAAM,MAAM,QAAQ;AAAA,MAAA;AAAA,IAC5C;AAGF,SAAA,gBAAgB,MAAY;AAC1B,UAAI,KAAK,YAAY;AACnB,qBAAa,KAAK,UAAU;AAC5B,aAAK,aAAa;AAAA,MAAA;AAAA,IACpB;AAYF,SAAA,SAAS,MAAY;AACnB,WAAK,cAAA;AACL,WAAK,UAAU;AAAA,QACb,UAAU;AAAA,QACV,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA;AAMH,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,0BAA+B;AAAA,IAAA;AA5J9C,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAAA,EAAA;AAAA,EAVhD;AAAA,EAyBA;AAAA,EAkBA;AAAA,EAIA;AAAA,EAyDA;AAAA,EA8BA;AA8BF;AAoCO,SAAS,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAClD,SAAO,UAAU;AACnB;"}
+{"version":3,"file":"throttler.js","sources":["../../src/throttler.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\nexport interface ThrottlerState<TFn extends AnyFunction> {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the throttler is waiting for the timeout to trigger execution\n   */\n  isPending: boolean\n  /**\n   * The arguments from the most recent call to maybeExecute\n   */\n  lastArgs: Parameters<TFn> | undefined\n  /**\n   * Timestamp of the last function execution in milliseconds\n   */\n  lastExecutionTime: number\n  /**\n   * Timestamp when the next execution can occur in milliseconds\n   */\n  nextExecutionTime: number | undefined\n  /**\n   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout\n   */\n  status: 'disabled' | 'idle' | 'pending'\n}\n\nfunction getDefaultThrottlerState<\n  TFn extends AnyFunction,\n>(): ThrottlerState<TFn> {\n  return structuredClone({\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    nextExecutionTime: 0,\n    status: 'idle',\n  })\n}\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   * Initial state for the throttler\n   */\n  initialState?: Partial<ThrottlerState<TFn>>\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?: (args: Parameters<TFn>, 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: Omit<\n  Required<ThrottlerOptions<any>>,\n  'initialState' | 'onExecute'\n> = {\n  enabled: true,\n  leading: true,\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via `throttler.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `throttler.state`\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  readonly store: Store<Readonly<ThrottlerState<TFn>>> = new Store(\n    getDefaultThrottlerState(),\n  )\n  options: ThrottlerOptions<TFn>\n  #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    this.#setState(this.options.initialState ?? {})\n  }\n\n  /**\n   * Updates the throttler options\n   */\n  setOptions = (newOptions: Partial<ThrottlerOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n\n    // Cancel pending execution if the throttler is disabled\n    if (!this.#getEnabled()) {\n      this.cancel()\n    }\n  }\n\n  #setState = (newState: Partial<ThrottlerState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending } = combinedState\n      return {\n        ...combinedState,\n        status: !this.#getEnabled()\n          ? 'disabled'\n          : isPending\n            ? 'pending'\n            : 'idle',\n      }\n    })\n  }\n\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\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.store.state.lastExecutionTime\n    const wait = this.#getWait()\n\n    // Handle leading execution\n    if (this.options.leading && timeSinceLastExecution >= wait) {\n      this.#execute(...args)\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this.#setState({\n        lastArgs: args,\n      })\n      // Set up trailing execution if not already scheduled\n      if (!this.#timeoutId && this.options.trailing) {\n        // prevent large number if lastExecutionTime is undefined\n        const _timeSinceLastExecution = this.store.state.lastExecutionTime\n          ? now - this.store.state.lastExecutionTime\n          : 0\n        const timeoutDuration = wait - _timeSinceLastExecution\n        this.#setState({ isPending: true })\n        this.#timeoutId = setTimeout(() => {\n          const { lastArgs } = this.store.state\n          if (lastArgs !== undefined) {\n            this.#execute(...lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    this.fn(...args) // EXECUTE!\n    const lastExecutionTime = Date.now()\n    const nextExecutionTime = lastExecutionTime + this.#getWait()\n    this.#clearTimeout()\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      lastExecutionTime,\n      nextExecutionTime,\n      isPending: false,\n      lastArgs: undefined,\n    })\n    this.options.onExecute?.(args, this)\n    setTimeout(() => {\n      if (!this.store.state.isPending) {\n        this.#setState({ nextExecutionTime: undefined })\n      }\n    }, this.#getWait())\n  }\n\n  /**\n   * Processes the current pending execution immediately\n   */\n  flush = (): void => {\n    if (this.store.state.isPending && this.store.state.lastArgs) {\n      this.#execute(...this.store.state.lastArgs)\n    }\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = undefined\n    }\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    this.#clearTimeout()\n    this.#setState({\n      lastArgs: undefined,\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the throttler state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultThrottlerState<TFn>())\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via the underlying Throttler instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\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\n}\n"],"names":[],"mappings":";;AA+BA,SAAS,2BAEgB;AACvB,SAAO,gBAAgB;AAAA,IACrB,gBAAgB;AAAA,IAChB,WAAW;AAAA,IACX,UAAU;AAAA,IACV,mBAAmB;AAAA,IACnB,mBAAmB;AAAA,IACnB,QAAQ;AAAA,EAAA,CACT;AACH;AAsCA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,MAAM;AACR;AAqCO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAS,QAA8C,IAAI;AAAA,MACzD,yBAAA;AAAA,IAAyB;AAmB3B,SAAA,aAAa,CAAC,eAAqD;AACjE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAGrC,UAAI,CAAC,KAAK,eAAe;AACvB,aAAK,OAAA;AAAA,MAAO;AAAA,IACd;AAGF,SAAA,YAAY,CAAC,aAAiD;AAC5D,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,EAAE,cAAc;AACtB,eAAO;AAAA,UACL,GAAG;AAAA,UACH,QAAQ,CAAC,KAAK,gBACV,aACA,YACE,YACA;AAAA,QAAA;AAAA,MACR,CACD;AAAA,IAAA;AAGH,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAAA;AAG1D,SAAA,WAAW,MAAc;AACvB,aAAO,qBAAqB,KAAK,QAAQ,MAAM,IAAI;AAAA,IAAA;AAyBrD,SAAA,eAAe,IAAI,SAAgC;AACjD,YAAM,MAAM,KAAK,IAAA;AACjB,YAAM,yBAAyB,MAAM,KAAK,MAAM,MAAM;AACtD,YAAM,OAAO,KAAK,SAAA;AAGlB,UAAI,KAAK,QAAQ,WAAW,0BAA0B,MAAM;AAC1D,aAAK,SAAS,GAAG,IAAI;AAAA,MAAA,OAChB;AAEL,aAAK,UAAU;AAAA,UACb,UAAU;AAAA,QAAA,CACX;AAED,YAAI,CAAC,KAAK,cAAc,KAAK,QAAQ,UAAU;AAE7C,gBAAM,0BAA0B,KAAK,MAAM,MAAM,oBAC7C,MAAM,KAAK,MAAM,MAAM,oBACvB;AACJ,gBAAM,kBAAkB,OAAO;AAC/B,eAAK,UAAU,EAAE,WAAW,KAAA,CAAM;AAClC,eAAK,aAAa,WAAW,MAAM;AACjC,kBAAM,EAAE,SAAA,IAAa,KAAK,MAAM;AAChC,gBAAI,aAAa,QAAW;AAC1B,mBAAK,SAAS,GAAG,QAAQ;AAAA,YAAA;AAAA,UAC3B,GACC,eAAe;AAAA,QAAA;AAAA,MACpB;AAAA,IACF;AAGF,SAAA,WAAW,IAAI,SAAgC;AAC7C,UAAI,CAAC,KAAK,cAAe;AACzB,WAAK,GAAG,GAAG,IAAI;AACf,YAAM,oBAAoB,KAAK,IAAA;AAC/B,YAAM,oBAAoB,oBAAoB,KAAK,SAAA;AACnD,WAAK,cAAA;AACL,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,QAClD;AAAA,QACA;AAAA,QACA,WAAW;AAAA,QACX,UAAU;AAAA,MAAA,CACX;AACD,WAAK,QAAQ,YAAY,MAAM,IAAI;AACnC,iBAAW,MAAM;AACf,YAAI,CAAC,KAAK,MAAM,MAAM,WAAW;AAC/B,eAAK,UAAU,EAAE,mBAAmB,OAAA,CAAW;AAAA,QAAA;AAAA,MACjD,GACC,KAAK,UAAU;AAAA,IAAA;AAMpB,SAAA,QAAQ,MAAY;AAClB,UAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;AAC3D,aAAK,SAAS,GAAG,KAAK,MAAM,MAAM,QAAQ;AAAA,MAAA;AAAA,IAC5C;AAGF,SAAA,gBAAgB,MAAY;AAC1B,UAAI,KAAK,YAAY;AACnB,qBAAa,KAAK,UAAU;AAC5B,aAAK,aAAa;AAAA,MAAA;AAAA,IACpB;AAYF,SAAA,SAAS,MAAY;AACnB,WAAK,cAAA;AACL,WAAK,UAAU;AAAA,QACb,UAAU;AAAA,QACV,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA;AAMH,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,0BAA+B;AAAA,IAAA;AA5J9C,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAAA,EAAA;AAAA,EAVhD;AAAA,EAyBA;AAAA,EAkBA;AAAA,EAIA;AAAA,EAyDA;AAAA,EA8BA;AA8BF;AAoCO,SAAS,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAClD,SAAO,UAAU;AACnB;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/pacer",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Utilities for debouncing, throttling, rate-limiting, queuing, and more.",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/async-batcher.ts

@@ -98,18 +98,14 @@ export interface AsyncBatcherOptions<TValue> {
   maxSize?: number
   /**
    * Optional error handler for when the batch function throws.
-   * If provided, the handler will be called with the error and batcher instance.
+   * If provided, the handler will be called with the error, the batch of items that failed, and batcher instance.
    * This can be used alongside throwOnError - the handler will be called before any error is thrown.
    */
   onError?: (
     error: unknown,
-    failedItems: Array<TValue>,
+    batch: Array<TValue>,
     batcher: AsyncBatcher<TValue>,
   ) => void
-  /**
-   * Callback fired after a batch is processed
-   */
-  onExecute?: (batcher: AsyncBatcher<TValue>) => void
   /**
    * Callback fired after items are added to the batcher
    */
@@ -117,11 +113,15 @@ export interface AsyncBatcherOptions<TValue> {
   /**
    * Optional callback to call when a batch is settled (completed or failed)
    */
-  onSettled?: (batcher: AsyncBatcher<TValue>) => void
+  onSettled?: (batch: Array<TValue>, batcher: AsyncBatcher<TValue>) => void
   /**
    * Optional callback to call when a batch succeeds
    */
-  onSuccess?: (result: any, batcher: AsyncBatcher<TValue>) => void
+  onSuccess?: (
+    result: any,
+    batch: Array<TValue>,
+    batcher: AsyncBatcher<TValue>,
+  ) => void
   /**
    * Whether the batcher should start processing immediately
    * @default true
@@ -144,12 +144,7 @@ export interface AsyncBatcherOptions<TValue> {
 
 type AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<
   Required<AsyncBatcherOptions<TValue>>,
-  | 'initialState'
-  | 'onError'
-  | 'onExecute'
-  | 'onItemsChange'
-  | 'onSettled'
-  | 'onSuccess'
+  'initialState' | 'onError' | 'onItemsChange' | 'onSettled' | 'onSuccess'
 >
 
 const defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {
@@ -180,7 +175,7 @@ const defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {
  * - Error handling for failed batch operations
  *
  * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and batcher instance
+ * - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, and batcher 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
  * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
@@ -308,7 +303,7 @@ export class AsyncBatcher<TValue> {
    * You can also call this method manually to process the current batch at any time.
    *
    * @returns A promise that resolves with the result of the batch function, or undefined if an error occurred and was handled by onError
-   * @throws The error from the batch function if no onError handler is configured
+   * @throws The error from the batch function if no onError handler is configured or throwOnError is true
    */
   #execute = async (): Promise<any> => {
     if (this.store.state.items.length === 0) {
@@ -317,7 +312,7 @@ export class AsyncBatcher<TValue> {
 
     const batch = this.peekAllItems() // copy of the items to be processed (to prevent race conditions)
     this.clear() // Clear items before processing to prevent race conditions
-    this.options.onItemsChange?.(this) // Call onItemsChange to notify listeners that the items have changed
+    this.options.onItemsChange?.(this)
 
     this.#setState({ isExecuting: true })
 
@@ -329,7 +324,7 @@ export class AsyncBatcher<TValue> {
         lastResult: result,
         successCount: this.store.state.successCount + 1,
       })
-      this.options.onSuccess?.(result, this)
+      this.options.onSuccess?.(result, batch, this)
       return result
     } catch (error) {
       this.#setState({
@@ -347,8 +342,7 @@ export class AsyncBatcher<TValue> {
         isExecuting: false,
         settleCount: this.store.state.settleCount + 1,
       })
-      this.options.onSettled?.(this)
-      this.options.onExecute?.(this)
+      this.options.onSettled?.(batch, this)
     }
   }
 
@@ -404,7 +398,7 @@ export class AsyncBatcher<TValue> {
  * - Has state tracking for when batches are executing
  *
  * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and batcher instance
+ * - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, and batcher 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
  * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown

package/src/async-debouncer.ts

@@ -81,15 +81,23 @@ export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
    * 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
+  onError?: (
+    error: unknown,
+    args: Parameters<TFn>,
+    debouncer: AsyncDebouncer<TFn>,
+  ) => void
   /**
    * Optional callback to call when the debounced function is executed
    */
-  onSettled?: (debouncer: AsyncDebouncer<TFn>) => void
+  onSettled?: (args: Parameters<TFn>, debouncer: AsyncDebouncer<TFn>) => void
   /**
    * Optional callback to call when the debounced function is executed
    */
-  onSuccess?: (result: ReturnType<TFn>, debouncer: AsyncDebouncer<TFn>) => void
+  onSuccess?: (
+    result: ReturnType<TFn>,
+    args: Parameters<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.
@@ -176,7 +184,6 @@ export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
   #resolvePreviousPromise:
     | ((value?: ReturnType<TFn> | undefined) => void)
     | null = null
-  #rejectPreviousPromise: ((reason?: unknown) => void) | null = null
 
   constructor(
     private fn: TFn,
@@ -273,11 +280,15 @@ export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
 
     return new Promise((resolve, reject) => {
       this.#resolvePreviousPromise = resolve
-      this.#rejectPreviousPromise = reject
+      // this.#rejectPreviousPromise = reject
       this.#timeoutId = setTimeout(async () => {
         // Execute trailing if enabled
         if (this.options.trailing && this.store.state.lastArgs) {
-          await this.#execute(...this.store.state.lastArgs)
+          try {
+            await this.#execute(...this.store.state.lastArgs)
+          } catch (error) {
+            reject(error)
+          }
         }
 
         // Reset state and resolve
@@ -300,14 +311,14 @@ export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
         lastResult: result,
         successCount: this.store.state.successCount + 1,
       })
-      this.options.onSuccess?.(result, this)
+      this.options.onSuccess?.(result, args, this)
     } catch (error) {
       this.#setState({
         errorCount: this.store.state.errorCount + 1,
       })
-      this.options.onError?.(error, this)
+      this.options.onError?.(error, args, this)
       if (this.options.throwOnError) {
-        this.#rejectPreviousPromiseInternal(error)
+        throw error
       }
     } finally {
       this.#setState({
@@ -317,7 +328,7 @@ export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
         settleCount: this.store.state.settleCount + 1,
       })
       this.#abortController = null
-      this.options.onSettled?.(this)
+      this.options.onSettled?.(args, this)
     }
     return this.store.state.lastResult
   }
@@ -346,13 +357,6 @@ export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
     }
   }
 
-  #rejectPreviousPromiseInternal = (error: unknown): void => {
-    if (this.#rejectPreviousPromise) {
-      this.#rejectPreviousPromise(error)
-      this.#rejectPreviousPromise = null
-    }
-  }
-
   #clearTimeout = (): void => {
     if (this.#timeoutId) {
       clearTimeout(this.#timeoutId)

package/src/async-queuer.ts

@@ -141,7 +141,7 @@ export interface AsyncQueuerOptions<TValue> {
    * If provided, the handler will be called with the error and queuer instance.
    * This can be used alongside throwOnError - the handler will be called before any error is thrown.
    */
-  onError?: (error: unknown, queuer: AsyncQueuer<TValue>) => void
+  onError?: (error: unknown, item: TValue, queuer: AsyncQueuer<TValue>) => void
   /**
    * Callback fired whenever an item expires in the queuer
    */
@@ -157,11 +157,11 @@ export interface AsyncQueuerOptions<TValue> {
   /**
    * Optional callback to call when a task is settled
    */
-  onSettled?: (queuer: AsyncQueuer<TValue>) => void
+  onSettled?: (item: TValue, queuer: AsyncQueuer<TValue>) => void
   /**
    * Optional callback to call when a task succeeds
    */
-  onSuccess?: (result: TValue, queuer: AsyncQueuer<TValue>) => void
+  onSuccess?: (result: any, item: TValue, queuer: AsyncQueuer<TValue>) => void
   /**
    * Whether the queuer should start processing tasks immediately or not.
    */
@@ -527,17 +527,17 @@ export class AsyncQueuer<TValue> {
     const item = this.getNextItem(position)
     if (item !== undefined) {
       try {
-        const lastResult = await this.fn(item)
+        const lastResult = await this.fn(item) // EXECUTE!
         this.#setState({
           successCount: this.store.state.successCount + 1,
           lastResult,
         })
-        this.options.onSuccess?.(lastResult, this)
+        this.options.onSuccess?.(lastResult, item, this)
       } catch (error) {
         this.#setState({
           errorCount: this.store.state.errorCount + 1,
         })
-        this.options.onError?.(error, this)
+        this.options.onError?.(error, item, this)
         if (this.options.throwOnError) {
           throw error
         }
@@ -548,7 +548,7 @@ export class AsyncQueuer<TValue> {
           ),
           settledCount: this.store.state.settledCount + 1,
         })
-        this.options.onSettled?.(this)
+        this.options.onSettled?.(item, this)
       }
     }
     return item
@@ -569,7 +569,7 @@ export class AsyncQueuer<TValue> {
   }
 
   /**
-   * Processes all items in the queue as a batch using the provided function
+   * Processes all items in the queue as a batch using the provided function as an argument
    * The queue is cleared after processing
    */
   flushAsBatch = async (

package/src/async-rate-limiter.ts

@@ -81,20 +81,28 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
    * If provided, the handler will be called with the error and rate limiter instance.
    * This can be used alongside throwOnError - the handler will be called before any error is thrown.
    */
-  onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void
+  onError?: (
+    error: unknown,
+    args: Parameters<TFn>,
+    rateLimiter: AsyncRateLimiter<TFn>,
+  ) => void
   /**
    * Optional callback function that is called when an execution is rejected due to rate limiting
    */
-  onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void
+  onReject?: (args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void
   /**
    * Optional function to call when the rate-limited function is executed
    */
-  onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void
+  onSettled?: (
+    args: Parameters<TFn>,
+    rateLimiter: AsyncRateLimiter<TFn>,
+  ) => void
   /**
    * Optional function to call when the rate-limited function is executed
    */
   onSuccess?: (
     result: ReturnType<TFn>,
+    args: Parameters<TFn>,
     rateLimiter: AsyncRateLimiter<TFn>,
   ) => void
   /**
@@ -306,7 +314,7 @@ export class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
     this.#setState({
       rejectionCount: this.store.state.rejectionCount + 1,
     })
-    this.options.onReject?.(this)
+    this.options.onReject?.(args, this)
     return undefined
   }
 
@@ -329,12 +337,12 @@ export class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
         successCount: this.store.state.successCount + 1,
         lastResult: result,
       })
-      this.options.onSuccess?.(result, this)
+      this.options.onSuccess?.(result, args, this)
     } catch (error) {
       this.#setState({
         errorCount: this.store.state.errorCount + 1,
       })
-      this.options.onError?.(error, this)
+      this.options.onError?.(error, args, this)
       if (this.options.throwOnError) {
         throw error
       }
@@ -343,7 +351,7 @@ export class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
         isExecuting: false,
         settleCount: this.store.state.settleCount + 1,
       })
-      this.options.onSettled?.(this)
+      this.options.onSettled?.(args, this)
     }
 
     return this.store.state.lastResult

package/src/async-throttler.ts

@@ -86,16 +86,24 @@ export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
    * If provided, the handler will be called with the error and throttler instance.
    * This can be used alongside throwOnError - the handler will be called before any error is thrown.
    */
-  onError?: (error: unknown, asyncThrottler: AsyncThrottler<TFn>) => void
+  onError?: (
+    error: unknown,
+    args: Parameters<TFn>,
+    asyncThrottler: AsyncThrottler<TFn>,
+  ) => void
   /**
    * Optional function to call when the throttled function is executed
    */
-  onSettled?: (asyncThrottler: AsyncThrottler<TFn>) => void
+  onSettled?: (
+    args: Parameters<TFn>,
+    asyncThrottler: AsyncThrottler<TFn>,
+  ) => void
   /**
    * Optional function to call when the throttled function is executed
    */
   onSuccess?: (
     result: ReturnType<TFn>,
+    args: Parameters<TFn>,
     asyncThrottler: AsyncThrottler<TFn>,
   ) => void
   /**
@@ -187,7 +195,6 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
   #resolvePreviousPromise:
     | ((value?: ReturnType<TFn> | undefined) => void)
     | null = null
-  #rejectPreviousPromise: ((reason?: unknown) => void) | null = null
 
   constructor(
     private fn: TFn,
@@ -290,7 +297,6 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
     } else {
       return new Promise((resolve, reject) => {
         this.#resolvePreviousPromise = resolve
-        this.#rejectPreviousPromise = reject
         // Clear any existing timeout to ensure we use the latest arguments
         this.#clearTimeout()
 
@@ -303,7 +309,11 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
           this.#setState({ isPending: true })
           this.#timeoutId = setTimeout(async () => {
             if (this.store.state.lastArgs !== undefined) {
-              await this.#execute(...this.store.state.lastArgs)
+              try {
+                await this.#execute(...this.store.state.lastArgs) // EXECUTE!
+              } catch (error) {
+                reject(error)
+              }
             }
             this.#resolvePreviousPromise = null
             resolve(this.store.state.lastResult)
@@ -325,14 +335,14 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
         lastResult: result,
         successCount: this.store.state.successCount + 1,
       })
-      this.options.onSuccess?.(result, this)
+      this.options.onSuccess?.(result, args, this)
     } catch (error) {
       this.#setState({
         errorCount: this.store.state.errorCount + 1,
       })
-      this.options.onError?.(error, this)
+      this.options.onError?.(error, args, this)
       if (this.options.throwOnError) {
-        this.#rejectPreviousPromiseInternal(error)
+        throw error
       }
     } finally {
       const lastExecutionTime = Date.now()
@@ -345,7 +355,7 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
         nextExecutionTime,
       })
       this.#abortController = null
-      this.options.onSettled?.(this)
+      this.options.onSettled?.(args, this)
       setTimeout(() => {
         if (!this.store.state.isPending) {
           this.#setState({ nextExecutionTime: undefined })
@@ -379,13 +389,6 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
     }
   }
 
-  #rejectPreviousPromiseInternal = (error: unknown): void => {
-    if (this.#rejectPreviousPromise) {
-      this.#rejectPreviousPromise(error)
-      this.#rejectPreviousPromise = null
-    }
-  }
-
   #clearTimeout = (): void => {
     if (this.#timeoutId) {
       clearTimeout(this.#timeoutId)
@@ -396,7 +399,7 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
   #cancelPendingExecution = (): void => {
     this.#clearTimeout()
     if (this.#resolvePreviousPromise) {
-      this.#resolvePreviousPromise(this.store.state.lastResult)
+      this.#resolvePreviousPromiseInternal()
       this.#resolvePreviousPromise = null
     }
     this.#setState({

package/src/batcher.ts

@@ -66,7 +66,7 @@ export interface BatcherOptions<TValue> {
   /**
    * Callback fired after a batch is processed
    */
-  onExecute?: (batcher: Batcher<TValue>) => void
+  onExecute?: (batch: Array<TValue>, batcher: Batcher<TValue>) => void
   /**
    * Callback fired after items are added to the batcher
    */
@@ -124,7 +124,7 @@ const defaultOptions: BatcherOptionsWithOptionalCallbacks<any> = {
  *   {
  *     maxSize: 5,
  *     wait: 2000,
- *     onExecute: (batcher) => console.log('Batch executed:', batcher.peekAllItems())
+ *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  *   }
  * );
  *
@@ -228,7 +228,7 @@ export class Batcher<TValue> {
       executionCount: this.store.state.executionCount + 1,
       totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,
     })
-    this.options.onExecute?.(this)
+    this.options.onExecute?.(batch, this)
   }
 
   /**
@@ -278,7 +278,7 @@ export class Batcher<TValue> {
  *   (items) => console.log('Processing:', items),
  *   {
  *     maxSize: 3,
- *     onExecute: (batcher) => console.log('Batch executed')
+ *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  *   }
  * );
  *