@tanstack/preact-pacer 0.19.4 → 0.20.0

package/dist/async-queuer/useAsyncQueuer.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the queuer state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Queue Size: {size}</div>\n   *   )}\n   * </queuer.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncQueuerState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncQueuerState<TValue>>>\n}\n\n/**\n * A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and queuer instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncQueuer instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `activeItems`: Items currently being processed by the queuer\n * - `errorCount`: Number of task executions that have resulted in errors\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `lastResult`: The result from the most recent task execution\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `settledCount`: Number of task executions that have completed (success or error)\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n * - `successCount`: Number of task executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Queue Size: {size}</div>\n *   )}\n * </asyncQueuer.Subscribe>\n *\n * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty,\n *     isFull: state.isFull\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     activeItems: state.activeItems,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settledCount: state.settledCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\n *     concurrency: 2,\n *     maxSize: 100,\n *     started: false,\n *     onSuccess: (result) => {\n *       console.log('Item processed:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Processing failed:', error);\n *     }\n *   },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as AsyncQueuerOptions<TValue>\n\n  const [asyncQueuer] = useState(() => {\n    const queuerInstance = new AsyncQueuer<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncQueuer<TValue, TSelected>\n\n    queuerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncQueuerState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(queuerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return queuerInstance\n  })\n\n  asyncQueuer.fn = fn\n  asyncQueuer.setOptions(mergedOptions)\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncQueuer,\n        state,\n      }) as PreactAsyncQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncQueuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4MA,SAAgB,eACd,IACA,UAAsC,EAAE,EACxC,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,eAAe,eAAe;EACnC,MAAM,iBAAiB,IAAI,YACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}
+{"version":3,"file":"useAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncQueuerOptions<\n  TValue,\n  TSelected = {},\n> extends AsyncQueuerOptions<TValue> {\n  /**\n   * Optional callback invoked when the component unmounts. Receives the queuer instance.\n   * When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc.\n   */\n  onUnmount?: (queuer: PreactAsyncQueuer<TValue, TSelected>) => void\n}\n\nexport interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the queuer state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Queue Size: {size}</div>\n   *   )}\n   * </queuer.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncQueuerState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncQueuerState<TValue>>>\n}\n\n/**\n * A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and queuer instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncQueuer instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `activeItems`: Items currently being processed by the queuer\n * - `errorCount`: Number of task executions that have resulted in errors\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `lastResult`: The result from the most recent task execution\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `settledCount`: Number of task executions that have completed (success or error)\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n * - `successCount`: Number of task executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook stops the queuer and aborts any in-flight task executions when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this. For example, to flush pending items instead:\n *\n * ```tsx\n * const queuer = useAsyncQueuer(fn, {\n *   concurrency: 2,\n *   started: false,\n *   onUnmount: (q) => q.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your task function updates Preact state, those updates may run after the component has\n * unmounted, which can cause \"setState on unmounted component\" warnings. Guard your callbacks\n * accordingly when using onUnmount with flush.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Queue Size: {size}</div>\n *   )}\n * </asyncQueuer.Subscribe>\n *\n * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty,\n *     isFull: state.isFull\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     activeItems: state.activeItems,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settledCount: state.settledCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\n *     concurrency: 2,\n *     maxSize: 100,\n *     started: false,\n *     onSuccess: (result) => {\n *       console.log('Item processed:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Processing failed:', error);\n *     }\n *   },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: PreactAsyncQueuerOptions<TValue, TSelected> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as PreactAsyncQueuerOptions<TValue, TSelected>\n  const [asyncQueuer] = useState(() => {\n    const queuerInstance = new AsyncQueuer<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncQueuer<TValue, TSelected>\n\n    queuerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncQueuerState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(queuerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return queuerInstance\n  })\n\n  asyncQueuer.fn = fn\n  asyncQueuer.setOptions(mergedOptions)\n\n  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n  useEffect(() => {\n    return () => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncQueuer)\n      } else {\n        asyncQueuer.stop()\n        asyncQueuer.abort()\n      }\n    }\n  }, [])\n  /* eslint-enable react-hooks/exhaustive-deps */\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncQueuer,\n        state,\n      }) as PreactAsyncQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncQueuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0OA,SAAgB,eACd,IACA,UAAuD,EAAE,EACzD,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,eAAe,eAAe;EACnC,MAAM,iBAAiB,IAAI,YACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;AAGrC,iBAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,YAAY;QAC/B;AACL,gBAAY,MAAM;AAClB,gBAAY,OAAO;;;IAGtB,EAAE,CAAC;CAGN,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}

