@tanstack/pacer 0.15.3 → 0.16.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 { createKey, parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\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   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: 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 {\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    nextExecutionTime: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\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   * A key to identify the throttler.\n   * If provided, the throttler will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\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' | 'key'\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  key: string | undefined\n  options: ThrottlerOptions<TFn>\n  #timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    public fn: TFn,\n    initialOptions: ThrottlerOptions<TFn>,\n  ) {\n    this.key = createKey(initialOptions.key)\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    pacerEventClient.on('d-Throttler', (event) => {\n      if (event.payload.key !== this.key) return\n      this.#setState(event.payload.store.state as ThrottlerState<TFn>)\n      this.setOptions(event.payload.options)\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    // 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    emitChange('Throttler', this)\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    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\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":";;;AAoCA,SAAS,2BAEgB;AACvB,SAAO;AAAA,IACL,gBAAgB;AAAA,IAChB,WAAW;AAAA,IACX,UAAU;AAAA,IACV,mBAAmB;AAAA,IACnB,mBAAmB;AAAA,IACnB,QAAQ;AAAA,IACR,mBAAmB;AAAA,EAAA;AAEvB;AA2CA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,MAAM;AACR;AAqCO,MAAM,UAAmC;AAAA,EAQ9C,YACS,IACP,gBACA;AAFO,SAAA,KAAA;AART,SAAS,QAA8C,IAAI;AAAA,MACzD,yBAAA;AAAA,IAAyB;AA2B3B,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;AACD,iBAAW,aAAa,IAAI;AAAA,IAAA;AAG9B,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,WAAK,UAAU;AAAA,QACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB;AAAA,MAAA,CACzD;AAED,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;AAxK9C,SAAK,MAAM,UAAU,eAAe,GAAG;AACvC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAE9C,qBAAiB,GAAG,eAAe,CAAC,UAAU;AAC5C,UAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,WAAK,UAAU,MAAM,QAAQ,MAAM,KAA4B;AAC/D,WAAK,WAAW,MAAM,QAAQ,OAAO;AAAA,IAAA,CACtC;AAAA,EAAA;AAAA,EAjBH;AAAA,EAgCA;AAAA,EAmBA;AAAA,EAIA;AAAA,EA6DA;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 { createKey, parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\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   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: 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 {\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    nextExecutionTime: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\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   * A key to identify the throttler.\n   * If provided, the throttler will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\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\n/**\n * Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances.\n */\nexport function throttlerOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<ThrottlerOptions<TFn>> = Partial<\n    ThrottlerOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<ThrottlerOptions<any>>,\n  'initialState' | 'onExecute' | 'key'\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 * This synchronous version is lighter weight and often all you need - upgrade to AsyncThrottler when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\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  key: string | undefined\n  options: ThrottlerOptions<TFn>\n  #timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    public fn: TFn,\n    initialOptions: ThrottlerOptions<TFn>,\n  ) {\n    this.key = createKey(initialOptions.key)\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    pacerEventClient.on('d-Throttler', (event) => {\n      if (event.payload.key !== this.key) return\n      this.#setState(event.payload.store.state as ThrottlerState<TFn>)\n      this.setOptions(event.payload.options)\n    })\n  }\n\n  /**\n   * Emits a change event for the throttler instance. Mostly useful for devtools.\n   */\n  _emit = () => emitChange('Throttler', this)\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    emitChange('Throttler', this)\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    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\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 * This synchronous version is lighter weight and often all you need - upgrade to asyncThrottle when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\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":";;;AAoCA,SAAS,2BAEgB;AACvB,SAAO;AAAA,IACL,gBAAgB;AAAA,IAChB,WAAW;AAAA,IACX,UAAU;AAAA,IACV,mBAAmB;AAAA,IACnB,mBAAmB;AAAA,IACnB,QAAQ;AAAA,IACR,mBAAmB;AAAA,EAAA;AAEvB;AA8CO,SAAS,iBAKd,SAA6B;AAC7B,SAAO;AACT;AAEA,MAAM,iBAGF;AAAA,EACF,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,MAAM;AACR;AAsCO,MAAM,UAAmC;AAAA,EAQ9C,YACS,IACP,gBACA;AAFO,SAAA,KAAA;AART,SAAS,QAA8C,IAAI;AAAA,MACzD,yBAAA;AAAA,IAAyB;AA2B3B,SAAA,QAAQ,MAAM,WAAW,aAAa,IAAI;AAK1C,SAAA,aAAa,CAAC,eAAqD;AACjE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAGrC,UAAI,CAAC,KAAK,eAAe;AACvB,aAAK,OAAA;AAAA,MACP;AAAA,IACF;AAEA,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,MAEV,CAAC;AACD,iBAAW,aAAa,IAAI;AAAA,IAC9B;AAEA,SAAA,cAAc,MAAe;AAC3B,aAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;AAAA,IAC1D;AAEA,SAAA,WAAW,MAAc;AACvB,aAAO,qBAAqB,KAAK,QAAQ,MAAM,IAAI;AAAA,IACrD;AAwBA,SAAA,eAAe,IAAI,SAAgC;AACjD,WAAK,UAAU;AAAA,QACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB;AAAA,MAAA,CACzD;AAED,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,MACvB,OAAO;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,YAC3B;AAAA,UACF,GAAG,eAAe;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAEA,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,QACjD;AAAA,MACF,GAAG,KAAK,UAAU;AAAA,IACpB;AAKA,SAAA,QAAQ,MAAY;AAClB,UAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;AAC3D,aAAK,SAAS,GAAG,KAAK,MAAM,MAAM,QAAQ;AAAA,MAC5C;AAAA,IACF;AAEA,SAAA,gBAAgB,MAAY;AAC1B,UAAI,KAAK,YAAY;AACnB,qBAAa,KAAK,UAAU;AAC5B,aAAK,aAAa;AAAA,MACpB;AAAA,IACF;AAWA,SAAA,SAAS,MAAY;AACnB,WAAK,cAAA;AACL,WAAK,UAAU;AAAA,QACb,UAAU;AAAA,QACV,WAAW;AAAA,MAAA,CACZ;AAAA,IACH;AAKA,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,0BAA+B;AAAA,IAChD;AA9KE,SAAK,MAAM,UAAU,eAAe,GAAG;AACvC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAE9C,qBAAiB,GAAG,eAAe,CAAC,UAAU;AAC5C,UAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,WAAK,UAAU,MAAM,QAAQ,MAAM,KAA4B;AAC/D,WAAK,WAAW,MAAM,QAAQ,OAAO;AAAA,IACvC,CAAC;AAAA,EACH;AAAA,EAlBA;AAAA,EAqCA;AAAA,EAmBA;AAAA,EAIA;AAAA,EA6DA;AAAA,EA8BA;AA8BF;AAsCO,SAAS,SACd,IACA,gBACA;AACA,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAClD,SAAO,UAAU;AACnB;"}

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 createKey(key?: string): string {\n  if (key) {\n    return key\n  }\n\n  if (\n    typeof crypto !== 'undefined' &&\n    typeof crypto.randomUUID === 'function'\n  ) {\n    return crypto.randomUUID()\n  }\n\n  return ''\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;AAEO,SAAS,UAAU,KAAsB;AAC9C,MAAI,KAAK;AACP,WAAO;AAAA,EAAA;AAGT,MACE,OAAO,WAAW,eAClB,OAAO,OAAO,eAAe,YAC7B;AACA,WAAO,OAAO,WAAA;AAAA,EAAW;AAG3B,SAAO;AACT;"}
+{"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 createKey(key?: string): string {\n  if (key) {\n    return key\n  }\n\n  if (\n    typeof crypto !== 'undefined' &&\n    typeof crypto.randomUUID === 'function'\n  ) {\n    return crypto.randomUUID()\n  }\n\n  return ''\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;AAEO,SAAS,UAAU,KAAsB;AAC9C,MAAI,KAAK;AACP,WAAO;AAAA,EACT;AAEA,MACE,OAAO,WAAW,eAClB,OAAO,OAAO,eAAe,YAC7B;AACA,WAAO,OAAO,WAAA;AAAA,EAChB;AAEA,SAAO;AACT;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/pacer",
-  "version": "0.15.3",
+  "version": "0.16.0",
   "description": "Utilities for debouncing, throttling, rate-limiting, queuing, and more.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -77,6 +77,16 @@
         "default": "./dist/cjs/async-rate-limiter.cjs"
       }
     },
+    "./async-retryer": {
+      "import": {
+        "types": "./dist/esm/async-retryer.d.ts",
+        "default": "./dist/esm/async-retryer.js"
+      },
+      "require": {
+        "types": "./dist/cjs/async-retryer.d.cts",
+        "default": "./dist/cjs/async-retryer.cjs"
+      }
+    },
     "./async-throttler": {
       "import": {
         "types": "./dist/esm/async-throttler.d.ts",
@@ -171,8 +181,8 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/devtools-event-client": "^0.2.5",
-    "@tanstack/store": "^0.7.5"
+    "@tanstack/devtools-event-client": "^0.3.2",
+    "@tanstack/store": "^0.7.7"
   },
   "scripts": {
     "clean": "premove ./build ./dist",

package/src/async-batcher.ts

@@ -1,6 +1,8 @@
 import { Store } from '@tanstack/store'
+import { AsyncRetryer } from './async-retryer'
 import { createKey, parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
+import type { AsyncRetryerOptions } from './async-retryer'
 import type { OptionalKeys } from './types'
 
 export interface AsyncBatcherState<TValue> {
@@ -8,6 +10,10 @@ export interface AsyncBatcherState<TValue> {
    * Number of batch executions that have resulted in errors
    */
   errorCount: number
+  /**
+   * Number of batch executions that have been executed
+   */
+  executeCount: number
   /**
    * Array of items that failed during batch processing
    */
@@ -61,6 +67,7 @@ export interface AsyncBatcherState<TValue> {
 function getDefaultAsyncBatcherState<TValue>(): AsyncBatcherState<TValue> {
   return {
     errorCount: 0,
+    executeCount: 0,
     failedItems: [],
     isEmpty: true,
     isExecuting: false,
@@ -80,6 +87,12 @@ function getDefaultAsyncBatcherState<TValue>(): AsyncBatcherState<TValue> {
  * Options for configuring an AsyncBatcher instance
  */
 export interface AsyncBatcherOptions<TValue> {
+  /**
+   * Options for configuring the underlying async retryer
+   */
+  asyncRetryerOptions?: AsyncRetryerOptions<
+    (items: Array<TValue>) => Promise<any>
+  >
   /**
    * Custom function to determine if a batch should be processed
    * Return true to process the batch immediately
@@ -108,7 +121,7 @@ export interface AsyncBatcherOptions<TValue> {
    * This can be used alongside throwOnError - the handler will be called before any error is thrown.
    */
   onError?: (
-    error: unknown,
+    error: Error,
     batch: Array<TValue>,
     batcher: AsyncBatcher<TValue>,
   ) => void
@@ -148,6 +161,19 @@ export interface AsyncBatcherOptions<TValue> {
   wait?: number | ((asyncBatcher: AsyncBatcher<TValue>) => number)
 }
 
+/**
+ * Utility function for sharing common `AsyncBatcherOptions` options between different `AsyncBatcher` instances.
+ *
+ */
+export function asyncBatcherOptions<
+  TValue = any,
+  TOptions extends Partial<AsyncBatcherOptions<TValue>> = Partial<
+    AsyncBatcherOptions<TValue>
+  >,
+>(options: TOptions): TOptions {
+  return options
+}
+
 type AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<
   Required<AsyncBatcherOptions<TValue>>,
   | 'initialState'
@@ -159,6 +185,9 @@ type AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<
 >
 
 const defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {
+  asyncRetryerOptions: {
+    maxAttempts: 1,
+  },
   getShouldExecute: () => false,
   maxSize: Infinity,
   started: true,
@@ -169,13 +198,19 @@ const defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {
 /**
  * A class that collects items and processes them in batches asynchronously.
  *
- * This is the async version of the Batcher class. Unlike the sync version, this async batcher:
- * - Handles promises and returns results from batch executions
- * - Provides error handling with configurable error behavior
- * - Tracks success, error, and settle counts separately
- * - Has state tracking for when batches are executing
- * - Returns the result of the batch function execution
+ * Async vs Sync Versions:
+ * The async version provides advanced features over the sync Batcher:
+ * - Returns promises that can be awaited for batch results
+ * - Built-in retry support via AsyncRetryer integration
+ * - Abort support to cancel in-flight batch executions
+ * - Cancel support to prevent pending batches from starting
+ * - Comprehensive error handling with onError callbacks and throwOnError control
+ * - Detailed execution tracking (success/error/settle counts)
+ *
+ * The sync Batcher is lighter weight and simpler when you don't need async features,
+ * return values, or execution control.
  *
+ * What is Batching?
  * Batching is a technique for grouping multiple operations together to be processed as a single unit.
  *
  * The AsyncBatcher provides a flexible way to implement async batching with configurable:
@@ -233,6 +268,10 @@ export class AsyncBatcher<TValue> {
   )
   key: string
   options: AsyncBatcherOptionsWithOptionalCallbacks<TValue>
+  asyncRetryers = new Map<
+    number,
+    AsyncRetryer<(items: Array<TValue>) => Promise<any>>
+  >()
   #timeoutId: NodeJS.Timeout | null = null
 
   constructor(
@@ -254,6 +293,11 @@ export class AsyncBatcher<TValue> {
     })
   }
 
+  /**
+   * Emits a change event for the async batcher instance. Mostly useful for devtools.
+   */
+  _emit = () => emitChange('AsyncBatcher', this)
+
   /**
    * Updates the async batcher options
    */
@@ -293,8 +337,12 @@ export class AsyncBatcher<TValue> {
   /**
    * Adds an item to the async batcher
    * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed
+   *
+   * @returns The result from 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 or throwOnError is true
    */
-  addItem = (item: TValue): void => {
+  addItem = async (item: TValue): Promise<any> => {
     this.#setState({
       items: [...this.store.state.items, item],
       isPending: this.options.wait !== Infinity,
@@ -306,10 +354,11 @@ export class AsyncBatcher<TValue> {
       this.options.getShouldExecute(this.store.state.items, this)
 
     if (shouldProcess) {
-      this.#execute()
+      return await this.#execute()
     } else if (this.options.wait !== Infinity) {
       this.#clearTimeout() // clear any pending timeout to replace it with a new one
       this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait())
+      await new Promise((resolve) => setTimeout(resolve, this.#getWait()))
     }
   }
 
@@ -330,14 +379,20 @@ export class AsyncBatcher<TValue> {
       return undefined
     }
 
+    const currentExecuteCount = this.store.state.executeCount + 1
     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)
 
-    this.#setState({ isExecuting: true })
+    this.#setState({ isExecuting: true, executeCount: currentExecuteCount })
 
     try {
-      const result = await this.fn(batch) // EXECUTE
+      const currentAsyncRetryer = new AsyncRetryer(
+        this.fn,
+        this.options.asyncRetryerOptions,
+      )
+      this.asyncRetryers.set(currentExecuteCount, currentAsyncRetryer)
+      const result = await currentAsyncRetryer.execute(batch) // EXECUTE
       this.#setState({
         totalItemsProcessed:
           this.store.state.totalItemsProcessed + batch.length,
@@ -352,12 +407,13 @@ export class AsyncBatcher<TValue> {
         failedItems: [...this.store.state.failedItems, ...batch],
         totalItemsFailed: this.store.state.totalItemsFailed + batch.length,
       })
-      this.options.onError?.(error, batch, this)
+      this.options.onError?.(error as Error, batch, this)
       if (this.options.throwOnError) {
         throw error
       }
       return undefined
     } finally {
+      this.asyncRetryers.delete(currentExecuteCount) // dispose retryer
       this.#setState({
         isExecuting: false,
         settleCount: this.store.state.settleCount + 1,
@@ -399,23 +455,95 @@ export class AsyncBatcher<TValue> {
     this.#setState({ items: [], failedItems: [], isPending: false })
   }
 
+  /**
+   * Returns the AbortSignal for a specific execution.
+   * If no executeCount is provided, returns the signal for the most recent execution.
+   * Returns null if no execution is found or not currently executing.
+   *
+   * @param executeCount - Optional specific execution to get signal for
+   * @example
+   * ```typescript
+   * const batcher = new AsyncBatcher(
+   *   async (items: string[]) => {
+   *     const signal = batcher.getAbortSignal()
+   *     if (signal) {
+   *       const response = await fetch('/api/batch', {
+   *         method: 'POST',
+   *         body: JSON.stringify(items),
+   *         signal
+   *       })
+   *       return response.json()
+   *     }
+   *   },
+   *   { maxSize: 10, wait: 100 }
+   * )
+   * ```
+   */
+  getAbortSignal(executeCount?: number): AbortSignal | null {
+    const count = executeCount ?? this.store.state.executeCount
+    const retryer = this.asyncRetryers.get(count)
+    return retryer?.getAbortSignal() ?? null
+  }
+
+  /**
+   * Aborts all ongoing executions with the internal abort controllers.
+   * Does NOT cancel any pending execution that have not started yet.
+   * Does NOT clear out the items.
+   */
+  abort = (): void => {
+    this.asyncRetryers.forEach((retryer) => retryer.abort())
+    this.asyncRetryers.clear()
+    this.#setState({
+      isExecuting: false,
+    })
+  }
+
+  /**
+   * Cancels any pending execution that have not started yet.
+   * Does NOT abort any execution already in progress.
+   * Does NOT clear out the items.
+   */
+  cancel = (): void => {
+    this.#clearTimeout()
+    this.#setState({
+      isPending: false,
+    })
+  }
+
   /**
    * Resets the async batcher state to its default values
    */
   reset = (): void => {
     this.#setState(getDefaultAsyncBatcherState<TValue>())
     this.options.onItemsChange?.(this)
+    this.asyncRetryers.forEach((retryer) => retryer.reset())
   }
 }
 
 /**
- * Creates an async batcher that processes items in batches
+ * Creates an async batcher that processes items in batches.
+ *
+ * Async vs Sync Versions:
+ * The async version provides advanced features over the sync batch function:
+ * - Returns promises that can be awaited for batch results
+ * - Built-in retry support via AsyncRetryer integration
+ * - Abort support to cancel in-flight batch executions
+ * - Cancel support to prevent pending batches from starting
+ * - Comprehensive error handling with onError callbacks and throwOnError control
+ * - Detailed execution tracking (success/error/settle counts)
  *
- * Unlike the sync batcher, this async version:
- * - Handles promises and returns results from batch executions
- * - Provides error handling with configurable error behavior
- * - Tracks success, error, and settle counts separately
- * - Has state tracking for when batches are executing
+ * The sync batch function is lighter weight and simpler when you don't need async features,
+ * return values, or execution control.
+ *
+ * What is Batching?
+ * Batching is a technique for grouping multiple operations together to be processed as a single unit.
+ *
+ * Configuration Options:
+ * - `maxSize`: Maximum number of items per batch (default: Infinity)
+ * - `wait`: Time to wait before processing batch (default: Infinity)
+ * - `getShouldExecute`: Custom logic to trigger batch processing
+ * - `asyncRetryerOptions`: Configure retry behavior for batch executions
+ * - `started`: Whether to start processing immediately (default: true)
  *
  * Error Handling:
  * - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, and batcher instance
@@ -430,7 +558,6 @@ export class AsyncBatcher<TValue> {
  * - Use `onSuccess` callback to react to successful batch execution and implement custom logic
  * - Use `onError` callback to react to batch execution errors and implement custom error handling
  * - Use `onSettled` callback to react to batch execution completion (success or error) and implement custom logic
- * - Use `onExecute` callback to react to batch execution and implement custom logic
  * - Use `onItemsChange` callback to react to items being added or removed from the batcher
  * - The state includes total items processed, success/error counts, and execution status
  * - State can be accessed via the underlying AsyncBatcher instance's `store.state` property