@tanstack/pacer 0.8.0 → 0.9.0

package/dist/esm/throttler.d.ts

@@ -1,4 +1,31 @@
+import { Store } from '@tanstack/store';
 import { AnyFunction } from './types.js';
+export interface ThrottlerState<TFn extends AnyFunction> {
+    /**
+     * Number of function executions that have been completed
+     */
+    executionCount: number;
+    /**
+     * The arguments from the most recent call to maybeExecute
+     */
+    lastArgs: Parameters<TFn> | undefined;
+    /**
+     * Timestamp of the last function execution in milliseconds
+     */
+    lastExecutionTime: number;
+    /**
+     * Timestamp when the next execution can occur in milliseconds
+     */
+    nextExecutionTime: number;
+    /**
+     * Whether the throttler is waiting for the timeout to trigger execution
+     */
+    isPending: boolean;
+    /**
+     * Current execution status - 'idle' when not active, 'pending' when waiting for timeout
+     */
+    status: 'disabled' | 'idle' | 'pending';
+}
 /**
  * Options for configuring a throttled function
  */
@@ -9,6 +36,10 @@ export interface ThrottlerOptions<TFn extends AnyFunction> {
      * Defaults to true.
      */
     enabled?: boolean | ((throttler: Throttler<TFn>) => boolean);
+    /**
+     * Initial state for the throttler
+     */
+    initialState?: Partial<ThrottlerState<TFn>>;
     /**
      * Whether to execute on the leading edge of the timeout.
      * Defaults to true.
@@ -43,6 +74,14 @@ export interface ThrottlerOptions<TFn extends AnyFunction> {
  *
  * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.
  *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via `throttler.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `throttler.state`
+ *
  * @example
  * ```ts
  * const throttler = new Throttler(
@@ -58,29 +97,15 @@ export interface ThrottlerOptions<TFn extends AnyFunction> {
  * ```
  */
 export declare class Throttler<TFn extends AnyFunction> {
+    #private;
     private fn;
-    private _executionCount;
-    private _lastArgs;
-    private _lastExecutionTime;
-    private _options;
-    private _timeoutId;
+    readonly store: Store<Readonly<ThrottlerState<TFn>>>;
+    options: ThrottlerOptions<TFn>;
     constructor(fn: TFn, initialOptions: ThrottlerOptions<TFn>);
     /**
      * Updates the throttler options
      */
-    setOptions(newOptions: Partial<ThrottlerOptions<TFn>>): void;
-    /**
-     * 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;
+    setOptions: (newOptions: Partial<ThrottlerOptions<TFn>>) => void;
     /**
      * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
      *
@@ -103,8 +128,11 @@ export declare class Throttler<TFn extends AnyFunction> {
      * throttled.maybeExecute('c', 'd');
      * ```
      */
-    maybeExecute(...args: Parameters<TFn>): void;
-    private execute;
+    maybeExecute: (...args: Parameters<TFn>) => void;
+    /**
+     * Processes the current pending execution immediately
+     */
+    flush: () => void;
     /**
      * Cancels any pending trailing execution and clears internal state.
      *
@@ -114,23 +142,11 @@ export declare class Throttler<TFn extends AnyFunction> {
      *
      * Has no effect if there is no pending execution.
      */
-    cancel(): void;
+    cancel: () => void;
     /**
-     * Returns the last execution time
+     * Resets the throttler state to its default values
      */
-    getLastExecutionTime(): number;
-    /**
-     * Returns the next execution time
-     */
-    getNextExecutionTime(): number;
-    /**
-     * Returns the number of times the function has been executed
-     */
-    getExecutionCount(): number;
-    /**
-     * Returns `true` if there is a pending execution
-     */
-    getIsPending(): boolean;
+    reset: () => void;
 }
 /**
  * Creates a throttled function that limits how often the provided function can execute.
@@ -145,6 +161,14 @@ export declare class Throttler<TFn extends AnyFunction> {
  * For handling bursts of events, consider using debounce() instead. For hard execution
  * limits, consider using rateLimit().
  *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via the underlying Throttler instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
  * @example
  * ```ts
  * // Basic throttling - max once per second

package/dist/esm/throttler.js

@@ -1,143 +1,127 @@
+import { Store } from "@tanstack/store";
 import { parseFunctionOrValue } from "./utils.js";
+function getDefaultThrottlerState() {
+  return structuredClone({
+    executionCount: 0,
+    isPending: false,
+    lastArgs: void 0,
+    lastExecutionTime: 0,
+    nextExecutionTime: 0,
+    status: "idle"
+  });
+}
 const defaultOptions = {
   enabled: true,
   leading: true,
-  onExecute: () => {
-  },
   trailing: true,
   wait: 0
 };
 class Throttler {
   constructor(fn, initialOptions) {
     this.fn = fn;
-    this._executionCount = 0;
-    this._lastExecutionTime = 0;
-    this._options = {
+    this.store = new Store(
+      getDefaultThrottlerState()
+    );
+    this.setOptions = (newOptions) => {
+      this.options = { ...this.options, ...newOptions };
+      if (!this.#getEnabled()) {
+        this.cancel();
+      }
+    };
+    this.#setState = (newState) => {
+      this.store.setState((state) => {
+        const combinedState = {
+          ...state,
+          ...newState
+        };
+        const { isPending } = combinedState;
+        return {
+          ...combinedState,
+          status: !this.#getEnabled() ? "disabled" : isPending ? "pending" : "idle"
+        };
+      });
+    };
+    this.#getEnabled = () => {
+      return !!parseFunctionOrValue(this.options.enabled, this);
+    };
+    this.#getWait = () => {
+      return parseFunctionOrValue(this.options.wait, this);
+    };
+    this.maybeExecute = (...args) => {
+      const now = Date.now();
+      const timeSinceLastExecution = now - this.store.state.lastExecutionTime;
+      const wait = this.#getWait();
+      if (this.options.leading && timeSinceLastExecution >= wait) {
+        this.#execute(...args);
+      } else {
+        this.#setState({
+          lastArgs: args
+        });
+        if (!this.#timeoutId && this.options.trailing) {
+          const _timeSinceLastExecution = this.store.state.lastExecutionTime ? now - this.store.state.lastExecutionTime : 0;
+          const timeoutDuration = wait - _timeSinceLastExecution;
+          this.#setState({ isPending: true });
+          this.#timeoutId = setTimeout(() => {
+            const { lastArgs } = this.store.state;
+            if (lastArgs !== void 0) {
+              this.#execute(...lastArgs);
+            }
+          }, timeoutDuration);
+        }
+      }
+    };
+    this.#execute = (...args) => {
+      if (!this.#getEnabled()) return;
+      this.fn(...args);
+      const lastExecutionTime = Date.now();
+      const nextExecutionTime = lastExecutionTime + this.#getWait();
+      this.#clearTimeout();
+      this.#setState({
+        executionCount: this.store.state.executionCount + 1,
+        lastExecutionTime,
+        nextExecutionTime,
+        isPending: false,
+        lastArgs: void 0
+      });
+      this.options.onExecute?.(this);
+    };
+    this.flush = () => {
+      if (this.store.state.isPending && this.store.state.lastArgs) {
+        this.#execute(...this.store.state.lastArgs);
+      }
+    };
+    this.#clearTimeout = () => {
+      if (this.#timeoutId) {
+        clearTimeout(this.#timeoutId);
+        this.#timeoutId = void 0;
+      }
+    };
+    this.cancel = () => {
+      this.#clearTimeout();
+      this.#setState({
+        lastArgs: void 0,
+        isPending: false
+      });
+    };
+    this.reset = () => {
+      this.#setState(getDefaultThrottlerState());
+    };
+    this.options = {
       ...defaultOptions,
       ...initialOptions
     };
+    this.#setState(this.options.initialState ?? {});
   }
-  /**
-   * Updates the throttler options
-   */
-  setOptions(newOptions) {
-    this._options = { ...this._options, ...newOptions };
-    if (!this._options.enabled) {
-      this.cancel();
-    }
-  }
-  /**
-   * Returns the current throttler options
-   */
-  getOptions() {
-    return this._options;
-  }
-  /**
-   * Returns the current enabled state of the throttler
-   */
-  getEnabled() {
-    return parseFunctionOrValue(this._options.enabled, this);
-  }
-  /**
-   * Returns the current wait time in milliseconds
-   */
-  getWait() {
-    return parseFunctionOrValue(this._options.wait, this);
-  }
-  /**
-   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
-   *
-   * - If enough time has passed since the last execution (>= wait period):
-   *   - With leading=true: Executes immediately
-   *   - With leading=false: Waits for the next trailing execution
-   *
-   * - If within the wait period:
-   *   - With trailing=true: Schedules execution for end of wait period
-   *   - With trailing=false: Drops the execution
-   *
-   * @example
-   * ```ts
-   * const throttled = new Throttler(fn, { wait: 1000 });
-   *
-   * // First call executes immediately
-   * throttled.maybeExecute('a', 'b');
-   *
-   * // Call during wait period - gets throttled
-   * throttled.maybeExecute('c', 'd');
-   * ```
-   */
-  maybeExecute(...args) {
-    const now = Date.now();
-    const timeSinceLastExecution = now - this._lastExecutionTime;
-    const wait = this.getWait();
-    if (this._options.leading && timeSinceLastExecution >= wait) {
-      this.execute(...args);
-    } else {
-      this._lastArgs = args;
-      if (!this._timeoutId && this._options.trailing) {
-        const _timeSinceLastExecution = this._lastExecutionTime ? now - this._lastExecutionTime : 0;
-        const timeoutDuration = wait - _timeSinceLastExecution;
-        this._timeoutId = setTimeout(() => {
-          if (this._lastArgs !== void 0) {
-            this.execute(...this._lastArgs);
-          }
-        }, timeoutDuration);
-      }
-    }
-  }
-  execute(...args) {
-    if (!this.getEnabled()) return;
-    this.fn(...args);
-    this._executionCount++;
-    this._lastExecutionTime = Date.now();
-    this._timeoutId = void 0;
-    this._lastArgs = void 0;
-    this._options.onExecute(this);
-  }
-  /**
-   * Cancels any pending trailing execution and clears internal state.
-   *
-   * If a trailing execution is scheduled (due to throttling with trailing=true),
-   * this will prevent that execution from occurring. The internal timeout and
-   * stored arguments will be cleared.
-   *
-   * Has no effect if there is no pending execution.
-   */
-  cancel() {
-    if (this._timeoutId) {
-      clearTimeout(this._timeoutId);
-      this._timeoutId = void 0;
-      this._lastArgs = void 0;
-    }
-  }
-  /**
-   * Returns the last execution time
-   */
-  getLastExecutionTime() {
-    return this._lastExecutionTime;
-  }
-  /**
-   * Returns the next execution time
-   */
-  getNextExecutionTime() {
-    return this._lastExecutionTime + this.getWait();
-  }
-  /**
-   * Returns the number of times the function has been executed
-   */
-  getExecutionCount() {
-    return this._executionCount;
-  }
-  /**
-   * Returns `true` if there is a pending execution
-   */
-  getIsPending() {
-    return this.getEnabled() && !!this._timeoutId;
-  }
+  #timeoutId;
+  #setState;
+  #getEnabled;
+  #getWait;
+  #execute;
+  #clearTimeout;
 }
 function throttle(fn, initialOptions) {
   const throttler = new Throttler(fn, initialOptions);
-  return throttler.maybeExecute.bind(throttler);
+  return throttler.maybeExecute;
 }
 export {
   Throttler,

package/dist/esm/throttler.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.js","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   */\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.execute(...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.execute(...this._lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  private execute(...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":[],"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,EAMF,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,WAAO,qBAAqB,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,UAAkB;AAChB,WAAO,qBAAqB,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,QAAQ,GAAG,IAAI;AAAA,IAAA,OACf;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,QAAQ,GAAG,KAAK,SAAS;AAAA,UAAA;AAAA,WAE/B,eAAe;AAAA,MAAA;AAAA,IACpB;AAAA,EACF;AAAA,EAGM,WAAW,MAA6B;AAC1C,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;"}
+{"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   * 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\n  /**\n   * Whether the throttler is waiting for the timeout to trigger execution\n   */\n  isPending: boolean\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  }\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;AAAA,IAAA;AAM/B,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;AAvJ9C,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,EAyBA;AA8BF;AAoCO,SAAS,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAClD,SAAO,UAAU;AACnB;"}

package/dist/esm/utils.d.ts

@@ -1,4 +1,3 @@
 import { AnyFunction } from './types.js';
 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/utils.js

@@ -4,20 +4,7 @@ function isFunction(value) {
 function parseFunctionOrValue(value, ...args) {
   return isFunction(value) ? value(...args) : value;
 }
-function bindInstanceMethods(instance) {
-  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance)).reduce(
-    (acc, key) => {
-      const method = instance[key];
-      if (isFunction(method)) {
-        acc[key] = method.bind(instance);
-      }
-      return acc;
-    },
-    instance
-  );
-}
 export {
-  bindInstanceMethods,
   isFunction,
   parseFunctionOrValue
 };

package/dist/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","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;"}
+{"version":3,"file":"utils.js","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"],"names":[],"mappings":"AAEO,SAAS,WAAkC,OAAwB;AACxE,SAAO,OAAO,UAAU;AAC1B;AAEO,SAAS,qBACd,UACG,MACA;AACH,SAAO,WAAW,KAAK,IAAI,MAAM,GAAG,IAAI,IAAI;AAC9C;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/pacer",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Utilities for debouncing, throttling, rate-limiting, queuing, and more.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -37,6 +37,16 @@
         "default": "./dist/cjs/index.cjs"
       }
     },
+    "./async-batcher": {
+      "import": {
+        "types": "./dist/esm/async-batcher.d.ts",
+        "default": "./dist/esm/async-batcher.js"
+      },
+      "require": {
+        "types": "./dist/cjs/async-batcher.d.cts",
+        "default": "./dist/cjs/async-batcher.cjs"
+      }
+    },
     "./async-debouncer": {
       "import": {
         "types": "./dist/esm/async-debouncer.d.ts",
@@ -87,16 +97,6 @@
         "default": "./dist/cjs/batcher.cjs"
       }
     },
-    "./compare": {
-      "import": {
-        "types": "./dist/esm/compare.d.ts",
-        "default": "./dist/esm/compare.js"
-      },
-      "require": {
-        "types": "./dist/cjs/compare.d.cts",
-        "default": "./dist/cjs/compare.cjs"
-      }
-    },
     "./debouncer": {
       "import": {
         "types": "./dist/esm/debouncer.d.ts",
@@ -160,6 +160,9 @@
     "dist/",
     "src"
   ],
+  "dependencies": {
+    "@tanstack/store": "^0.7.2"
+  },
   "scripts": {
     "clean": "premove ./build ./dist",
     "lint:fix": "eslint ./src --fix",