@tanstack/preact-pacer 0.23.0 → 0.24.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 (242) hide show
  1. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -4
  2. package/dist/async-batcher/useAsyncBatchedCallback.js +1 -2
  3. package/dist/async-batcher/useAsyncBatcher.d.ts +4 -7
  4. package/dist/async-batcher/useAsyncBatcher.js +1 -3
  5. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +2 -4
  6. package/dist/async-debouncer/useAsyncDebouncedCallback.js +1 -2
  7. package/dist/async-debouncer/useAsyncDebouncer.d.ts +4 -6
  8. package/dist/async-debouncer/useAsyncDebouncer.js +1 -2
  9. package/dist/async-queuer/useAsyncQueuedState.d.ts +4 -6
  10. package/dist/async-queuer/useAsyncQueuedState.js +3 -4
  11. package/dist/async-queuer/useAsyncQueuer.d.ts +6 -8
  12. package/dist/async-queuer/useAsyncQueuer.js +3 -4
  13. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -4
  14. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +1 -2
  15. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +4 -6
  16. package/dist/async-rate-limiter/useAsyncRateLimiter.js +1 -2
  17. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +2 -4
  18. package/dist/async-throttler/useAsyncThrottledCallback.js +1 -2
  19. package/dist/async-throttler/useAsyncThrottler.d.ts +4 -6
  20. package/dist/async-throttler/useAsyncThrottler.js +1 -2
  21. package/dist/batcher/useBatchedCallback.d.ts +2 -4
  22. package/dist/batcher/useBatchedCallback.js +1 -2
  23. package/dist/batcher/useBatcher.d.ts +6 -10
  24. package/dist/batcher/useBatcher.js +3 -6
  25. package/dist/debouncer/useDebouncedCallback.d.ts +2 -4
  26. package/dist/debouncer/useDebouncedCallback.js +1 -2
  27. package/dist/debouncer/useDebouncedState.d.ts +2 -4
  28. package/dist/debouncer/useDebouncedState.js +1 -2
  29. package/dist/debouncer/useDebouncedValue.d.ts +2 -4
  30. package/dist/debouncer/useDebouncedValue.js +1 -2
  31. package/dist/debouncer/useDebouncer.d.ts +4 -6
  32. package/dist/debouncer/useDebouncer.js +1 -2
  33. package/dist/provider/PacerProvider.d.ts +6 -8
  34. package/dist/provider/PacerProvider.js +1 -2
  35. package/dist/queuer/useQueuedState.d.ts +2 -4
  36. package/dist/queuer/useQueuedState.js +1 -2
  37. package/dist/queuer/useQueuedValue.d.ts +2 -4
  38. package/dist/queuer/useQueuedValue.js +1 -2
  39. package/dist/queuer/useQueuer.d.ts +4 -6
  40. package/dist/queuer/useQueuer.js +1 -2
  41. package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -4
  42. package/dist/rate-limiter/useRateLimitedCallback.js +1 -2
  43. package/dist/rate-limiter/useRateLimitedState.d.ts +2 -4
  44. package/dist/rate-limiter/useRateLimitedState.js +1 -2
  45. package/dist/rate-limiter/useRateLimitedValue.d.ts +2 -4
  46. package/dist/rate-limiter/useRateLimitedValue.js +1 -2
  47. package/dist/rate-limiter/useRateLimiter.d.ts +4 -6
  48. package/dist/rate-limiter/useRateLimiter.js +1 -2
  49. package/dist/throttler/useThrottledCallback.d.ts +2 -4
  50. package/dist/throttler/useThrottledCallback.js +1 -2
  51. package/dist/throttler/useThrottledState.d.ts +2 -4
  52. package/dist/throttler/useThrottledState.js +1 -2
  53. package/dist/throttler/useThrottledValue.d.ts +2 -4
  54. package/dist/throttler/useThrottledValue.js +1 -2
  55. package/dist/throttler/useThrottler.d.ts +4 -6
  56. package/dist/throttler/useThrottler.js +1 -2
  57. package/package.json +22 -70
  58. package/dist/async-batcher/index.cjs +0 -13
  59. package/dist/async-batcher/index.d.cts +0 -4
  60. package/dist/async-batcher/useAsyncBatchedCallback.cjs +0 -51
  61. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +0 -1
  62. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +0 -43
  63. package/dist/async-batcher/useAsyncBatchedCallback.js.map +0 -1
  64. package/dist/async-batcher/useAsyncBatcher.cjs +0 -217
  65. package/dist/async-batcher/useAsyncBatcher.cjs.map +0 -1
  66. package/dist/async-batcher/useAsyncBatcher.d.cts +0 -223
  67. package/dist/async-batcher/useAsyncBatcher.js.map +0 -1
  68. package/dist/async-debouncer/index.cjs +0 -13
  69. package/dist/async-debouncer/index.d.cts +0 -4
  70. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs +0 -52
  71. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +0 -1
  72. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +0 -47
  73. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +0 -1
  74. package/dist/async-debouncer/useAsyncDebouncer.cjs +0 -195
  75. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +0 -1
  76. package/dist/async-debouncer/useAsyncDebouncer.d.cts +0 -202
  77. package/dist/async-debouncer/useAsyncDebouncer.js.map +0 -1
  78. package/dist/async-queuer/index.cjs +0 -13
  79. package/dist/async-queuer/index.d.cts +0 -4
  80. package/dist/async-queuer/useAsyncQueuedState.cjs +0 -154
  81. package/dist/async-queuer/useAsyncQueuedState.cjs.map +0 -1
  82. package/dist/async-queuer/useAsyncQueuedState.d.cts +0 -150
  83. package/dist/async-queuer/useAsyncQueuedState.js.map +0 -1
  84. package/dist/async-queuer/useAsyncQueuer.cjs +0 -217
  85. package/dist/async-queuer/useAsyncQueuer.cjs.map +0 -1
  86. package/dist/async-queuer/useAsyncQueuer.d.cts +0 -223
  87. package/dist/async-queuer/useAsyncQueuer.js.map +0 -1
  88. package/dist/async-rate-limiter/index.cjs +0 -13
  89. package/dist/async-rate-limiter/index.d.cts +0 -4
  90. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs +0 -65
  91. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +0 -1
  92. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +0 -60
  93. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +0 -1
  94. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +0 -209
  95. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +0 -1
  96. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +0 -219
  97. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +0 -1
  98. package/dist/async-retryer/index.cjs +0 -8
  99. package/dist/async-retryer/index.d.cts +0 -1
  100. package/dist/async-throttler/index.cjs +0 -13
  101. package/dist/async-throttler/index.d.cts +0 -4
  102. package/dist/async-throttler/useAsyncThrottledCallback.cjs +0 -49
  103. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +0 -1
  104. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +0 -44
  105. package/dist/async-throttler/useAsyncThrottledCallback.js.map +0 -1
  106. package/dist/async-throttler/useAsyncThrottler.cjs +0 -206
  107. package/dist/async-throttler/useAsyncThrottler.cjs.map +0 -1
  108. package/dist/async-throttler/useAsyncThrottler.d.cts +0 -213
  109. package/dist/async-throttler/useAsyncThrottler.js.map +0 -1
  110. package/dist/batcher/index.cjs +0 -13
  111. package/dist/batcher/index.d.cts +0 -4
  112. package/dist/batcher/useBatchedCallback.cjs +0 -47
  113. package/dist/batcher/useBatchedCallback.cjs.map +0 -1
  114. package/dist/batcher/useBatchedCallback.d.cts +0 -41
  115. package/dist/batcher/useBatchedCallback.js.map +0 -1
  116. package/dist/batcher/useBatcher.cjs +0 -165
  117. package/dist/batcher/useBatcher.cjs.map +0 -1
  118. package/dist/batcher/useBatcher.d.cts +0 -174
  119. package/dist/batcher/useBatcher.js.map +0 -1
  120. package/dist/debouncer/index.cjs +0 -17
  121. package/dist/debouncer/index.d.cts +0 -6
  122. package/dist/debouncer/useDebouncedCallback.cjs +0 -48
  123. package/dist/debouncer/useDebouncedCallback.cjs.map +0 -1
  124. package/dist/debouncer/useDebouncedCallback.d.cts +0 -43
  125. package/dist/debouncer/useDebouncedCallback.js.map +0 -1
  126. package/dist/debouncer/useDebouncedState.cjs +0 -89
  127. package/dist/debouncer/useDebouncedState.cjs.map +0 -1
  128. package/dist/debouncer/useDebouncedState.d.cts +0 -80
  129. package/dist/debouncer/useDebouncedState.js.map +0 -1
  130. package/dist/debouncer/useDebouncedValue.cjs +0 -96
  131. package/dist/debouncer/useDebouncedValue.cjs.map +0 -1
  132. package/dist/debouncer/useDebouncedValue.d.cts +0 -89
  133. package/dist/debouncer/useDebouncedValue.js.map +0 -1
  134. package/dist/debouncer/useDebouncer.cjs +0 -141
  135. package/dist/debouncer/useDebouncer.cjs.map +0 -1
  136. package/dist/debouncer/useDebouncer.d.cts +0 -151
  137. package/dist/debouncer/useDebouncer.js.map +0 -1
  138. package/dist/index.cjs +0 -67
  139. package/dist/index.d.cts +0 -30
  140. package/dist/provider/PacerProvider.cjs +0 -26
  141. package/dist/provider/PacerProvider.cjs.map +0 -1
  142. package/dist/provider/PacerProvider.d.cts +0 -28
  143. package/dist/provider/PacerProvider.js.map +0 -1
  144. package/dist/provider/index.cjs +0 -6
  145. package/dist/provider/index.d.cts +0 -2
  146. package/dist/queuer/index.cjs +0 -15
  147. package/dist/queuer/index.d.cts +0 -5
  148. package/dist/queuer/useQueuedState.cjs +0 -129
  149. package/dist/queuer/useQueuedState.cjs.map +0 -1
  150. package/dist/queuer/useQueuedState.d.cts +0 -121
  151. package/dist/queuer/useQueuedState.js.map +0 -1
  152. package/dist/queuer/useQueuedValue.cjs +0 -115
  153. package/dist/queuer/useQueuedValue.cjs.map +0 -1
  154. package/dist/queuer/useQueuedValue.d.cts +0 -104
  155. package/dist/queuer/useQueuedValue.js.map +0 -1
  156. package/dist/queuer/useQueuer.cjs +0 -176
  157. package/dist/queuer/useQueuer.cjs.map +0 -1
  158. package/dist/queuer/useQueuer.d.cts +0 -185
  159. package/dist/queuer/useQueuer.js.map +0 -1
  160. package/dist/rate-limiter/index.cjs +0 -17
  161. package/dist/rate-limiter/index.d.cts +0 -6
  162. package/dist/rate-limiter/useRateLimitedCallback.cjs +0 -65
  163. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +0 -1
  164. package/dist/rate-limiter/useRateLimitedCallback.d.cts +0 -60
  165. package/dist/rate-limiter/useRateLimitedCallback.js.map +0 -1
  166. package/dist/rate-limiter/useRateLimitedState.cjs +0 -115
  167. package/dist/rate-limiter/useRateLimitedState.cjs.map +0 -1
  168. package/dist/rate-limiter/useRateLimitedState.d.cts +0 -106
  169. package/dist/rate-limiter/useRateLimitedState.js.map +0 -1
  170. package/dist/rate-limiter/useRateLimitedValue.cjs +0 -102
  171. package/dist/rate-limiter/useRateLimitedValue.cjs.map +0 -1
  172. package/dist/rate-limiter/useRateLimitedValue.d.cts +0 -95
  173. package/dist/rate-limiter/useRateLimitedValue.js.map +0 -1
  174. package/dist/rate-limiter/useRateLimiter.cjs +0 -167
  175. package/dist/rate-limiter/useRateLimiter.cjs.map +0 -1
  176. package/dist/rate-limiter/useRateLimiter.d.cts +0 -178
  177. package/dist/rate-limiter/useRateLimiter.js.map +0 -1
  178. package/dist/throttler/index.cjs +0 -17
  179. package/dist/throttler/index.d.cts +0 -6
  180. package/dist/throttler/useThrottledCallback.cjs +0 -49
  181. package/dist/throttler/useThrottledCallback.cjs.map +0 -1
  182. package/dist/throttler/useThrottledCallback.d.cts +0 -44
  183. package/dist/throttler/useThrottledCallback.js.map +0 -1
  184. package/dist/throttler/useThrottledState.cjs +0 -100
  185. package/dist/throttler/useThrottledState.cjs.map +0 -1
  186. package/dist/throttler/useThrottledState.d.cts +0 -91
  187. package/dist/throttler/useThrottledState.js.map +0 -1
  188. package/dist/throttler/useThrottledValue.cjs +0 -91
  189. package/dist/throttler/useThrottledValue.cjs.map +0 -1
  190. package/dist/throttler/useThrottledValue.d.cts +0 -84
  191. package/dist/throttler/useThrottledValue.js.map +0 -1
  192. package/dist/throttler/useThrottler.cjs +0 -146
  193. package/dist/throttler/useThrottler.cjs.map +0 -1
  194. package/dist/throttler/useThrottler.d.cts +0 -156
  195. package/dist/throttler/useThrottler.js.map +0 -1
  196. package/dist/types/index.cjs +0 -8
  197. package/dist/types/index.d.cts +0 -1
  198. package/dist/utils/index.cjs +0 -8
  199. package/dist/utils/index.d.cts +0 -1
  200. package/src/async-batcher/index.ts +0 -4
  201. package/src/async-batcher/useAsyncBatchedCallback.ts +0 -53
  202. package/src/async-batcher/useAsyncBatcher.ts +0 -293
  203. package/src/async-debouncer/index.ts +0 -5
  204. package/src/async-debouncer/useAsyncDebouncedCallback.ts +0 -55
  205. package/src/async-debouncer/useAsyncDebouncer.ts +0 -274
  206. package/src/async-queuer/index.ts +0 -4
  207. package/src/async-queuer/useAsyncQueuedState.ts +0 -165
  208. package/src/async-queuer/useAsyncQueuer.ts +0 -293
  209. package/src/async-rate-limiter/index.ts +0 -5
  210. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +0 -68
  211. package/src/async-rate-limiter/useAsyncRateLimiter.ts +0 -294
  212. package/src/async-retryer/index.ts +0 -2
  213. package/src/async-throttler/index.ts +0 -5
  214. package/src/async-throttler/useAsyncThrottledCallback.ts +0 -52
  215. package/src/async-throttler/useAsyncThrottler.ts +0 -285
  216. package/src/batcher/index.ts +0 -4
  217. package/src/batcher/useBatchedCallback.ts +0 -46
  218. package/src/batcher/useBatcher.ts +0 -241
  219. package/src/debouncer/index.ts +0 -7
  220. package/src/debouncer/useDebouncedCallback.ts +0 -51
  221. package/src/debouncer/useDebouncedState.ts +0 -106
  222. package/src/debouncer/useDebouncedValue.ts +0 -109
  223. package/src/debouncer/useDebouncer.ts +0 -219
  224. package/src/index.ts +0 -56
  225. package/src/provider/PacerProvider.tsx +0 -70
  226. package/src/provider/index.ts +0 -1
  227. package/src/queuer/index.ts +0 -5
  228. package/src/queuer/useQueuedState.ts +0 -133
  229. package/src/queuer/useQueuedValue.ts +0 -129
  230. package/src/queuer/useQueuer.ts +0 -251
  231. package/src/rate-limiter/index.ts +0 -6
  232. package/src/rate-limiter/useRateLimitedCallback.ts +0 -68
  233. package/src/rate-limiter/useRateLimitedState.ts +0 -124
  234. package/src/rate-limiter/useRateLimitedValue.ts +0 -110
  235. package/src/rate-limiter/useRateLimiter.ts +0 -244
  236. package/src/throttler/index.ts +0 -7
  237. package/src/throttler/useThrottledCallback.ts +0 -52
  238. package/src/throttler/useThrottledState.ts +0 -118
  239. package/src/throttler/useThrottledValue.ts +0 -104
  240. package/src/throttler/useThrottler.ts +0 -224
  241. package/src/types/index.ts +0 -1
  242. package/src/utils/index.ts +0 -1
