@tanstack/preact-pacer 0.19.4 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/README.md +6 -6
  2. package/dist/async-batcher/index.cjs +1 -0
  3. package/dist/async-batcher/index.d.cts +2 -2
  4. package/dist/async-batcher/index.d.ts +2 -2
  5. package/dist/async-batcher/useAsyncBatchedCallback.cjs +2 -2
  6. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +1 -1
  7. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +2 -3
  8. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -3
  9. package/dist/async-batcher/useAsyncBatchedCallback.js +2 -2
  10. package/dist/async-batcher/useAsyncBatchedCallback.js.map +1 -1
  11. package/dist/async-batcher/useAsyncBatcher.cjs +30 -2
  12. package/dist/async-batcher/useAsyncBatcher.cjs.map +1 -1
  13. package/dist/async-batcher/useAsyncBatcher.d.cts +28 -2
  14. package/dist/async-batcher/useAsyncBatcher.d.ts +28 -2
  15. package/dist/async-batcher/useAsyncBatcher.js +32 -4
  16. package/dist/async-batcher/useAsyncBatcher.js.map +1 -1
  17. package/dist/async-debouncer/index.cjs +1 -0
  18. package/dist/async-debouncer/index.d.cts +2 -2
  19. package/dist/async-debouncer/index.d.ts +2 -2
  20. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +1 -1
  21. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +2 -2
  22. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +2 -2
  23. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +1 -1
  24. package/dist/async-debouncer/useAsyncDebouncer.cjs +26 -4
  25. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +1 -1
  26. package/dist/async-debouncer/useAsyncDebouncer.d.cts +28 -3
  27. package/dist/async-debouncer/useAsyncDebouncer.d.ts +27 -2
  28. package/dist/async-debouncer/useAsyncDebouncer.js +27 -5
  29. package/dist/async-debouncer/useAsyncDebouncer.js.map +1 -1
  30. package/dist/async-queuer/index.cjs +1 -0
  31. package/dist/async-queuer/index.d.cts +2 -2
  32. package/dist/async-queuer/index.d.ts +2 -2
  33. package/dist/async-queuer/useAsyncQueuedState.cjs.map +1 -1
  34. package/dist/async-queuer/useAsyncQueuedState.d.cts +3 -3
  35. package/dist/async-queuer/useAsyncQueuedState.d.ts +3 -3
  36. package/dist/async-queuer/useAsyncQueuedState.js.map +1 -1
  37. package/dist/async-queuer/useAsyncQueuer.cjs +30 -2
  38. package/dist/async-queuer/useAsyncQueuer.cjs.map +1 -1
  39. package/dist/async-queuer/useAsyncQueuer.d.cts +28 -2
  40. package/dist/async-queuer/useAsyncQueuer.d.ts +28 -2
  41. package/dist/async-queuer/useAsyncQueuer.js +32 -4
  42. package/dist/async-queuer/useAsyncQueuer.js.map +1 -1
  43. package/dist/async-rate-limiter/index.cjs +1 -0
  44. package/dist/async-rate-limiter/index.d.cts +2 -2
  45. package/dist/async-rate-limiter/index.d.ts +2 -2
  46. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +1 -1
  47. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +2 -2
  48. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -2
  49. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +1 -1
  50. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +14 -2
  51. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +1 -1
  52. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +15 -2
  53. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +15 -2
  54. package/dist/async-rate-limiter/useAsyncRateLimiter.js +16 -4
  55. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +1 -1
  56. package/dist/async-throttler/index.cjs +1 -0
  57. package/dist/async-throttler/index.d.cts +2 -2
  58. package/dist/async-throttler/index.d.ts +2 -2
  59. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +1 -1
  60. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +2 -2
  61. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +2 -2
  62. package/dist/async-throttler/useAsyncThrottledCallback.js.map +1 -1
  63. package/dist/async-throttler/useAsyncThrottler.cjs +28 -4
  64. package/dist/async-throttler/useAsyncThrottler.cjs.map +1 -1
  65. package/dist/async-throttler/useAsyncThrottler.d.cts +27 -2
  66. package/dist/async-throttler/useAsyncThrottler.d.ts +27 -2
  67. package/dist/async-throttler/useAsyncThrottler.js +29 -5
  68. package/dist/async-throttler/useAsyncThrottler.js.map +1 -1
  69. package/dist/batcher/index.cjs +1 -0
  70. package/dist/batcher/index.d.cts +2 -2
  71. package/dist/batcher/index.d.ts +2 -2
  72. package/dist/batcher/useBatchedCallback.cjs +1 -1
  73. package/dist/batcher/useBatchedCallback.cjs.map +1 -1
  74. package/dist/batcher/useBatchedCallback.d.cts +2 -3
  75. package/dist/batcher/useBatchedCallback.d.ts +2 -3
  76. package/dist/batcher/useBatchedCallback.js +1 -1
  77. package/dist/batcher/useBatchedCallback.js.map +1 -1
  78. package/dist/batcher/useBatcher.cjs +21 -2
  79. package/dist/batcher/useBatcher.cjs.map +1 -1
  80. package/dist/batcher/useBatcher.d.cts +22 -2
  81. package/dist/batcher/useBatcher.d.ts +22 -2
  82. package/dist/batcher/useBatcher.js +23 -4
  83. package/dist/batcher/useBatcher.js.map +1 -1
  84. package/dist/debouncer/index.cjs +1 -0
  85. package/dist/debouncer/index.d.cts +2 -2
  86. package/dist/debouncer/index.d.ts +2 -2
  87. package/dist/debouncer/useDebouncedCallback.cjs.map +1 -1
  88. package/dist/debouncer/useDebouncedCallback.d.cts +2 -2
  89. package/dist/debouncer/useDebouncedCallback.d.ts +2 -2
  90. package/dist/debouncer/useDebouncedCallback.js.map +1 -1
  91. package/dist/debouncer/useDebouncedState.cjs.map +1 -1
  92. package/dist/debouncer/useDebouncedState.d.cts +3 -3
  93. package/dist/debouncer/useDebouncedState.d.ts +3 -3
  94. package/dist/debouncer/useDebouncedState.js.map +1 -1
  95. package/dist/debouncer/useDebouncedValue.cjs.map +1 -1
  96. package/dist/debouncer/useDebouncedValue.d.cts +3 -3
  97. package/dist/debouncer/useDebouncedValue.d.ts +3 -3
  98. package/dist/debouncer/useDebouncedValue.js.map +1 -1
  99. package/dist/debouncer/useDebouncer.cjs +17 -4
  100. package/dist/debouncer/useDebouncer.cjs.map +1 -1
  101. package/dist/debouncer/useDebouncer.d.cts +21 -2
  102. package/dist/debouncer/useDebouncer.d.ts +21 -2
  103. package/dist/debouncer/useDebouncer.js +18 -5
  104. package/dist/debouncer/useDebouncer.js.map +1 -1
  105. package/dist/index.cjs +1 -0
  106. package/dist/index.d.cts +11 -11
  107. package/dist/index.d.ts +11 -11
  108. package/dist/provider/PacerProvider.cjs.map +1 -1
  109. package/dist/provider/PacerProvider.d.cts +2 -2
  110. package/dist/provider/PacerProvider.d.ts +2 -2
  111. package/dist/provider/PacerProvider.js.map +1 -1
  112. package/dist/provider/index.cjs +1 -0
  113. package/dist/queuer/index.cjs +1 -0
  114. package/dist/queuer/index.d.cts +2 -2
  115. package/dist/queuer/index.d.ts +2 -2
  116. package/dist/queuer/useQueuedState.cjs.map +1 -1
  117. package/dist/queuer/useQueuedState.d.cts +3 -3
  118. package/dist/queuer/useQueuedState.d.ts +3 -3
  119. package/dist/queuer/useQueuedState.js.map +1 -1
  120. package/dist/queuer/useQueuedValue.cjs.map +1 -1
  121. package/dist/queuer/useQueuedValue.d.cts +3 -3
  122. package/dist/queuer/useQueuedValue.d.ts +3 -3
  123. package/dist/queuer/useQueuedValue.js.map +1 -1
  124. package/dist/queuer/useQueuer.cjs +21 -2
  125. package/dist/queuer/useQueuer.cjs.map +1 -1
  126. package/dist/queuer/useQueuer.d.cts +22 -2
  127. package/dist/queuer/useQueuer.d.ts +22 -2
  128. package/dist/queuer/useQueuer.js +23 -4
  129. package/dist/queuer/useQueuer.js.map +1 -1
  130. package/dist/rate-limiter/index.cjs +1 -0
  131. package/dist/rate-limiter/index.d.cts +2 -2
  132. package/dist/rate-limiter/index.d.ts +2 -2
  133. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +1 -1
  134. package/dist/rate-limiter/useRateLimitedCallback.d.cts +2 -2
  135. package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -2
  136. package/dist/rate-limiter/useRateLimitedCallback.js.map +1 -1
  137. package/dist/rate-limiter/useRateLimitedState.cjs.map +1 -1
  138. package/dist/rate-limiter/useRateLimitedState.d.cts +3 -3
  139. package/dist/rate-limiter/useRateLimitedState.d.ts +3 -3
  140. package/dist/rate-limiter/useRateLimitedState.js.map +1 -1
  141. package/dist/rate-limiter/useRateLimitedValue.cjs.map +1 -1
  142. package/dist/rate-limiter/useRateLimitedValue.d.cts +3 -3
  143. package/dist/rate-limiter/useRateLimitedValue.d.ts +3 -3
  144. package/dist/rate-limiter/useRateLimitedValue.js.map +1 -1
  145. package/dist/rate-limiter/useRateLimiter.cjs +7 -2
  146. package/dist/rate-limiter/useRateLimiter.cjs.map +1 -1
  147. package/dist/rate-limiter/useRateLimiter.d.cts +9 -2
  148. package/dist/rate-limiter/useRateLimiter.d.ts +9 -2
  149. package/dist/rate-limiter/useRateLimiter.js +9 -4
  150. package/dist/rate-limiter/useRateLimiter.js.map +1 -1
  151. package/dist/throttler/index.cjs +1 -0
  152. package/dist/throttler/index.d.cts +2 -2
  153. package/dist/throttler/index.d.ts +2 -2
  154. package/dist/throttler/useThrottledCallback.cjs.map +1 -1
  155. package/dist/throttler/useThrottledCallback.d.cts +2 -2
  156. package/dist/throttler/useThrottledCallback.d.ts +2 -2
  157. package/dist/throttler/useThrottledCallback.js.map +1 -1
  158. package/dist/throttler/useThrottledState.cjs.map +1 -1
  159. package/dist/throttler/useThrottledState.d.cts +3 -3
  160. package/dist/throttler/useThrottledState.d.ts +3 -3
  161. package/dist/throttler/useThrottledState.js.map +1 -1
  162. package/dist/throttler/useThrottledValue.cjs.map +1 -1
  163. package/dist/throttler/useThrottledValue.d.cts +3 -3
  164. package/dist/throttler/useThrottledValue.d.ts +3 -3
  165. package/dist/throttler/useThrottledValue.js.map +1 -1
  166. package/dist/throttler/useThrottler.cjs +17 -4
  167. package/dist/throttler/useThrottler.cjs.map +1 -1
  168. package/dist/throttler/useThrottler.d.cts +21 -2
  169. package/dist/throttler/useThrottler.d.ts +21 -2
  170. package/dist/throttler/useThrottler.js +18 -5
  171. package/dist/throttler/useThrottler.js.map +1 -1
  172. package/package.json +36 -35
  173. package/src/async-batcher/useAsyncBatchedCallback.ts +7 -8
  174. package/src/async-batcher/useAsyncBatcher.ts +51 -7
  175. package/src/async-debouncer/useAsyncDebouncedCallback.ts +2 -2
  176. package/src/async-debouncer/useAsyncDebouncer.ts +45 -8
  177. package/src/async-queuer/useAsyncQueuedState.ts +5 -5
  178. package/src/async-queuer/useAsyncQueuer.ts +51 -7
  179. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +2 -2
  180. package/src/async-rate-limiter/useAsyncRateLimiter.ts +37 -6
  181. package/src/async-throttler/useAsyncThrottledCallback.ts +2 -2
  182. package/src/async-throttler/useAsyncThrottler.ts +47 -8
  183. package/src/batcher/useBatchedCallback.ts +6 -10
  184. package/src/batcher/useBatcher.ts +44 -6
  185. package/src/debouncer/useDebouncedCallback.ts +2 -2
  186. package/src/debouncer/useDebouncedState.ts +3 -6
  187. package/src/debouncer/useDebouncedValue.ts +3 -6
  188. package/src/debouncer/useDebouncer.ts +38 -8
  189. package/src/queuer/useQueuedState.ts +3 -3
  190. package/src/queuer/useQueuedValue.ts +3 -3
  191. package/src/queuer/useQueuer.ts +44 -6
  192. package/src/rate-limiter/useRateLimitedCallback.ts +2 -2
  193. package/src/rate-limiter/useRateLimitedState.ts +6 -6
  194. package/src/rate-limiter/useRateLimitedValue.ts +6 -6
  195. package/src/rate-limiter/useRateLimiter.ts +29 -7
  196. package/src/throttler/useThrottledCallback.ts +2 -2
  197. package/src/throttler/useThrottledState.ts +3 -6
  198. package/src/throttler/useThrottledValue.ts +3 -6
  199. package/src/throttler/useThrottler.ts +38 -8
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncDebouncer.cjs","names":["useDefaultPacerOptions","AsyncDebouncer"],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\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 AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.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<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced 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 debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer 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 AsyncDebouncer 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 `debouncer.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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\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 } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as AsyncDebouncerOptions<TFn>\n\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector)\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector)\n\n useEffect(() => {\n return () => {\n asyncDebouncer.cancel()\n }\n }, [asyncDebouncer])\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwLA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,mDAAiC;EACtC,MAAM,oBAAoB,IAAIC,+CAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,gDAAoB,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,6CAAiB,eAAe,OAAO,SAAS;AAEtD,mCAAgB;AACd,eAAa;AACX,kBAAe,QAAQ;;IAExB,CAAC,eAAe,CAAC;AAEpB,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}
1
+ {"version":3,"file":"useAsyncDebouncer.cjs","names":["useDefaultPacerOptions","AsyncDebouncer","shallow"],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { shallow, 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 AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncerOptions<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends AsyncDebouncerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the debouncer instance.\n * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (debouncer: PreactAsyncDebouncer<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.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<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced 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 debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer 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 AsyncDebouncer 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 `debouncer.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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution and 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. For example, to flush pending work instead:\n *\n * ```tsx\n * const debouncer = useAsyncDebouncer(fn, {\n * wait: 500,\n * onUnmount: (d) => d.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your debounced 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 searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\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 } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: PreactAsyncDebouncerOptions<TFn, TSelected>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as PreactAsyncDebouncerOptions<TFn, TSelected>\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector, {\n equal: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector, { equal: shallow })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(asyncDebouncer)\n } else {\n asyncDebouncer.cancel()\n asyncDebouncer.abort()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,mDAAiC;EACtC,MAAM,oBAAoB,IAAIC,+CAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,gDAAoB,kBAAkB,OAAO,MAAM,UAAU,EACjE,OAAOC,gCACR,CAAC;AAEF,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,6CAAiB,eAAe,OAAO,UAAU,EAAE,OAAOA,gCAAS,CAAC;AAG1E,mCAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,eAAe;QAClC;AACL,mBAAe,QAAQ;AACvB,mBAAe,OAAO;;;IAGzB,EAAE,CAAC;AAGN,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}
@@ -1,9 +1,16 @@
1
1
  import { Store } from "@tanstack/preact-store";
2
2
  import { ComponentChildren } from "preact";
3
- import { AnyAsyncFunction } from "@tanstack/pacer/types";
4
3
  import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
4
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
5
5
 
6
6
  //#region src/async-debouncer/useAsyncDebouncer.d.ts
7
+ interface PreactAsyncDebouncerOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncDebouncerOptions<TFn> {
8
+ /**
9
+ * Optional callback invoked when the component unmounts. Receives the debouncer instance.
10
+ * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
11
+ */
12
+ onUnmount?: (debouncer: PreactAsyncDebouncer<TFn, TSelected>) => void;
13
+ }
7
14
  interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
15
  /**
9
16
  * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.
@@ -91,6 +98,24 @@ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> ext
91
98
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
92
99
  * - `successCount`: Number of function executions that have completed successfully
93
100
  *
101
+ * ## Unmount behavior
102
+ *
103
+ * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
104
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
105
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
106
+ *
107
+ * ```tsx
108
+ * const debouncer = useAsyncDebouncer(fn, {
109
+ * wait: 500,
110
+ * onUnmount: (d) => d.flush()
111
+ * });
112
+ * ```
113
+ *
114
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
115
+ * If your debounced function updates Preact state, those updates may run after the component has
116
+ * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
117
+ * accordingly when using onUnmount with flush.
118
+ *
94
119
  * @example
95
120
  * ```tsx
96
121
  * // Default behavior - no reactive state subscriptions
@@ -172,7 +197,7 @@ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> ext
172
197
  * const { isExecuting, lastResult } = state;
173
198
  * ```
174
199
  */
175
- declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
200
+ declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncDebouncerOptions<TFn, TSelected>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
176
201
  //#endregion
177
- export { PreactAsyncDebouncer, useAsyncDebouncer };
202
+ export { PreactAsyncDebouncer, PreactAsyncDebouncerOptions, useAsyncDebouncer };
178
203
  //# sourceMappingURL=useAsyncDebouncer.d.cts.map
@@ -4,6 +4,13 @@ import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tan
4
4
  import { AnyAsyncFunction } from "@tanstack/pacer/types";
5
5
 
6
6
  //#region src/async-debouncer/useAsyncDebouncer.d.ts
7
+ interface PreactAsyncDebouncerOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncDebouncerOptions<TFn> {
8
+ /**
9
+ * Optional callback invoked when the component unmounts. Receives the debouncer instance.
10
+ * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
11
+ */
12
+ onUnmount?: (debouncer: PreactAsyncDebouncer<TFn, TSelected>) => void;
13
+ }
7
14
  interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
15
  /**
9
16
  * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.
@@ -91,6 +98,24 @@ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> ext
91
98
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
92
99
  * - `successCount`: Number of function executions that have completed successfully
93
100
  *
101
+ * ## Unmount behavior
102
+ *
103
+ * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
104
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
105
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
106
+ *
107
+ * ```tsx
108
+ * const debouncer = useAsyncDebouncer(fn, {
109
+ * wait: 500,
110
+ * onUnmount: (d) => d.flush()
111
+ * });
112
+ * ```
113
+ *
114
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
115
+ * If your debounced function updates Preact state, those updates may run after the component has
116
+ * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
117
+ * accordingly when using onUnmount with flush.
118
+ *
94
119
  * @example
95
120
  * ```tsx
96
121
  * // Default behavior - no reactive state subscriptions
@@ -172,7 +197,7 @@ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> ext
172
197
  * const { isExecuting, lastResult } = state;
173
198
  * ```
174
199
  */
175
- declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
200
+ declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncDebouncerOptions<TFn, TSelected>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
176
201
  //#endregion
177
- export { PreactAsyncDebouncer, useAsyncDebouncer };
202
+ export { PreactAsyncDebouncer, PreactAsyncDebouncerOptions, useAsyncDebouncer };
178
203
  //# sourceMappingURL=useAsyncDebouncer.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
2
  import { useEffect, useMemo, useState } from "preact/hooks";
3
- import { useStore } from "@tanstack/preact-store";
3
+ import { shallow, useStore } from "@tanstack/preact-store";
4
4
  import { AsyncDebouncer } from "@tanstack/pacer/async-debouncer";
5
5
 
6
6
  //#region src/async-debouncer/useAsyncDebouncer.ts
@@ -60,6 +60,24 @@ import { AsyncDebouncer } from "@tanstack/pacer/async-debouncer";
60
60
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
61
61
  * - `successCount`: Number of function executions that have completed successfully
62
62
  *
63
+ * ## Unmount behavior
64
+ *
65
+ * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
66
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
67
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
68
+ *
69
+ * ```tsx
70
+ * const debouncer = useAsyncDebouncer(fn, {
71
+ * wait: 500,
72
+ * onUnmount: (d) => d.flush()
73
+ * });
74
+ * ```
75
+ *
76
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
77
+ * If your debounced function updates Preact state, those updates may run after the component has
78
+ * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
79
+ * accordingly when using onUnmount with flush.
80
+ *
63
81
  * @example
64
82
  * ```tsx
65
83
  * // Default behavior - no reactive state subscriptions
@@ -149,19 +167,23 @@ function useAsyncDebouncer(fn, options, selector = () => ({})) {
149
167
  const [asyncDebouncer] = useState(() => {
150
168
  const debouncerInstance = new AsyncDebouncer(fn, mergedOptions);
151
169
  debouncerInstance.Subscribe = function Subscribe(props) {
152
- const selected = useStore(debouncerInstance.store, props.selector);
170
+ const selected = useStore(debouncerInstance.store, props.selector, { equal: shallow });
153
171
  return typeof props.children === "function" ? props.children(selected) : props.children;
154
172
  };
155
173
  return debouncerInstance;
156
174
  });
157
175
  asyncDebouncer.fn = fn;
158
176
  asyncDebouncer.setOptions(mergedOptions);
159
- const state = useStore(asyncDebouncer.store, selector);
177
+ const state = useStore(asyncDebouncer.store, selector, { equal: shallow });
160
178
  useEffect(() => {
161
179
  return () => {
162
- asyncDebouncer.cancel();
180
+ if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncDebouncer);
181
+ else {
182
+ asyncDebouncer.cancel();
183
+ asyncDebouncer.abort();
184
+ }
163
185
  };
164
- }, [asyncDebouncer]);
186
+ }, []);
165
187
  return useMemo(() => ({
166
188
  ...asyncDebouncer,
167
189
  state
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncDebouncer.js","names":[],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\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 AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.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<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced 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 debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer 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 AsyncDebouncer 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 `debouncer.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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\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 } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as AsyncDebouncerOptions<TFn>\n\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector)\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector)\n\n useEffect(() => {\n return () => {\n asyncDebouncer.cancel()\n }\n }, [asyncDebouncer])\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwLA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,kBAAkB,eAAe;EACtC,MAAM,oBAAoB,IAAI,eAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,iBAAgB;AACd,eAAa;AACX,kBAAe,QAAQ;;IAExB,CAAC,eAAe,CAAC;AAEpB,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}
1
+ {"version":3,"file":"useAsyncDebouncer.js","names":[],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { shallow, 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 AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncerOptions<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends AsyncDebouncerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the debouncer instance.\n * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (debouncer: PreactAsyncDebouncer<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.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<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced 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 debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer 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 AsyncDebouncer 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 `debouncer.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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution and 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. For example, to flush pending work instead:\n *\n * ```tsx\n * const debouncer = useAsyncDebouncer(fn, {\n * wait: 500,\n * onUnmount: (d) => d.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your debounced 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 searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\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 } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: PreactAsyncDebouncerOptions<TFn, TSelected>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as PreactAsyncDebouncerOptions<TFn, TSelected>\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector, {\n equal: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector, { equal: shallow })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(asyncDebouncer)\n } else {\n asyncDebouncer.cancel()\n asyncDebouncer.abort()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,kBAAkB,eAAe;EACtC,MAAM,oBAAoB,IAAI,eAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,UAAU,EACjE,OAAO,SACR,CAAC;AAEF,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,QAAQ,SAAS,eAAe,OAAO,UAAU,EAAE,OAAO,SAAS,CAAC;AAG1E,iBAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,eAAe;QAClC;AACL,mBAAe,QAAQ;AACvB,mBAAe,OAAO;;;IAGzB,EAAE,CAAC;AAGN,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}
@@ -1,3 +1,4 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
1
2
  const require_useAsyncQueuer = require('./useAsyncQueuer.cjs');
2
3
  const require_useAsyncQueuedState = require('./useAsyncQueuedState.cjs');
3
4
 
@@ -1,4 +1,4 @@
1
- import { PreactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.cjs";
1
+ import { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuer } from "./useAsyncQueuer.cjs";
2
2
  import { useAsyncQueuedState } from "./useAsyncQueuedState.cjs";
3
3
  export * from "@tanstack/pacer/async-queuer";
4
- export { PreactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };
4
+ export { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuedState, useAsyncQueuer };
@@ -1,4 +1,4 @@
1
- import { PreactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.js";
1
+ import { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuer } from "./useAsyncQueuer.js";
2
2
  import { useAsyncQueuedState } from "./useAsyncQueuedState.js";
3
3
  export * from "@tanstack/pacer/async-queuer";
4
- export { PreactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };
4
+ export { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuedState, useAsyncQueuer };
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncQueuedState.cjs","names":["useAsyncQueuer"],"sources":["../../src/async-queuer/useAsyncQueuedState.ts"],"sourcesContent":["import { useAsyncQueuer } from './useAsyncQueuer'\nimport type { PreactAsyncQueuer } from './useAsyncQueuer'\nimport type {\n AsyncQueuerOptions,\n AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\n/**\n * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.\n *\n * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.\n * It returns a tuple containing:\n * - The current array of queued items as Preact state\n * - The queuer instance with methods to control the queue\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The state will automatically update whenever items are:\n * - Added to the queue\n * - Removed from the queue\n * - Started processing\n * - Completed processing\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.\n * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available async queuer 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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * {\n * concurrency: 2,\n * maxSize: 100,\n * started: true\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * items: state.items,\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Add items to queue - state updates automatically\n * asyncQueuer.addItem(async () => {\n * const result = await fetchData();\n * return result;\n * });\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Stop processing\n * asyncQueuer.stop();\n *\n * // queueItems reflects current queue state\n * const pendingCount = asyncQueuer.peekPendingItems().length;\n *\n * // Access the selected async queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuedState<\n TValue,\n TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<\n AsyncQueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (value: TValue) => Promise<any>,\n options: AsyncQueuerOptions<TValue> = {},\n selector?: (state: AsyncQueuerState<TValue>) => TSelected,\n): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>] {\n const asyncQueuer = useAsyncQueuer(fn, options, selector)\n\n return [asyncQueuer.state.items, asyncQueuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,SAAgB,oBAOd,IACA,UAAsC,EAAE,EACxC,UACuD;CACvD,MAAM,cAAcA,sCAAe,IAAI,SAAS,SAAS;AAEzD,QAAO,CAAC,YAAY,MAAM,OAAO,YAAY"}
1
+ {"version":3,"file":"useAsyncQueuedState.cjs","names":["useAsyncQueuer"],"sources":["../../src/async-queuer/useAsyncQueuedState.ts"],"sourcesContent":["import { useAsyncQueuer } from './useAsyncQueuer'\nimport type {\n PreactAsyncQueuer,\n PreactAsyncQueuerOptions,\n} from './useAsyncQueuer'\nimport type { AsyncQueuerState } from '@tanstack/pacer/async-queuer'\n\n/**\n * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.\n *\n * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.\n * It returns a tuple containing:\n * - The current array of queued items as Preact state\n * - The queuer instance with methods to control the queue\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The state will automatically update whenever items are:\n * - Added to the queue\n * - Removed from the queue\n * - Started processing\n * - Completed processing\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.\n * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available async queuer 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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * {\n * concurrency: 2,\n * maxSize: 100,\n * started: true\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * items: state.items,\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Add items to queue - state updates automatically\n * asyncQueuer.addItem(async () => {\n * const result = await fetchData();\n * return result;\n * });\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Stop processing\n * asyncQueuer.stop();\n *\n * // queueItems reflects current queue state\n * const pendingCount = asyncQueuer.peekPendingItems().length;\n *\n * // Access the selected async queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuedState<\n TValue,\n TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<\n AsyncQueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (value: TValue) => Promise<any>,\n options: PreactAsyncQueuerOptions<TValue, TSelected> = {},\n selector?: (state: AsyncQueuerState<TValue>) => TSelected,\n): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>] {\n const asyncQueuer = useAsyncQueuer(fn, options, selector)\n\n return [asyncQueuer.state.items, asyncQueuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,SAAgB,oBAOd,IACA,UAAuD,EAAE,EACzD,UACuD;CACvD,MAAM,cAAcA,sCAAe,IAAI,SAAS,SAAS;AAEzD,QAAO,CAAC,YAAY,MAAM,OAAO,YAAY"}
@@ -1,5 +1,5 @@
1
- import { PreactAsyncQueuer } from "./useAsyncQueuer.cjs";
2
- import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
1
+ import { PreactAsyncQueuer, PreactAsyncQueuerOptions } from "./useAsyncQueuer.cjs";
2
+ import { AsyncQueuerState } from "@tanstack/pacer/async-queuer";
3
3
 
4
4
  //#region src/async-queuer/useAsyncQueuedState.d.ts
5
5
  /**
@@ -145,7 +145,7 @@ import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queu
145
145
  * const { size, isRunning, activeItems } = asyncQueuer.state;
146
146
  * ```
147
147
  */
148
- declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>];
148
+ declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: PreactAsyncQueuerOptions<TValue, TSelected>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>];
149
149
  //#endregion
150
150
  export { useAsyncQueuedState };
151
151
  //# sourceMappingURL=useAsyncQueuedState.d.cts.map
@@ -1,5 +1,5 @@
1
- import { PreactAsyncQueuer } from "./useAsyncQueuer.js";
2
- import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
1
+ import { PreactAsyncQueuer, PreactAsyncQueuerOptions } from "./useAsyncQueuer.js";
2
+ import { AsyncQueuerState } from "@tanstack/pacer/async-queuer";
3
3
 
4
4
  //#region src/async-queuer/useAsyncQueuedState.d.ts
5
5
  /**
@@ -145,7 +145,7 @@ import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queu
145
145
  * const { size, isRunning, activeItems } = asyncQueuer.state;
146
146
  * ```
147
147
  */
148
- declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>];
148
+ declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: PreactAsyncQueuerOptions<TValue, TSelected>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>];
149
149
  //#endregion
150
150
  export { useAsyncQueuedState };
151
151
  //# sourceMappingURL=useAsyncQueuedState.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncQueuedState.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuedState.ts"],"sourcesContent":["import { useAsyncQueuer } from './useAsyncQueuer'\nimport type { PreactAsyncQueuer } from './useAsyncQueuer'\nimport type {\n AsyncQueuerOptions,\n AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\n/**\n * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.\n *\n * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.\n * It returns a tuple containing:\n * - The current array of queued items as Preact state\n * - The queuer instance with methods to control the queue\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The state will automatically update whenever items are:\n * - Added to the queue\n * - Removed from the queue\n * - Started processing\n * - Completed processing\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.\n * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available async queuer 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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * {\n * concurrency: 2,\n * maxSize: 100,\n * started: true\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * items: state.items,\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Add items to queue - state updates automatically\n * asyncQueuer.addItem(async () => {\n * const result = await fetchData();\n * return result;\n * });\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Stop processing\n * asyncQueuer.stop();\n *\n * // queueItems reflects current queue state\n * const pendingCount = asyncQueuer.peekPendingItems().length;\n *\n * // Access the selected async queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuedState<\n TValue,\n TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<\n AsyncQueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (value: TValue) => Promise<any>,\n options: AsyncQueuerOptions<TValue> = {},\n selector?: (state: AsyncQueuerState<TValue>) => TSelected,\n): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>] {\n const asyncQueuer = useAsyncQueuer(fn, options, selector)\n\n return [asyncQueuer.state.items, asyncQueuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,SAAgB,oBAOd,IACA,UAAsC,EAAE,EACxC,UACuD;CACvD,MAAM,cAAc,eAAe,IAAI,SAAS,SAAS;AAEzD,QAAO,CAAC,YAAY,MAAM,OAAO,YAAY"}
1
+ {"version":3,"file":"useAsyncQueuedState.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuedState.ts"],"sourcesContent":["import { useAsyncQueuer } from './useAsyncQueuer'\nimport type {\n PreactAsyncQueuer,\n PreactAsyncQueuerOptions,\n} from './useAsyncQueuer'\nimport type { AsyncQueuerState } from '@tanstack/pacer/async-queuer'\n\n/**\n * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.\n *\n * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.\n * It returns a tuple containing:\n * - The current array of queued items as Preact state\n * - The queuer instance with methods to control the queue\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The state will automatically update whenever items are:\n * - Added to the queue\n * - Removed from the queue\n * - Started processing\n * - Completed processing\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.\n * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available async queuer 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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * {\n * concurrency: 2,\n * maxSize: 100,\n * started: true\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * items: state.items,\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\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 [queueItems, asyncQueuer] = useAsyncQueuedState(\n * async (item) => {\n * const result = await processItem(item);\n * return result;\n * },\n * { concurrency: 2, maxSize: 100, started: true },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Add items to queue - state updates automatically\n * asyncQueuer.addItem(async () => {\n * const result = await fetchData();\n * return result;\n * });\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Stop processing\n * asyncQueuer.stop();\n *\n * // queueItems reflects current queue state\n * const pendingCount = asyncQueuer.peekPendingItems().length;\n *\n * // Access the selected async queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuedState<\n TValue,\n TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<\n AsyncQueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (value: TValue) => Promise<any>,\n options: PreactAsyncQueuerOptions<TValue, TSelected> = {},\n selector?: (state: AsyncQueuerState<TValue>) => TSelected,\n): [Array<TValue>, PreactAsyncQueuer<TValue, TSelected>] {\n const asyncQueuer = useAsyncQueuer(fn, options, selector)\n\n return [asyncQueuer.state.items, asyncQueuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,SAAgB,oBAOd,IACA,UAAuD,EAAE,EACzD,UACuD;CACvD,MAAM,cAAc,eAAe,IAAI,SAAS,SAAS;AAEzD,QAAO,CAAC,YAAY,MAAM,OAAO,YAAY"}
@@ -65,6 +65,25 @@ let _tanstack_pacer_async_queuer = require("@tanstack/pacer/async-queuer");
65
65
  * - `status`: Current processing status ('idle' | 'running' | 'stopped')
66
66
  * - `successCount`: Number of task executions that have completed successfully
67
67
  *
68
+ * ## Unmount behavior
69
+ *
70
+ * By default, the hook stops the queuer and aborts any in-flight task executions when the component unmounts.
71
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
72
+ * Use the `onUnmount` option to customize this. For example, to flush pending items instead:
73
+ *
74
+ * ```tsx
75
+ * const queuer = useAsyncQueuer(fn, {
76
+ * concurrency: 2,
77
+ * started: false,
78
+ * onUnmount: (q) => q.flush()
79
+ * });
80
+ * ```
81
+ *
82
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
83
+ * If your task function updates Preact state, those updates may run after the component has
84
+ * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
85
+ * accordingly when using onUnmount with flush.
86
+ *
68
87
  * @example
69
88
  * ```tsx
70
89
  * // Default behavior - no reactive state subscriptions
@@ -170,14 +189,23 @@ function useAsyncQueuer(fn, options = {}, selector = () => ({})) {
170
189
  const [asyncQueuer] = (0, preact_hooks.useState)(() => {
171
190
  const queuerInstance = new _tanstack_pacer_async_queuer.AsyncQueuer(fn, mergedOptions);
172
191
  queuerInstance.Subscribe = function Subscribe(props) {
173
- const selected = (0, _tanstack_preact_store.useStore)(queuerInstance.store, props.selector);
192
+ const selected = (0, _tanstack_preact_store.useStore)(queuerInstance.store, props.selector, { equal: _tanstack_preact_store.shallow });
174
193
  return typeof props.children === "function" ? props.children(selected) : props.children;
175
194
  };
176
195
  return queuerInstance;
177
196
  });
178
197
  asyncQueuer.fn = fn;
179
198
  asyncQueuer.setOptions(mergedOptions);
180
- const state = (0, _tanstack_preact_store.useStore)(asyncQueuer.store, selector);
199
+ (0, preact_hooks.useEffect)(() => {
200
+ return () => {
201
+ if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncQueuer);
202
+ else {
203
+ asyncQueuer.stop();
204
+ asyncQueuer.abort();
205
+ }
206
+ };
207
+ }, []);
208
+ const state = (0, _tanstack_preact_store.useStore)(asyncQueuer.store, selector, { equal: _tanstack_preact_store.shallow });
181
209
  return (0, preact_hooks.useMemo)(() => ({
182
210
  ...asyncQueuer,
183
211
  state
@@ -1 +1 @@
1
- {"version":3,"file":"useAsyncQueuer.cjs","names":["useDefaultPacerOptions","AsyncQueuer"],"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,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,gDAA8B;EACnC,MAAM,iBAAiB,IAAIC,yCACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,gDAAoB,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,6CAAiB,YAAY,OAAO,SAAS;AAEnD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}
1
+ {"version":3,"file":"useAsyncQueuer.cjs","names":["useDefaultPacerOptions","AsyncQueuer","shallow"],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { shallow, 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 equal: shallow,\n })\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, { equal: shallow })\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,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,gDAA8B;EACnC,MAAM,iBAAiB,IAAIC,yCACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,gDAAoB,eAAe,OAAO,MAAM,UAAU,EAC9D,OAAOC,gCACR,CAAC;AAEF,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;AAGrC,mCAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,YAAY;QAC/B;AACL,gBAAY,MAAM;AAClB,gBAAY,OAAO;;;IAGtB,EAAE,CAAC;CAGN,MAAM,6CAAiB,YAAY,OAAO,UAAU,EAAE,OAAOA,gCAAS,CAAC;AAEvE,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}
@@ -3,6 +3,13 @@ import { ComponentChildren } from "preact";
3
3
  import { AsyncQueuer, AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
4
4
 
5
5
  //#region src/async-queuer/useAsyncQueuer.d.ts
6
+ interface PreactAsyncQueuerOptions<TValue, TSelected = {}> extends AsyncQueuerOptions<TValue> {
7
+ /**
8
+ * Optional callback invoked when the component unmounts. Receives the queuer instance.
9
+ * When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc.
10
+ */
11
+ onUnmount?: (queuer: PreactAsyncQueuer<TValue, TSelected>) => void;
12
+ }
6
13
  interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TValue>, 'store'> {
7
14
  /**
8
15
  * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.
@@ -95,6 +102,25 @@ interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVa
95
102
  * - `status`: Current processing status ('idle' | 'running' | 'stopped')
96
103
  * - `successCount`: Number of task executions that have completed successfully
97
104
  *
105
+ * ## Unmount behavior
106
+ *
107
+ * By default, the hook stops the queuer and aborts any in-flight task executions when the component unmounts.
108
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
109
+ * Use the `onUnmount` option to customize this. For example, to flush pending items instead:
110
+ *
111
+ * ```tsx
112
+ * const queuer = useAsyncQueuer(fn, {
113
+ * concurrency: 2,
114
+ * started: false,
115
+ * onUnmount: (q) => q.flush()
116
+ * });
117
+ * ```
118
+ *
119
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
120
+ * If your task function updates Preact state, those updates may run after the component has
121
+ * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
122
+ * accordingly when using onUnmount with flush.
123
+ *
98
124
  * @example
99
125
  * ```tsx
100
126
  * // Default behavior - no reactive state subscriptions
@@ -192,7 +218,7 @@ interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVa
192
218
  * const { size, isRunning, activeItems } = asyncQueuer.state;
193
219
  * ```
194
220
  */
195
- declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): PreactAsyncQueuer<TValue, TSelected>;
221
+ declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: PreactAsyncQueuerOptions<TValue, TSelected>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): PreactAsyncQueuer<TValue, TSelected>;
196
222
  //#endregion
197
- export { PreactAsyncQueuer, useAsyncQueuer };
223
+ export { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuer };
198
224
  //# sourceMappingURL=useAsyncQueuer.d.cts.map