package/dist/async-rate-limiter/index.cjs

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_useAsyncRateLimiter = require('./useAsyncRateLimiter.cjs');
 const require_useAsyncRateLimitedCallback = require('./useAsyncRateLimitedCallback.cjs');
 

package/dist/async-rate-limiter/index.d.cts

@@ -1,4 +1,4 @@
-import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
+import { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
 import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.cjs";
 export * from "@tanstack/pacer/async-rate-limiter";
-export { PreactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimitedCallback, useAsyncRateLimiter };

package/dist/async-rate-limiter/index.d.ts

@@ -1,4 +1,4 @@
-import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
+import { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
 import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.js";
 export * from "@tanstack/pacer/async-rate-limiter";
-export { PreactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimitedCallback, useAsyncRateLimiter };

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

@@ -1 +1 @@
-{"version":3,"file":"useAsyncRateLimitedCallback.cjs","names":["useAsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqBA,gDAAoB,IAAI,QAAQ,CAAC;AAC5D,uCACG,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}
+{"version":3,"file":"useAsyncRateLimitedCallback.cjs","names":["useAsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { PreactAsyncRateLimiterOptions } from './useAsyncRateLimiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqBA,gDAAoB,IAAI,QAAQ,CAAC;AAC5D,uCACG,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}

package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts

@@ -1,5 +1,5 @@
+import { PreactAsyncRateLimiterOptions } from "./useAsyncRateLimiter.cjs";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
-import { AsyncRateLimiterOptions } from "@tanstack/pacer/async-rate-limiter";
 
 //#region src/async-rate-limiter/useAsyncRateLimitedCallback.d.ts
 /**
@@ -55,7 +55,7 @@ import { AsyncRateLimiterOptions } from "@tanstack/pacer/async-rate-limiter";
  * );
  * ```
  */
-declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
 //#endregion
 export { useAsyncRateLimitedCallback };
 //# sourceMappingURL=useAsyncRateLimitedCallback.d.cts.map

package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts

@@ -1,4 +1,4 @@
-import { AsyncRateLimiterOptions } from "@tanstack/pacer/async-rate-limiter";
+import { PreactAsyncRateLimiterOptions } from "./useAsyncRateLimiter.js";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 
 //#region src/async-rate-limiter/useAsyncRateLimitedCallback.d.ts
@@ -55,7 +55,7 @@ import { AnyAsyncFunction } from "@tanstack/pacer/types";
  * );
  * ```
  */
-declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
 //#endregion
 export { useAsyncRateLimitedCallback };
 //# sourceMappingURL=useAsyncRateLimitedCallback.d.ts.map

package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncRateLimitedCallback.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqB,oBAAoB,IAAI,QAAQ,CAAC;AAC5D,QAAO,aACJ,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}
+{"version":3,"file":"useAsyncRateLimitedCallback.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { PreactAsyncRateLimiterOptions } from './useAsyncRateLimiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqB,oBAAoB,IAAI,QAAQ,CAAC;AAC5D,QAAO,aACJ,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}

package/dist/async-rate-limiter/useAsyncRateLimiter.cjs

@@ -62,6 +62,12 @@ let _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-lim
 * - `settleCount`: Number of function executions that have completed (success or error)
 * - `successCount`: Number of function executions that have completed successfully
 *
+* ## Unmount behavior
+*
+* By default, the hook aborts any in-flight execution when the component unmounts.
+* Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+* Use the `onUnmount` option to customize this.
+*
 * @example
 * ```tsx
 * // Default behavior - no reactive state subscriptions
@@ -185,6 +191,12 @@ function useAsyncRateLimiter(fn, options, selector = () => ({})) {
 	});
 	asyncRateLimiter.fn = fn;
 	asyncRateLimiter.setOptions(mergedOptions);
+	(0, preact_hooks.useEffect)(() => {
+		return () => {
+			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncRateLimiter);
+			else asyncRateLimiter.abort();
+		};
+	}, []);
 	const state = (0, _tanstack_preact_store.useStore)(asyncRateLimiter.store, selector);
 	return (0, preact_hooks.useMemo)(() => ({
 		...asyncRateLimiter,

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

@@ -1 +1 @@
-{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(rateLimiterInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACmC;CACxC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,qDAAmC;EACxC,MAAM,sBAAsB,IAAIC,oDAC9B,IACA,cACD;AAED,sBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,gDAAoB,oBAAoB,OAAO,MAAM,SAAS;AAEpE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,6CAAiB,iBAAiB,OAAO,SAAS;AAExD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}
+{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook aborts any in-flight execution when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, TSelected>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as PreactAsyncRateLimiterOptions<TFn, TSelected>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(rateLimiterInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n  useEffect(() => {\n    return () => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncRateLimiter)\n      } else {\n        asyncRateLimiter.abort()\n      }\n    }\n  }, [])\n  /* eslint-enable react-hooks/exhaustive-deps */\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsOA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACmC;CACxC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,qDAAmC;EACxC,MAAM,sBAAsB,IAAIC,oDAC9B,IACA,cACD;AAED,sBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,gDAAoB,oBAAoB,OAAO,MAAM,SAAS;AAEpE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;AAG1C,mCAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,iBAAiB;OAEzC,kBAAiB,OAAO;;IAG3B,EAAE,CAAC;CAGN,MAAM,6CAAiB,iBAAiB,OAAO,SAAS;AAExD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}

package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts

@@ -4,6 +4,13 @@ import { AnyAsyncFunction } from "@tanstack/pacer/types";
 import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
 
 //#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
+interface PreactAsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncRateLimiterOptions<TFn> {
+  /**
+   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.
+   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.
+   */
+  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void;
+}
 interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
   /**
    * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.
@@ -93,6 +100,12 @@ interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> e
  * - `settleCount`: Number of function executions that have completed (success or error)
  * - `successCount`: Number of function executions that have completed successfully
  *
+ * ## Unmount behavior
+ *
+ * By default, the hook aborts any in-flight execution when the component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this.
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -201,7 +214,7 @@ interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> e
  * const { isExecuting, lastResult, rejectionCount } = state;
  * ```
  */
-declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, TSelected>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
 //#endregion
-export { PreactAsyncRateLimiter, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter };
 //# sourceMappingURL=useAsyncRateLimiter.d.cts.map

package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts

@@ -4,6 +4,13 @@ import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 
 //#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
+interface PreactAsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncRateLimiterOptions<TFn> {
+  /**
+   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.
+   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.
+   */
+  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void;
+}
 interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
   /**
    * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.
@@ -93,6 +100,12 @@ interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> e
  * - `settleCount`: Number of function executions that have completed (success or error)
  * - `successCount`: Number of function executions that have completed successfully
  *
+ * ## Unmount behavior
+ *
+ * By default, the hook aborts any in-flight execution when the component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this.
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -201,7 +214,7 @@ interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> e
  * const { isExecuting, lastResult, rejectionCount } = state;
  * ```
  */
-declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, TSelected>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
 //#endregion
-export { PreactAsyncRateLimiter, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter };
 //# sourceMappingURL=useAsyncRateLimiter.d.ts.map

package/dist/async-rate-limiter/useAsyncRateLimiter.js

@@ -1,5 +1,5 @@
 import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
-import { useMemo, useState } from "preact/hooks";
+import { useEffect, useMemo, useState } from "preact/hooks";
 import { useStore } from "@tanstack/preact-store";
 import { AsyncRateLimiter } from "@tanstack/pacer/async-rate-limiter";
 
@@ -62,6 +62,12 @@ import { AsyncRateLimiter } from "@tanstack/pacer/async-rate-limiter";
 * - `settleCount`: Number of function executions that have completed (success or error)
 * - `successCount`: Number of function executions that have completed successfully
 *
+* ## Unmount behavior
+*
+* By default, the hook aborts any in-flight execution when the component unmounts.
+* Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+* Use the `onUnmount` option to customize this.
+*
 * @example
 * ```tsx
 * // Default behavior - no reactive state subscriptions
@@ -185,6 +191,12 @@ function useAsyncRateLimiter(fn, options, selector = () => ({})) {
 	});
 	asyncRateLimiter.fn = fn;
 	asyncRateLimiter.setOptions(mergedOptions);
+	useEffect(() => {
+		return () => {
+			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncRateLimiter);
+			else asyncRateLimiter.abort();
+		};
+	}, []);
 	const state = useStore(asyncRateLimiter.store, selector);
 	return useMemo(() => ({
 		...asyncRateLimiter,

package/dist/async-rate-limiter/useAsyncRateLimiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(rateLimiterInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACmC;CACxC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,oBAAoB,eAAe;EACxC,MAAM,sBAAsB,IAAI,iBAC9B,IACA,cACD;AAED,sBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,WAAW,SAAS,oBAAoB,OAAO,MAAM,SAAS;AAEpE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,QAAQ,SAAS,iBAAiB,OAAO,SAAS;AAExD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}
+{"version":3,"file":"useAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook aborts any in-flight execution when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, TSelected>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as PreactAsyncRateLimiterOptions<TFn, TSelected>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(rateLimiterInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n  useEffect(() => {\n    return () => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncRateLimiter)\n      } else {\n        asyncRateLimiter.abort()\n      }\n    }\n  }, [])\n  /* eslint-enable react-hooks/exhaustive-deps */\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsOA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACmC;CACxC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,oBAAoB,eAAe;EACxC,MAAM,sBAAsB,IAAI,iBAC9B,IACA,cACD;AAED,sBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,WAAW,SAAS,oBAAoB,OAAO,MAAM,SAAS;AAEpE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;AAG1C,iBAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,iBAAiB;OAEzC,kBAAiB,OAAO;;IAG3B,EAAE,CAAC;CAGN,MAAM,QAAQ,SAAS,iBAAiB,OAAO,SAAS;AAExD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}

package/dist/async-throttler/index.cjs

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_useAsyncThrottler = require('./useAsyncThrottler.cjs');
 const require_useAsyncThrottledCallback = require('./useAsyncThrottledCallback.cjs');
 

package/dist/async-throttler/index.d.cts

@@ -1,4 +1,4 @@
-import { PreactAsyncThrottler, useAsyncThrottler } from "./useAsyncThrottler.cjs";
+import { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottler } from "./useAsyncThrottler.cjs";
 import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.cjs";
 export * from "@tanstack/pacer/async-throttler";
-export { PreactAsyncThrottler, useAsyncThrottledCallback, useAsyncThrottler };
+export { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottledCallback, useAsyncThrottler };

package/dist/async-throttler/index.d.ts

@@ -1,4 +1,4 @@
-import { PreactAsyncThrottler, useAsyncThrottler } from "./useAsyncThrottler.js";
+import { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottler } from "./useAsyncThrottler.js";
 import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.js";
 export * from "@tanstack/pacer/async-throttler";
-export { PreactAsyncThrottler, useAsyncThrottledCallback, useAsyncThrottler };
+export { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottledCallback, useAsyncThrottler };

package/dist/async-throttler/useAsyncThrottledCallback.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncThrottledCallback.cjs","names":["useAsyncThrottler"],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmBA,4CAAkB,IAAI,QAAQ,CAAC;AACxD,uCACG,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}
+{"version":3,"file":"useAsyncThrottledCallback.cjs","names":["useAsyncThrottler"],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { PreactAsyncThrottlerOptions } from './useAsyncThrottler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncThrottlerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmBA,4CAAkB,IAAI,QAAQ,CAAC;AACxD,uCACG,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}

package/dist/async-throttler/useAsyncThrottledCallback.d.cts

@@ -1,5 +1,5 @@
+import { PreactAsyncThrottlerOptions } from "./useAsyncThrottler.cjs";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
-import { AsyncThrottlerOptions } from "@tanstack/pacer/async-throttler";
 
 //#region src/async-throttler/useAsyncThrottledCallback.d.ts
 /**
@@ -38,7 +38,7 @@ import { AsyncThrottlerOptions } from "@tanstack/pacer/async-throttler";
  * <button onClick={() => handleApiCall(formData)}>Send</button>
  * ```
  */
-declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncThrottlerOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
 //#endregion
 export { useAsyncThrottledCallback };
 //# sourceMappingURL=useAsyncThrottledCallback.d.cts.map

package/dist/async-throttler/useAsyncThrottledCallback.d.ts

@@ -1,4 +1,4 @@
-import { AsyncThrottlerOptions } from "@tanstack/pacer/async-throttler";
+import { PreactAsyncThrottlerOptions } from "./useAsyncThrottler.js";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 
 //#region src/async-throttler/useAsyncThrottledCallback.d.ts
@@ -38,7 +38,7 @@ import { AnyAsyncFunction } from "@tanstack/pacer/types";
  * <button onClick={() => handleApiCall(formData)}>Send</button>
  * ```
  */
-declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncThrottlerOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
 //#endregion
 export { useAsyncThrottledCallback };
 //# sourceMappingURL=useAsyncThrottledCallback.d.ts.map

package/dist/async-throttler/useAsyncThrottledCallback.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncThrottledCallback.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmB,kBAAkB,IAAI,QAAQ,CAAC;AACxD,QAAO,aACJ,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}
+{"version":3,"file":"useAsyncThrottledCallback.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { PreactAsyncThrottlerOptions } from './useAsyncThrottler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncThrottlerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmB,kBAAkB,IAAI,QAAQ,CAAC;AACxD,QAAO,aACJ,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}

package/dist/async-throttler/useAsyncThrottler.cjs

@@ -58,6 +58,24 @@ let _tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler")
 * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
 * - `successCount`: Number of function executions that have completed successfully
 *
+* ## Unmount behavior
+*
+* By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
+* Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+*
+* ```tsx
+* const throttler = useAsyncThrottler(fn, {
+*   wait: 1000,
+*   onUnmount: (t) => t.flush()
+* });
+* ```
+*
+* Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
+* If your throttled function updates Preact state, those updates may run after the component has
+* unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
+* accordingly when using onUnmount with flush.
+*
 * @example
 * ```tsx
 * // Default behavior - no reactive state subscriptions
@@ -169,8 +187,14 @@ function useAsyncThrottler(fn, options, selector = () => ({})) {
 	asyncThrottler.setOptions(mergedOptions);
 	const state = (0, _tanstack_preact_store.useStore)(asyncThrottler.store, selector);
 	(0, preact_hooks.useEffect)(() => {
-		return () => asyncThrottler.cancel();
-	}, [asyncThrottler]);
+		return () => {
+			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncThrottler);
+			else {
+				asyncThrottler.cancel();
+				asyncThrottler.abort();
+			}
+		};
+	}, []);
 	return (0, preact_hooks.useMemo)(() => ({
 		...asyncThrottler,
 		state