@@ -1 +0,0 @@
1
- {"version":3,"file":"useAsyncThrottler.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { shallow, useSelector } 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 AsyncThrottlerOptions,\n AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncThrottlerOptions<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends AsyncThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: PreactAsyncThrottler<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncThrottler<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state.\n *\n * This is useful for opting into state re-renders for specific parts of the throttler state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the throttler state changes\n *\n * Use this instead of `throttler.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `throttler.state` instead of `throttler.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 `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async throttling ensures an async function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,\n * database operations, or other async tasks.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled 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 throttled function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler 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 `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the throttled function is currently executing asynchronously\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `lastResult`: The result from the most recent successful function execution\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\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 throttler = useAsyncThrottler(fn, {\n * wait: 1000,\n * onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your throttled 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 asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data; // Return value is preserved\n * },\n * { wait: 1000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Processing...' : 'Ready'}</div>\n * )}\n * </asyncThrottler.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount,\n * settleCount: state.settleCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * {\n * wait: 1000,\n * onError: (error) => console.error('API call failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncThrottler(\n * async (query) => {\n * const result = await searchAPI(query);\n * setData(result);\n * return result; // Return value can be used by the caller\n * },\n * {\n * wait: 2000,\n * leading: true, // Execute immediately on first call\n * trailing: false // Skip trailing edge updates\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: PreactAsyncThrottlerOptions<TFn, TSelected>,\n selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncThrottler,\n ...options,\n } as PreactAsyncThrottlerOptions<TFn, TSelected>\n const [asyncThrottler] = useState(() => {\n const throttlerInstance = new AsyncThrottler<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncThrottler<TFn, TSelected>\n\n throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(throttlerInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return throttlerInstance\n })\n\n asyncThrottler.fn = fn\n asyncThrottler.setOptions(mergedOptions)\n\n const state = useSelector(asyncThrottler.store, selector, {\n compare: shallow,\n })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(asyncThrottler)\n } else {\n asyncThrottler.cancel()\n asyncThrottler.abort()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...asyncThrottler,\n state,\n }) as PreactAsyncThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncThrottler, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgOA,SAAgB,kBACd,IACA,SACA,kBACG,CAAC,IACkC;CACtC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,CAAC,kBAAkB,eAAe;EACtC,MAAM,oBAAoB,IAAI,eAC5B,IACA,aACF;EAEA,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,YAAY,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAAS,QACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,eAAe,KAAK;CACpB,eAAe,WAAW,aAAa;CAEvC,MAAM,QAAQ,YAAY,eAAe,OAAO,UAAU,EACxD,SAAS,QACX,CAAC;CAGD,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,cAAc;QACjC;IACL,eAAe,OAAO;IACtB,eAAe,MAAM;GACvB;EACF;CACF,GAAG,CAAC,CAAC;CAGL,OAAO,eAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,gBAAgB,KAAK,CACxB;AACF"}
@@ -1,13 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_useBatcher = require('./useBatcher.cjs');
3
- const require_useBatchedCallback = require('./useBatchedCallback.cjs');
4
-
5
- exports.useBatchedCallback = require_useBatchedCallback.useBatchedCallback;
6
- exports.useBatcher = require_useBatcher.useBatcher;
7
- var _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
8
- Object.keys(_tanstack_pacer_batcher).forEach(function (k) {
9
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
10
- enumerable: true,
11
- get: function () { return _tanstack_pacer_batcher[k]; }
12
- });
13
- });
@@ -1,4 +0,0 @@
1
- import { PreactBatcher, PreactBatcherOptions, useBatcher } from "./useBatcher.cjs";
2
- import { useBatchedCallback } from "./useBatchedCallback.cjs";
3
- export * from "@tanstack/pacer/batcher";
4
- export { PreactBatcher, PreactBatcherOptions, useBatchedCallback, useBatcher };
@@ -1,47 +0,0 @@
1
- const require_useBatcher = require('./useBatcher.cjs');
2
- let preact_hooks = require("preact/hooks");
3
-
4
- //#region src/batcher/useBatchedCallback.ts
5
- /**
6
- * A Preact hook that creates a batched version of a callback function.
7
- * This hook is essentially a wrapper around the basic `batch` function
8
- * that is exported from `@tanstack/pacer`,
9
- * but optimized for Preact with reactive options and a stable function reference.
10
- *
11
- * The batched function will collect individual calls into batches and execute them
12
- * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
13
- *
14
- * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
15
- * batching needs. However, it does not expose the underlying Batcher instance.
16
- *
17
- * For advanced usage requiring features like:
18
- * - Manual batch execution
19
- * - Access to batch state and metrics
20
- * - Custom useCallback dependencies
21
- *
22
- * Consider using the `useBatcher` hook instead.
23
- *
24
- * @example
25
- * ```tsx
26
- * // Batch analytics events
27
- * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
28
- * sendAnalytics(events);
29
- * }, {
30
- * maxSize: 5, // Process when 5 events collected
31
- * wait: 2000 // Or after 2 seconds
32
- * });
33
- *
34
- * // Use in event handlers
35
- * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
36
- * Click me
37
- * </button>
38
- * ```
39
- */
40
- function useBatchedCallback(fn, options) {
41
- const batchedFn = require_useBatcher.useBatcher(fn, options).addItem;
42
- return (0, preact_hooks.useCallback)((item) => batchedFn(item), [batchedFn]);
43
- }
44
-
45
- //#endregion
46
- exports.useBatchedCallback = useBatchedCallback;
47
- //# sourceMappingURL=useBatchedCallback.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useBatchedCallback.cjs","names":["useBatcher","useCallback"],"sources":["../../src/batcher/useBatchedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useBatcher } from './useBatcher'\nimport type { PreactBatcherOptions } from './useBatcher'\n\n/**\n * A Preact hook that creates a batched version of a callback function.\n * This hook is essentially a wrapper around the basic `batch` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The batched function will collect individual calls into batches and execute them\n * when batch conditions are met (max size reached, wait time elapsed, or custom logic).\n *\n * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic\n * batching needs. However, it does not expose the underlying Batcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual batch execution\n * - Access to batch state and metrics\n * - Custom useCallback dependencies\n *\n * Consider using the `useBatcher` hook instead.\n *\n * @example\n * ```tsx\n * // Batch analytics events\n * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {\n * sendAnalytics(events);\n * }, {\n * maxSize: 5, // Process when 5 events collected\n * wait: 2000 // Or after 2 seconds\n * });\n *\n * // Use in event handlers\n * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>\n * Click me\n * </button>\n * ```\n */\nexport function useBatchedCallback<TValue>(\n fn: (items: Array<TValue>) => void,\n options: PreactBatcherOptions<TValue, {}>,\n): (item: TValue) => void {\n const batchedFn = useBatcher(fn, options).addItem\n return useCallback((item: TValue) => batchedFn(item), [batchedFn])\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,mBACd,IACA,SACwB;CACxB,MAAM,YAAYA,8BAAW,IAAI,OAAO,CAAC,CAAC;CAC1C,WAAOC,2BAAa,SAAiB,UAAU,IAAI,GAAG,CAAC,SAAS,CAAC;AACnE"}
@@ -1,41 +0,0 @@
1
- import { PreactBatcherOptions } from "./useBatcher.cjs";
2
- //#region src/batcher/useBatchedCallback.d.ts
3
- /**
4
- * A Preact hook that creates a batched version of a callback function.
5
- * This hook is essentially a wrapper around the basic `batch` function
6
- * that is exported from `@tanstack/pacer`,
7
- * but optimized for Preact with reactive options and a stable function reference.
8
- *
9
- * The batched function will collect individual calls into batches and execute them
10
- * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
11
- *
12
- * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
13
- * batching needs. However, it does not expose the underlying Batcher instance.
14
- *
15
- * For advanced usage requiring features like:
16
- * - Manual batch execution
17
- * - Access to batch state and metrics
18
- * - Custom useCallback dependencies
19
- *
20
- * Consider using the `useBatcher` hook instead.
21
- *
22
- * @example
23
- * ```tsx
24
- * // Batch analytics events
25
- * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
26
- * sendAnalytics(events);
27
- * }, {
28
- * maxSize: 5, // Process when 5 events collected
29
- * wait: 2000 // Or after 2 seconds
30
- * });
31
- *
32
- * // Use in event handlers
33
- * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
34
- * Click me
35
- * </button>
36
- * ```
37
- */
38
- declare function useBatchedCallback<TValue>(fn: (items: Array<TValue>) => void, options: PreactBatcherOptions<TValue, {}>): (item: TValue) => void;
39
- //#endregion
40
- export { useBatchedCallback };
41
- //# sourceMappingURL=useBatchedCallback.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useBatchedCallback.js","names":[],"sources":["../../src/batcher/useBatchedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useBatcher } from './useBatcher'\nimport type { PreactBatcherOptions } from './useBatcher'\n\n/**\n * A Preact hook that creates a batched version of a callback function.\n * This hook is essentially a wrapper around the basic `batch` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The batched function will collect individual calls into batches and execute them\n * when batch conditions are met (max size reached, wait time elapsed, or custom logic).\n *\n * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic\n * batching needs. However, it does not expose the underlying Batcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual batch execution\n * - Access to batch state and metrics\n * - Custom useCallback dependencies\n *\n * Consider using the `useBatcher` hook instead.\n *\n * @example\n * ```tsx\n * // Batch analytics events\n * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {\n * sendAnalytics(events);\n * }, {\n * maxSize: 5, // Process when 5 events collected\n * wait: 2000 // Or after 2 seconds\n * });\n *\n * // Use in event handlers\n * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>\n * Click me\n * </button>\n * ```\n */\nexport function useBatchedCallback<TValue>(\n fn: (items: Array<TValue>) => void,\n options: PreactBatcherOptions<TValue, {}>,\n): (item: TValue) => void {\n const batchedFn = useBatcher(fn, options).addItem\n return useCallback((item: TValue) => batchedFn(item), [batchedFn])\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,mBACd,IACA,SACwB;CACxB,MAAM,YAAY,WAAW,IAAI,OAAO,CAAC,CAAC;CAC1C,OAAO,aAAa,SAAiB,UAAU,IAAI,GAAG,CAAC,SAAS,CAAC;AACnE"}
@@ -1,165 +0,0 @@
1
- const require_PacerProvider = require('../provider/PacerProvider.cjs');
2
- let preact_hooks = require("preact/hooks");
3
- let _tanstack_preact_store = require("@tanstack/preact-store");
4
- let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
5
-
6
- //#region src/batcher/useBatcher.ts
7
- /**
8
- * A Preact hook that creates and manages a Batcher instance.
9
- *
10
- * This is a lower-level hook that provides direct access to the Batcher's functionality without
11
- * any built-in state management. This allows you to integrate it with any state management solution
12
- * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
13
- *
14
- * The Batcher collects items and processes them in batches based on configurable conditions:
15
- * - Maximum batch size
16
- * - Time-based batching (process after X milliseconds)
17
- * - Custom batch processing logic via getShouldExecute
18
- *
19
- * ## State Management and Selector
20
- *
21
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
22
- * in two ways:
23
- *
24
- * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
25
- *
26
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
27
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
28
- * in child components.
29
- *
30
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
31
- *
32
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
33
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
34
- * state changes occur.
35
- *
36
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
37
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
38
- * re-renders and gives you full control over when your component updates.
39
- *
40
- * Available state properties:
41
- * - `executionCount`: Number of batch executions that have been completed
42
- * - `isEmpty`: Whether the batcher has no items to process
43
- * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
44
- * - `isRunning`: Whether the batcher is active and will process items automatically
45
- * - `items`: Array of items currently queued for batch processing
46
- * - `size`: Number of items currently in the batch queue
47
- * - `status`: Current processing status ('idle' | 'pending')
48
- * - `totalItemsProcessed`: Total number of items processed across all batches
49
- *
50
- * ## Unmount behavior
51
- *
52
- * By default, the hook cancels any pending batch when the component unmounts.
53
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
54
- *
55
- * ```tsx
56
- * const batcher = useBatcher(fn, {
57
- * maxSize: 10,
58
- * wait: 2000,
59
- * onUnmount: (b) => b.flush()
60
- * });
61
- * ```
62
- *
63
- * @example
64
- * ```tsx
65
- * // Default behavior - no reactive state subscriptions
66
- * const batcher = useBatcher<number>(
67
- * (items) => console.log('Processing batch:', items),
68
- * { maxSize: 5, wait: 2000 }
69
- * );
70
- *
71
- * // Subscribe to state changes deep in component tree using Subscribe HOC
72
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
73
- * {({ size }) => (
74
- * <div>Batch Size: {size}</div>
75
- * )}
76
- * </batcher.Subscribe>
77
- *
78
- * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
79
- * const batcher = useBatcher<number>(
80
- * (items) => console.log('Processing batch:', items),
81
- * { maxSize: 5, wait: 2000 },
82
- * (state) => ({
83
- * size: state.size,
84
- * isEmpty: state.isEmpty
85
- * })
86
- * );
87
- *
88
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
89
- * const batcher = useBatcher<number>(
90
- * (items) => console.log('Processing batch:', items),
91
- * { maxSize: 5, wait: 2000 },
92
- * (state) => ({
93
- * executionCount: state.executionCount,
94
- * totalItemsProcessed: state.totalItemsProcessed
95
- * })
96
- * );
97
- *
98
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
99
- * const batcher = useBatcher<number>(
100
- * (items) => console.log('Processing batch:', items),
101
- * { maxSize: 5, wait: 2000 },
102
- * (state) => ({
103
- * isPending: state.isPending,
104
- * isRunning: state.isRunning,
105
- * status: state.status
106
- * })
107
- * );
108
- *
109
- * // Example with custom state management and batching
110
- * const [items, setItems] = useState([]);
111
- *
112
- * const batcher = useBatcher<number>(
113
- * (items) => console.log('Processing batch:', items),
114
- * {
115
- * maxSize: 5,
116
- * wait: 2000,
117
- * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
118
- * getShouldExecute: (items) => items.length >= 3
119
- * }
120
- * );
121
- *
122
- * // Add items to batch - they'll be processed when conditions are met
123
- * batcher.addItem(1);
124
- * batcher.addItem(2);
125
- * batcher.addItem(3); // Triggers batch processing
126
- *
127
- * // Control the batcher
128
- * batcher.stop(); // Pause batching
129
- * batcher.start(); // Resume batching
130
- *
131
- * // Access the selected state (will be empty object {} unless selector provided)
132
- * const { size, isPending } = batcher.state;
133
- * ```
134
- */
135
- function useBatcher(fn, options = {}, selector = () => ({})) {
136
- const mergedOptions = {
137
- ...require_PacerProvider.useDefaultPacerOptions().batcher,
138
- ...options
139
- };
140
- const [batcher] = (0, preact_hooks.useState)(() => {
141
- const batcherInstance = new _tanstack_pacer_batcher.Batcher(fn, mergedOptions);
142
- batcherInstance.Subscribe = function Subscribe(props) {
143
- const selected = (0, _tanstack_preact_store.useSelector)(batcherInstance.store, props.selector, { compare: _tanstack_preact_store.shallow });
144
- return typeof props.children === "function" ? props.children(selected) : props.children;
145
- };
146
- return batcherInstance;
147
- });
148
- batcher.fn = fn;
149
- batcher.setOptions(mergedOptions);
150
- (0, preact_hooks.useEffect)(() => {
151
- return () => {
152
- if (mergedOptions.onUnmount) mergedOptions.onUnmount(batcher);
153
- else batcher.cancel();
154
- };
155
- }, []);
156
- const state = (0, _tanstack_preact_store.useSelector)(batcher.store, selector, { compare: _tanstack_preact_store.shallow });
157
- return (0, preact_hooks.useMemo)(() => ({
158
- ...batcher,
159
- state
160
- }), [batcher, state]);
161
- }
162
-
163
- //#endregion
164
- exports.useBatcher = useBatcher;
165
- //# sourceMappingURL=useBatcher.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useBatcher.cjs","names":["useDefaultPacerOptions","useState","Batcher","useSelector","shallow","useMemo"],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactBatcherOptions<\n TValue,\n TSelected = {},\n> extends BatcherOptions<TValue> {\n /**\n * Optional callback invoked when the component unmounts. Receives the batcher instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (batcher: PreactBatcher<TValue, TSelected>) => void\n}\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.\n *\n * This is useful for opting into state re-renders for specific parts of the batcher state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n * {({ size }) => (\n * <div>Batch Size: {size}</div>\n * )}\n * </batcher.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: BatcherState<TValue>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the batcher state changes\n *\n * Use this instead of `batcher.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `batcher.state` instead of `batcher.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 `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 `batcher.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 * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending batch when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const batcher = useBatcher(fn, {\n * maxSize: 10,\n * wait: 2000,\n * onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n * {({ size }) => (\n * <div>Batch Size: {size}</div>\n * )}\n * </batcher.Subscribe>\n *\n * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * size: state.size,\n * isEmpty: state.isEmpty\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * executionCount: state.executionCount,\n * totalItemsProcessed: state.totalItemsProcessed\n * })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * isPending: state.isPending,\n * isRunning: state.isRunning,\n * status: state.status\n * })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * {\n * maxSize: 5,\n * wait: 2000,\n * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n * getShouldExecute: (items) => items.length >= 3\n * }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop(); // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => void,\n options: PreactBatcherOptions<TValue, TSelected> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().batcher,\n ...options,\n } as PreactBatcherOptions<TValue, TSelected>\n\n const [batcher] = useState(() => {\n const batcherInstance = new Batcher<TValue>(\n fn,\n mergedOptions,\n ) as unknown as PreactBatcher<TValue, TSelected>\n\n batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: BatcherState<TValue>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(batcherInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return batcherInstance\n })\n\n batcher.fn = fn\n batcher.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(batcher)\n } else {\n batcher.cancel()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n const state = useSelector(batcher.store, selector, { compare: shallow })\n\n return useMemo(\n () =>\n ({\n ...batcher,\n state,\n }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n [batcher, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsLA,SAAgB,WACd,IACA,UAAmD,CAAC,GACpD,kBACG,CAAC,IAC8B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,6CAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CAEA,MAAM,CAAC,eAAWC,6BAAe;EAC/B,MAAM,kBAAkB,IAAIC,gCAC1B,IACA,aACF;EAEA,gBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,eAAWC,oCAAY,gBAAgB,OAAO,MAAM,UAAU,EAClE,SAASC,+BACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,QAAQ,KAAK;CACb,QAAQ,WAAW,aAAa;CAGhC,kCAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;QAE/B,QAAQ,OAAO;EAEnB;CACF,GAAG,CAAC,CAAC;CAGL,MAAM,YAAQD,oCAAY,QAAQ,OAAO,UAAU,EAAE,SAASC,+BAAQ,CAAC;CAEvE,WAAOC,6BAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,SAAS,KAAK,CACjB;AACF"}
@@ -1,174 +0,0 @@
1
- import { Store } from "@tanstack/preact-store";
2
- import { ComponentChildren } from "preact";
3
- import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
4
- //#region src/batcher/useBatcher.d.ts
5
- interface PreactBatcherOptions<TValue, TSelected = {}> extends BatcherOptions<TValue> {
6
- /**
7
- * Optional callback invoked when the component unmounts. Receives the batcher instance.
8
- * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
9
- */
10
- onUnmount?: (batcher: PreactBatcher<TValue, TSelected>) => void;
11
- }
12
- interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
13
- /**
14
- * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
15
- *
16
- * This is useful for opting into state re-renders for specific parts of the batcher state
17
- * deep in your component tree without needing to pass a selector to the hook.
18
- *
19
- * @example
20
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
21
- * {({ size }) => (
22
- * <div>Batch Size: {size}</div>
23
- * )}
24
- * </batcher.Subscribe>
25
- */
26
- Subscribe: <TSelected>(props: {
27
- selector: (state: BatcherState<TValue>) => TSelected;
28
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
29
- }) => ComponentChildren;
30
- /**
31
- * Reactive state that will be updated and re-rendered when the batcher state changes
32
- *
33
- * Use this instead of `batcher.store.state`
34
- */
35
- readonly state: Readonly<TSelected>;
36
- /**
37
- * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
38
- * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
39
- * Although, you can make the state reactive by using the `useSelector` in your own usage.
40
- */
41
- readonly store: Store<Readonly<BatcherState<TValue>>>;
42
- }
43
- /**
44
- * A Preact hook that creates and manages a Batcher instance.
45
- *
46
- * This is a lower-level hook that provides direct access to the Batcher's functionality without
47
- * any built-in state management. This allows you to integrate it with any state management solution
48
- * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
49
- *
50
- * The Batcher collects items and processes them in batches based on configurable conditions:
51
- * - Maximum batch size
52
- * - Time-based batching (process after X milliseconds)
53
- * - Custom batch processing logic via getShouldExecute
54
- *
55
- * ## State Management and Selector
56
- *
57
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
58
- * in two ways:
59
- *
60
- * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
61
- *
62
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
63
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
64
- * in child components.
65
- *
66
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
67
- *
68
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
69
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
70
- * state changes occur.
71
- *
72
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
73
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
74
- * re-renders and gives you full control over when your component updates.
75
- *
76
- * Available state properties:
77
- * - `executionCount`: Number of batch executions that have been completed
78
- * - `isEmpty`: Whether the batcher has no items to process
79
- * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
80
- * - `isRunning`: Whether the batcher is active and will process items automatically
81
- * - `items`: Array of items currently queued for batch processing
82
- * - `size`: Number of items currently in the batch queue
83
- * - `status`: Current processing status ('idle' | 'pending')
84
- * - `totalItemsProcessed`: Total number of items processed across all batches
85
- *
86
- * ## Unmount behavior
87
- *
88
- * By default, the hook cancels any pending batch when the component unmounts.
89
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
90
- *
91
- * ```tsx
92
- * const batcher = useBatcher(fn, {
93
- * maxSize: 10,
94
- * wait: 2000,
95
- * onUnmount: (b) => b.flush()
96
- * });
97
- * ```
98
- *
99
- * @example
100
- * ```tsx
101
- * // Default behavior - no reactive state subscriptions
102
- * const batcher = useBatcher<number>(
103
- * (items) => console.log('Processing batch:', items),
104
- * { maxSize: 5, wait: 2000 }
105
- * );
106
- *
107
- * // Subscribe to state changes deep in component tree using Subscribe HOC
108
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
109
- * {({ size }) => (
110
- * <div>Batch Size: {size}</div>
111
- * )}
112
- * </batcher.Subscribe>
113
- *
114
- * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
115
- * const batcher = useBatcher<number>(
116
- * (items) => console.log('Processing batch:', items),
117
- * { maxSize: 5, wait: 2000 },
118
- * (state) => ({
119
- * size: state.size,
120
- * isEmpty: state.isEmpty
121
- * })
122
- * );
123
- *
124
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
125
- * const batcher = useBatcher<number>(
126
- * (items) => console.log('Processing batch:', items),
127
- * { maxSize: 5, wait: 2000 },
128
- * (state) => ({
129
- * executionCount: state.executionCount,
130
- * totalItemsProcessed: state.totalItemsProcessed
131
- * })
132
- * );
133
- *
134
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
135
- * const batcher = useBatcher<number>(
136
- * (items) => console.log('Processing batch:', items),
137
- * { maxSize: 5, wait: 2000 },
138
- * (state) => ({
139
- * isPending: state.isPending,
140
- * isRunning: state.isRunning,
141
- * status: state.status
142
- * })
143
- * );
144
- *
145
- * // Example with custom state management and batching
146
- * const [items, setItems] = useState([]);
147
- *
148
- * const batcher = useBatcher<number>(
149
- * (items) => console.log('Processing batch:', items),
150
- * {
151
- * maxSize: 5,
152
- * wait: 2000,
153
- * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
154
- * getShouldExecute: (items) => items.length >= 3
155
- * }
156
- * );
157
- *
158
- * // Add items to batch - they'll be processed when conditions are met
159
- * batcher.addItem(1);
160
- * batcher.addItem(2);
161
- * batcher.addItem(3); // Triggers batch processing
162
- *
163
- * // Control the batcher
164
- * batcher.stop(); // Pause batching
165
- * batcher.start(); // Resume batching
166
- *
167
- * // Access the selected state (will be empty object {} unless selector provided)
168
- * const { size, isPending } = batcher.state;
169
- * ```
170
- */
171
- declare function useBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: PreactBatcherOptions<TValue, TSelected>, selector?: (state: BatcherState<TValue>) => TSelected): PreactBatcher<TValue, TSelected>;
172
- //#endregion
173
- export { PreactBatcher, PreactBatcherOptions, useBatcher };
174
- //# sourceMappingURL=useBatcher.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useBatcher.js","names":[],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactBatcherOptions<\n TValue,\n TSelected = {},\n> extends BatcherOptions<TValue> {\n /**\n * Optional callback invoked when the component unmounts. Receives the batcher instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (batcher: PreactBatcher<TValue, TSelected>) => void\n}\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.\n *\n * This is useful for opting into state re-renders for specific parts of the batcher state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n * {({ size }) => (\n * <div>Batch Size: {size}</div>\n * )}\n * </batcher.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: BatcherState<TValue>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the batcher state changes\n *\n * Use this instead of `batcher.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `batcher.state` instead of `batcher.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 `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 `batcher.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 * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending batch when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const batcher = useBatcher(fn, {\n * maxSize: 10,\n * wait: 2000,\n * onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n * {({ size }) => (\n * <div>Batch Size: {size}</div>\n * )}\n * </batcher.Subscribe>\n *\n * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * size: state.size,\n * isEmpty: state.isEmpty\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * executionCount: state.executionCount,\n * totalItemsProcessed: state.totalItemsProcessed\n * })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 },\n * (state) => ({\n * isPending: state.isPending,\n * isRunning: state.isRunning,\n * status: state.status\n * })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n * (items) => console.log('Processing batch:', items),\n * {\n * maxSize: 5,\n * wait: 2000,\n * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n * getShouldExecute: (items) => items.length >= 3\n * }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop(); // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => void,\n options: PreactBatcherOptions<TValue, TSelected> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().batcher,\n ...options,\n } as PreactBatcherOptions<TValue, TSelected>\n\n const [batcher] = useState(() => {\n const batcherInstance = new Batcher<TValue>(\n fn,\n mergedOptions,\n ) as unknown as PreactBatcher<TValue, TSelected>\n\n batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: BatcherState<TValue>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(batcherInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return batcherInstance\n })\n\n batcher.fn = fn\n batcher.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(batcher)\n } else {\n batcher.cancel()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n const state = useSelector(batcher.store, selector, { compare: shallow })\n\n return useMemo(\n () =>\n ({\n ...batcher,\n state,\n }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n [batcher, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsLA,SAAgB,WACd,IACA,UAAmD,CAAC,GACpD,kBACG,CAAC,IAC8B;CAClC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CAEA,MAAM,CAAC,WAAW,eAAe;EAC/B,MAAM,kBAAkB,IAAI,QAC1B,IACA,aACF;EAEA,gBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,WAAW,YAAY,gBAAgB,OAAO,MAAM,UAAU,EAClE,SAAS,QACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,QAAQ,KAAK;CACb,QAAQ,WAAW,aAAa;CAGhC,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;QAE/B,QAAQ,OAAO;EAEnB;CACF,GAAG,CAAC,CAAC;CAGL,MAAM,QAAQ,YAAY,QAAQ,OAAO,UAAU,EAAE,SAAS,QAAQ,CAAC;CAEvE,OAAO,eAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,SAAS,KAAK,CACjB;AACF"}
@@ -1,17 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_useDebouncer = require('./useDebouncer.cjs');
3
- const require_useDebouncedCallback = require('./useDebouncedCallback.cjs');
4
- const require_useDebouncedState = require('./useDebouncedState.cjs');
5
- const require_useDebouncedValue = require('./useDebouncedValue.cjs');
6
-
7
- exports.useDebouncedCallback = require_useDebouncedCallback.useDebouncedCallback;
8
- exports.useDebouncedState = require_useDebouncedState.useDebouncedState;
9
- exports.useDebouncedValue = require_useDebouncedValue.useDebouncedValue;
10
- exports.useDebouncer = require_useDebouncer.useDebouncer;
11
- var _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
12
- Object.keys(_tanstack_pacer_debouncer).forEach(function (k) {
13
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
14
- enumerable: true,
15
- get: function () { return _tanstack_pacer_debouncer[k]; }
16
- });
17
- });
@@ -1,6 +0,0 @@
1
- import { PreactDebouncer, PreactDebouncerOptions, useDebouncer } from "./useDebouncer.cjs";
2
- import { useDebouncedCallback } from "./useDebouncedCallback.cjs";
3
- import { useDebouncedState } from "./useDebouncedState.cjs";
4
- import { useDebouncedValue } from "./useDebouncedValue.cjs";
5
- export * from "@tanstack/pacer/debouncer";
6
- export { PreactDebouncer, PreactDebouncerOptions, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };
@@ -1,48 +0,0 @@
1
- const require_useDebouncer = require('./useDebouncer.cjs');
2
- let preact_hooks = require("preact/hooks");
3
-
4
- //#region src/debouncer/useDebouncedCallback.ts
5
- /**
6
- * A Preact hook that creates a debounced version of a callback function.
7
- * This hook is essentially a wrapper around the basic `debounce` function
8
- * that is exported from `@tanstack/pacer`,
9
- * but optimized for Preact with reactive options and a stable function reference.
10
- *
11
- * The debounced function will only execute after the specified wait time has elapsed
12
- * since its last invocation. If called again before the wait time expires, the timer
13
- * resets and starts waiting again.
14
- *
15
- * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
16
- * debouncing needs. However, it does not expose the underlying Debouncer instance.
17
- *
18
- * For advanced usage requiring features like:
19
- * - Manual cancellation
20
- * - Access to execution counts
21
- * - Custom useCallback dependencies
22
- *
23
- * Consider using the `useDebouncer` hook instead.
24
- *
25
- * @example
26
- * ```tsx
27
- * // Debounce a search handler
28
- * const handleSearch = useDebouncedCallback((query: string) => {
29
- * fetchSearchResults(query);
30
- * }, {
31
- * wait: 500 // Wait 500ms between executions
32
- * });
33
- *
34
- * // Use in an input
35
- * <input
36
- * type="search"
37
- * onChange={(e) => handleSearch(e.target.value)}
38
- * />
39
- * ```
40
- */
41
- function useDebouncedCallback(fn, options) {
42
- const debouncedFn = require_useDebouncer.useDebouncer(fn, options).maybeExecute;
43
- return (0, preact_hooks.useCallback)((...args) => debouncedFn(...args), [debouncedFn]);
44
- }
45
-
46
- //#endregion
47
- exports.useDebouncedCallback = useDebouncedCallback;
48
- //# sourceMappingURL=useDebouncedCallback.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useDebouncedCallback.cjs","names":["useDebouncer","useCallback"],"sources":["../../src/debouncer/useDebouncedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useDebouncer } from './useDebouncer'\nimport type { PreactDebouncerOptions } from './useDebouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a debounced version of a callback function.\n * This hook is essentially a wrapper around the basic `debounce` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The debounced function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again.\n *\n * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic\n * debouncing needs. However, it does not expose the underlying Debouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useDebouncer` hook instead.\n *\n * @example\n * ```tsx\n * // Debounce a search handler\n * const handleSearch = useDebouncedCallback((query: string) => {\n * fetchSearchResults(query);\n * }, {\n * wait: 500 // Wait 500ms between executions\n * });\n *\n * // Use in an input\n * <input\n * type=\"search\"\n * onChange={(e) => handleSearch(e.target.value)}\n * />\n * ```\n */\nexport function useDebouncedCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: PreactDebouncerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => void {\n const debouncedFn = useDebouncer(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) => debouncedFn(...args),\n [debouncedFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,qBACd,IACA,SACoC;CACpC,MAAM,cAAcA,kCAAa,IAAI,OAAO,CAAC,CAAC;CAC9C,WAAOC,2BACJ,GAAG,SAA0B,YAAY,GAAG,IAAI,GACjD,CAAC,WAAW,CACd;AACF"}