@tanstack/pacer 0.2.0 → 0.4.0

package/dist/esm/throttler.js

@@ -1,17 +1,16 @@
 const defaultOptions = {
   enabled: true,
   leading: true,
-  trailing: true,
-  wait: 0,
   onExecute: () => {
-  }
+  },
+  trailing: true,
+  wait: 0
 };
 class Throttler {
   constructor(fn, initialOptions) {
     this.fn = fn;
     this._executionCount = 0;
     this._lastExecutionTime = 0;
-    this._isPending = false;
     this._options = {
       ...defaultOptions,
       ...initialOptions
@@ -22,11 +21,10 @@ class Throttler {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this._options = {
-      ...this._options,
-      ...newOptions
-    };
-    return this._options;
+    this._options = { ...this._options, ...newOptions };
+    if (!this._options.enabled) {
+      this.cancel();
+    }
   }
   /**
    * Returns the current throttler options
@@ -59,26 +57,18 @@ class Throttler {
   maybeExecute(...args) {
     const now = Date.now();
     const timeSinceLastExecution = now - this._lastExecutionTime;
-    if (timeSinceLastExecution >= this._options.wait) {
-      if (this._options.leading) {
-        this.executeFunction(...args);
-      }
-      this._lastExecutionTime = now;
-      this._isPending = false;
+    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {
+      this.executeFunction(...args);
     } else {
       this._lastArgs = args;
       if (!this._timeoutId && this._options.trailing) {
-        this._isPending = true;
+        const _timeSinceLastExecution = this._lastExecutionTime ? now - this._lastExecutionTime : 0;
+        const timeoutDuration = this._options.wait - _timeSinceLastExecution;
         this._timeoutId = setTimeout(() => {
-          if (this._lastArgs) {
+          if (this._lastArgs !== void 0) {
             this.executeFunction(...this._lastArgs);
-            this._lastArgs = void 0;
           }
-          this._lastExecutionTime = Date.now();
-          this._timeoutId = void 0;
-          this._isPending = false;
-          this._options.onExecute(this);
-        }, this._options.wait - timeSinceLastExecution);
+        }, timeoutDuration);
       }
     }
   }
@@ -86,6 +76,10 @@ class Throttler {
     if (!this._options.enabled) 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.
@@ -101,21 +95,8 @@ class Throttler {
       clearTimeout(this._timeoutId);
       this._timeoutId = void 0;
       this._lastArgs = void 0;
-      this._isPending = false;
     }
   }
-  /**
-   * 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._options.enabled && this._isPending;
-  }
   /**
    * Returns the last execution time
    */
@@ -128,6 +109,18 @@ class Throttler {
   getNextExecutionTime() {
     return this._lastExecutionTime + this._options.wait;
   }
+  /**
+   * 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._options.enabled && !!this._timeoutId;
+  }
 }
 function throttle(fn, initialOptions) {
   const throttler = new Throttler(fn, initialOptions);

package/dist/esm/throttler.js.map

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

package/dist/esm/types.d.ts

@@ -1,12 +1,8 @@
 /**
  * Represents a function that can be called with any arguments and returns any value.
- * @template TArgs - The type of the arguments the function can be called with.
- * @returns The return value of the function.
  */
-export type AnyFunction<TArgs extends Array<any> = Array<any>> = (...args: TArgs) => any;
+export type AnyFunction = (...args: Array<any>) => any;
 /**
  * Represents an asynchronous function that can be called with any arguments and returns a promise.
- * @template TArgs - The type of the arguments the function can be called with.
- * @returns A promise that resolves to the return value of the function.
  */
-export type AnyAsyncFunction<TArgs extends Array<any> = Array<any>> = (...args: TArgs) => Promise<any>;
+export type AnyAsyncFunction = (...args: Array<any>) => Promise<any>;

package/dist/esm/utils.d.ts

@@ -1 +1 @@
-export declare function bindInstanceMethods<T extends Record<string, any>>(instance: T): any;
+export declare function bindInstanceMethods<T extends Record<string, any>>(instance: T): T;

package/dist/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":["../../src/utils.ts"],"sourcesContent":["export function bindInstanceMethods<T extends Record<string, any>>(\n  instance: T,\n) {\n  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance))\n    .filter((key) => typeof instance[key as keyof T] === 'function')\n    .reduce((acc: any, key) => {\n      const method = instance[key as keyof T]\n      if (typeof method === 'function') {\n        acc[key] = method.bind(instance)\n      }\n      return acc\n    }, {} as T)\n}\n"],"names":[],"mappings":"AAAO,SAAS,oBACd,UACA;AACA,SAAO,OAAO,oBAAoB,OAAO,eAAe,QAAQ,CAAC,EAC9D,OAAO,CAAC,QAAQ,OAAO,SAAS,GAAc,MAAM,UAAU,EAC9D,OAAO,CAAC,KAAU,QAAQ;AACnB,UAAA,SAAS,SAAS,GAAc;AAClC,QAAA,OAAO,WAAW,YAAY;AAChC,UAAI,GAAG,IAAI,OAAO,KAAK,QAAQ;AAAA,IAAA;AAE1B,WAAA;AAAA,EACT,GAAG,EAAO;AACd;"}
+{"version":3,"file":"utils.js","sources":["../../src/utils.ts"],"sourcesContent":["export function bindInstanceMethods<T extends Record<string, any>>(\n  instance: T,\n): T {\n  return Object.getOwnPropertyNames(Object.getPrototypeOf(instance))\n    .filter((key) => typeof instance[key as keyof T] === 'function')\n    .reduce((acc: any, key) => {\n      const method = instance[key as keyof T]\n      if (typeof method === 'function') {\n        acc[key] = method.bind(instance)\n      }\n      return acc\n    }, {} as T)\n}\n"],"names":[],"mappings":"AAAO,SAAS,oBACd,UACG;AACH,SAAO,OAAO,oBAAoB,OAAO,eAAe,QAAQ,CAAC,EAC9D,OAAO,CAAC,QAAQ,OAAO,SAAS,GAAc,MAAM,UAAU,EAC9D,OAAO,CAAC,KAAU,QAAQ;AACnB,UAAA,SAAS,SAAS,GAAc;AAClC,QAAA,OAAO,WAAW,YAAY;AAChC,UAAI,GAAG,IAAI,OAAO,KAAK,QAAQ;AAAA,IAAA;AAE1B,WAAA;AAAA,EACT,GAAG,EAAO;AACd;"}

package/package.json

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

package/src/async-debouncer.ts

@@ -3,10 +3,7 @@ import type { AnyAsyncFunction } from './types'
 /**
  * Options for configuring an async debounced function
  */
-export interface AsyncDebouncerOptions<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
-> {
+export interface AsyncDebouncerOptions<TFn extends AnyAsyncFunction> {
   /**
    * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
    * Defaults to true.
@@ -20,11 +17,15 @@ export interface AsyncDebouncerOptions<
   /**
    * Optional error handler for when the debounced function throws
    */
-  onError?: (error: unknown) => void
+  onError?: (error: unknown, debouncer: AsyncDebouncer<TFn>) => void
   /**
-   * Optional function to call when the debounced function is executed
+   * Optional callback to call when the debounced function is executed
    */
-  onExecute?: (debouncer: AsyncDebouncer<TFn, TArgs>) => void
+  onSettled?: (debouncer: AsyncDebouncer<TFn>) => void
+  /**
+   * Optional callback to call when the debounced function is executed
+   */
+  onSuccess?: (result: ReturnType<TFn>, debouncer: AsyncDebouncer<TFn>) => void
   /**
    * Whether to execute on the trailing edge of the timeout.
    * Defaults to true.
@@ -37,12 +38,13 @@ export interface AsyncDebouncerOptions<
   wait: number
 }
 
-const defaultOptions: Required<AsyncDebouncerOptions<any, any>> = {
+const defaultOptions: Required<AsyncDebouncerOptions<any>> = {
   enabled: true,
   leading: false,
-  trailing: true,
   onError: () => {},
-  onExecute: () => {},
+  onSettled: () => {},
+  onSuccess: () => {},
+  trailing: true,
   wait: 0,
 }
 
@@ -56,33 +58,38 @@ const defaultOptions: Required<AsyncDebouncerOptions<any, any>> = {
  * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
  * the function stops being called for the specified delay period.
  *
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the debounced function.
+ *
  * @example
  * ```ts
  * const asyncDebouncer = new AsyncDebouncer(async (value: string) => {
- *   await searchAPI(value);
+ *   const results = await searchAPI(value);
+ *   return results; // Return value is preserved
  * }, { wait: 500 });
  *
  * // Called on each keystroke but only executes after 500ms of no typing
- * inputElement.addEventListener('input', () => {
- *   asyncDebouncer.maybeExecute(inputElement.value);
- * });
+ * // Returns the API response directly
+ * const results = await asyncDebouncer.maybeExecute(inputElement.value);
  * ```
  */
-export class AsyncDebouncer<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
-> {
+export class AsyncDebouncer<TFn extends AnyAsyncFunction> {
   private _abortController: AbortController | null = null
-  private _executionCount = 0
-  private _isExecuting = false
-  private _lastArgs: TArgs | undefined
-  private _options: Required<AsyncDebouncerOptions<TFn, TArgs>>
-  private _timeoutId: ReturnType<typeof setTimeout> | null = null
   private _canLeadingExecute = true
+  private _errorCount = 0
+  private _isExecuting = false
+  private _isPending = false
+  private _lastArgs: Parameters<TFn> | undefined
+  private _lastResult: ReturnType<TFn> | undefined
+  private _options: Required<AsyncDebouncerOptions<TFn>>
+  private _settleCount = 0
+  private _successCount = 0
+  private _timeoutId: NodeJS.Timeout | null = null
 
   constructor(
     private fn: TFn,
-    initialOptions: AsyncDebouncerOptions<TFn, TArgs>,
+    initialOptions: AsyncDebouncerOptions<TFn>,
   ) {
     this._options = {
       ...defaultOptions,
@@ -94,20 +101,19 @@ export class AsyncDebouncer<
    * Updates the debouncer options
    * Returns the new options state
    */
-  setOptions(
-    newOptions: Partial<AsyncDebouncerOptions<TFn, TArgs>>,
-  ): Required<AsyncDebouncerOptions<TFn, TArgs>> {
-    this._options = {
-      ...this._options,
-      ...newOptions,
+  setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn>>): void {
+    this._options = { ...this._options, ...newOptions }
+
+    // End the pending state if the debouncer is disabled
+    if (!this._options.enabled) {
+      this._isPending = false
     }
-    return this._options
   }
 
   /**
    * Returns the current debouncer options
    */
-  getOptions(): Required<AsyncDebouncerOptions<TFn, TArgs>> {
+  getOptions(): Required<AsyncDebouncerOptions<TFn>> {
     return this._options
   }
 
@@ -115,61 +121,65 @@ export class AsyncDebouncer<
    * Attempts to execute the debounced function
    * If a call is already in progress, it will be queued
    */
-  async maybeExecute(...args: TArgs): Promise<void> {
-    this.cancel()
+  async maybeExecute(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
+    this._cancel()
     this._lastArgs = args
 
     // Handle leading execution
     if (this._options.leading && this._canLeadingExecute) {
       this._canLeadingExecute = false
       await this.executeFunction(...args)
+      return this._lastResult
+    }
+
+    // Handle trailing execution
+    if (this._options.trailing) {
+      this._isPending = true
     }
 
     return new Promise((resolve) => {
       this._timeoutId = setTimeout(async () => {
-        if (this._isExecuting) {
-          resolve()
-          return
+        // Execute trailing if enabled
+        if (this._options.trailing && this._lastArgs) {
+          await this.executeFunction(...this._lastArgs)
         }
 
+        // Reset state and resolve
         this._canLeadingExecute = true
-        // Execute trailing only if enabled
-        if (this._options.trailing) {
-          this._abortController = new AbortController()
-          try {
-            this._isExecuting = true
-            if (this._lastArgs) {
-              await this.executeFunction(...this._lastArgs)
-            }
-          } catch (error) {
-            try {
-              this._options.onError(error)
-            } catch {
-              console.error('Error in error handler', error)
-            }
-          } finally {
-            this._isExecuting = false
-            this._abortController = null
-            resolve()
-          }
-        } else {
-          resolve()
-        }
+        resolve(this._lastResult)
       }, this._options.wait)
     })
   }
 
-  private async executeFunction(...args: TArgs): Promise<void> {
-    if (!this._options.enabled) return
-    this._executionCount++
-    await this.fn(...args)
-    this._options.onExecute(this)
+  private async executeFunction(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
+    if (!this._options.enabled) return undefined
+    this._abortController = new AbortController()
+    try {
+      this._isExecuting = true
+      this._lastResult = await this.fn(...args) // EXECUTE!
+      this._successCount++
+      this._options.onSuccess(this._lastResult!, this)
+    } catch (error) {
+      this._errorCount++
+      this._options.onError(error, this)
+    } finally {
+      this._isExecuting = false
+      this._isPending = false
+      this._settleCount++
+      this._abortController = null
+      this._options.onSettled(this)
+    }
+    return this._lastResult
   }
 
   /**
-   * Cancels any pending execution
+   * Cancel without resetting _canLeadingExecute
    */
-  cancel(): void {
+  private _cancel(): void {
     if (this._timeoutId) {
       clearTimeout(this._timeoutId)
       this._timeoutId = null
@@ -179,23 +189,58 @@ export class AsyncDebouncer<
       this._abortController = null
     }
     this._lastArgs = undefined
+    this._isPending = false
+    this._isExecuting = false
+  }
+
+  /**
+   * Cancels any pending execution or aborts any execution in progress
+   */
+  cancel(): void {
     this._canLeadingExecute = true
+    this._cancel()
+  }
+
+  /**
+   * Returns the last result of the debounced function
+   */
+  getLastResult(): ReturnType<TFn> | undefined {
+    return this._lastResult
+  }
+
+  /**
+   * Returns the number of times the function has been executed successfully
+   */
+  getSuccessCount(): number {
+    return this._successCount
   }
 
   /**
-   * Returns the number of times the function has been executed
+   * Returns the number of times the function has settled (completed or errored)
    */
-  getExecutionCount(): number {
-    return this._executionCount
+  getSettleCount(): number {
+    return this._settleCount
   }
 
   /**
-   * Returns `true` if there is a pending execution
+   * Returns the number of times the function has errored
+   */
+  getErrorCount(): number {
+    return this._errorCount
+  }
+
+  /**
+   * Returns `true` if there is a pending execution queued up for trailing execution
    */
   getIsPending(): boolean {
-    return (
-      this._options.enabled && (this._timeoutId !== null || this._isExecuting)
-    )
+    return this._options.enabled && this._isPending
+  }
+
+  /**
+   * Returns `true` if there is currently an execution in progress
+   */
+  getIsExecuting(): boolean {
+    return this._isExecuting
   }
 }
 
@@ -204,22 +249,26 @@ export class AsyncDebouncer<
  * The debounced function will only execute once the wait period has elapsed without any new calls.
  * If called again during the wait period, the timer resets and a new wait period begins.
  *
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the debounced function.
+ *
  * @example
  * ```ts
  * const debounced = asyncDebounce(async (value: string) => {
- *   await saveToAPI(value);
+ *   const result = await saveToAPI(value);
+ *   return result; // Return value is preserved
  * }, { wait: 1000 });
  *
  * // Will only execute once, 1 second after the last call
- * await debounced("first");  // Cancelled
- * await debounced("second"); // Cancelled
- * await debounced("third");  // Executes after 1s
+ * // Returns the API response directly
+ * const result = await debounced("third");
  * ```
  */
-export function asyncDebounce<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
->(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions<TFn, TArgs>, 'enabled'>) {
+export function asyncDebounce<TFn extends AnyAsyncFunction>(
+  fn: TFn,
+  initialOptions: Omit<AsyncDebouncerOptions<TFn>, 'enabled'>,
+) {
   const asyncDebouncer = new AsyncDebouncer(fn, initialOptions)
   return asyncDebouncer.maybeExecute.bind(asyncDebouncer)
 }