@tanstack/preact-pacer 0.0.1 → 0.18.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 (274) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +165 -45
  3. package/dist/async-batcher/index.cjs +12 -0
  4. package/dist/async-batcher/index.d.cts +4 -0
  5. package/dist/async-batcher/index.d.ts +4 -0
  6. package/dist/async-batcher/index.js +6 -0
  7. package/dist/async-batcher/useAsyncBatchedCallback.cjs +51 -0
  8. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +1 -0
  9. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +46 -0
  10. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +46 -0
  11. package/dist/async-batcher/useAsyncBatchedCallback.js +51 -0
  12. package/dist/async-batcher/useAsyncBatchedCallback.js.map +1 -0
  13. package/dist/async-batcher/useAsyncBatcher.cjs +165 -0
  14. package/dist/async-batcher/useAsyncBatcher.cjs.map +1 -0
  15. package/dist/async-batcher/useAsyncBatcher.d.cts +163 -0
  16. package/dist/async-batcher/useAsyncBatcher.d.ts +163 -0
  17. package/dist/async-batcher/useAsyncBatcher.js +165 -0
  18. package/dist/async-batcher/useAsyncBatcher.js.map +1 -0
  19. package/dist/async-debouncer/index.cjs +12 -0
  20. package/dist/async-debouncer/index.d.cts +4 -0
  21. package/dist/async-debouncer/index.d.ts +4 -0
  22. package/dist/async-debouncer/index.js +6 -0
  23. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs +50 -0
  24. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +1 -0
  25. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +47 -0
  26. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +47 -0
  27. package/dist/async-debouncer/useAsyncDebouncedCallback.js +50 -0
  28. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +1 -0
  29. package/dist/async-debouncer/useAsyncDebouncer.cjs +149 -0
  30. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +1 -0
  31. package/dist/async-debouncer/useAsyncDebouncer.d.cts +143 -0
  32. package/dist/async-debouncer/useAsyncDebouncer.d.ts +143 -0
  33. package/dist/async-debouncer/useAsyncDebouncer.js +149 -0
  34. package/dist/async-debouncer/useAsyncDebouncer.js.map +1 -0
  35. package/dist/async-queuer/index.cjs +12 -0
  36. package/dist/async-queuer/index.d.cts +4 -0
  37. package/dist/async-queuer/index.d.ts +4 -0
  38. package/dist/async-queuer/index.js +6 -0
  39. package/dist/async-queuer/useAsyncQueuedState.cjs +154 -0
  40. package/dist/async-queuer/useAsyncQueuedState.cjs.map +1 -0
  41. package/dist/async-queuer/useAsyncQueuedState.d.cts +152 -0
  42. package/dist/async-queuer/useAsyncQueuedState.d.ts +152 -0
  43. package/dist/async-queuer/useAsyncQueuedState.js +154 -0
  44. package/dist/async-queuer/useAsyncQueuedState.js.map +1 -0
  45. package/dist/async-queuer/useAsyncQueuer.cjs +165 -0
  46. package/dist/async-queuer/useAsyncQueuer.cjs.map +1 -0
  47. package/dist/async-queuer/useAsyncQueuer.d.cts +163 -0
  48. package/dist/async-queuer/useAsyncQueuer.d.ts +163 -0
  49. package/dist/async-queuer/useAsyncQueuer.js +165 -0
  50. package/dist/async-queuer/useAsyncQueuer.js.map +1 -0
  51. package/dist/async-rate-limiter/index.cjs +12 -0
  52. package/dist/async-rate-limiter/index.d.cts +4 -0
  53. package/dist/async-rate-limiter/index.d.ts +4 -0
  54. package/dist/async-rate-limiter/index.js +6 -0
  55. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs +65 -0
  56. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +1 -0
  57. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +62 -0
  58. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +62 -0
  59. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +65 -0
  60. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +1 -0
  61. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +173 -0
  62. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +1 -0
  63. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +172 -0
  64. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +172 -0
  65. package/dist/async-rate-limiter/useAsyncRateLimiter.js +173 -0
  66. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +1 -0
  67. package/dist/async-retryer/index.cjs +9 -0
  68. package/dist/async-retryer/index.d.cts +1 -0
  69. package/dist/async-retryer/index.d.ts +1 -0
  70. package/dist/async-retryer/index.js +3 -0
  71. package/dist/async-throttler/index.cjs +12 -0
  72. package/dist/async-throttler/index.d.cts +4 -0
  73. package/dist/async-throttler/index.d.ts +4 -0
  74. package/dist/async-throttler/index.js +6 -0
  75. package/dist/async-throttler/useAsyncThrottledCallback.cjs +48 -0
  76. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +1 -0
  77. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +45 -0
  78. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +45 -0
  79. package/dist/async-throttler/useAsyncThrottledCallback.js +48 -0
  80. package/dist/async-throttler/useAsyncThrottledCallback.js.map +1 -0
  81. package/dist/async-throttler/useAsyncThrottler.cjs +158 -0
  82. package/dist/async-throttler/useAsyncThrottler.cjs.map +1 -0
  83. package/dist/async-throttler/useAsyncThrottler.d.cts +154 -0
  84. package/dist/async-throttler/useAsyncThrottler.d.ts +154 -0
  85. package/dist/async-throttler/useAsyncThrottler.js +158 -0
  86. package/dist/async-throttler/useAsyncThrottler.js.map +1 -0
  87. package/dist/batcher/index.cjs +12 -0
  88. package/dist/batcher/index.d.cts +4 -0
  89. package/dist/batcher/index.d.ts +4 -0
  90. package/dist/batcher/index.js +6 -0
  91. package/dist/batcher/useBatchedCallback.cjs +47 -0
  92. package/dist/batcher/useBatchedCallback.cjs.map +1 -0
  93. package/dist/batcher/useBatchedCallback.d.cts +44 -0
  94. package/dist/batcher/useBatchedCallback.d.ts +44 -0
  95. package/dist/batcher/useBatchedCallback.js +47 -0
  96. package/dist/batcher/useBatchedCallback.js.map +1 -0
  97. package/dist/batcher/useBatcher.cjs +122 -0
  98. package/dist/batcher/useBatcher.cjs.map +1 -0
  99. package/dist/batcher/useBatcher.d.cts +120 -0
  100. package/dist/batcher/useBatcher.d.ts +120 -0
  101. package/dist/batcher/useBatcher.js +122 -0
  102. package/dist/batcher/useBatcher.js.map +1 -0
  103. package/dist/debouncer/index.cjs +16 -0
  104. package/dist/debouncer/index.d.cts +6 -0
  105. package/dist/debouncer/index.d.ts +6 -0
  106. package/dist/debouncer/index.js +8 -0
  107. package/dist/debouncer/useDebouncedCallback.cjs +48 -0
  108. package/dist/debouncer/useDebouncedCallback.cjs.map +1 -0
  109. package/dist/debouncer/useDebouncedCallback.d.cts +45 -0
  110. package/dist/debouncer/useDebouncedCallback.d.ts +45 -0
  111. package/dist/debouncer/useDebouncedCallback.js +48 -0
  112. package/dist/debouncer/useDebouncedCallback.js.map +1 -0
  113. package/dist/debouncer/useDebouncedState.cjs +89 -0
  114. package/dist/debouncer/useDebouncedState.cjs.map +1 -0
  115. package/dist/debouncer/useDebouncedState.d.cts +82 -0
  116. package/dist/debouncer/useDebouncedState.d.ts +82 -0
  117. package/dist/debouncer/useDebouncedState.js +89 -0
  118. package/dist/debouncer/useDebouncedState.js.map +1 -0
  119. package/dist/debouncer/useDebouncedValue.cjs +96 -0
  120. package/dist/debouncer/useDebouncedValue.cjs.map +1 -0
  121. package/dist/debouncer/useDebouncedValue.d.cts +91 -0
  122. package/dist/debouncer/useDebouncedValue.d.ts +91 -0
  123. package/dist/debouncer/useDebouncedValue.js +96 -0
  124. package/dist/debouncer/useDebouncedValue.js.map +1 -0
  125. package/dist/debouncer/useDebouncer.cjs +104 -0
  126. package/dist/debouncer/useDebouncer.cjs.map +1 -0
  127. package/dist/debouncer/useDebouncer.d.cts +98 -0
  128. package/dist/debouncer/useDebouncer.d.ts +98 -0
  129. package/dist/debouncer/useDebouncer.js +104 -0
  130. package/dist/debouncer/useDebouncer.js.map +1 -0
  131. package/dist/index.cjs +66 -0
  132. package/dist/index.d.cts +30 -0
  133. package/dist/index.d.ts +30 -0
  134. package/dist/index.js +32 -0
  135. package/dist/provider/PacerProvider.cjs +26 -0
  136. package/dist/provider/PacerProvider.cjs.map +1 -0
  137. package/dist/provider/PacerProvider.d.cts +33 -0
  138. package/dist/provider/PacerProvider.d.ts +33 -0
  139. package/dist/provider/PacerProvider.js +24 -0
  140. package/dist/provider/PacerProvider.js.map +1 -0
  141. package/dist/provider/index.cjs +5 -0
  142. package/dist/provider/index.d.cts +2 -0
  143. package/dist/provider/index.d.ts +2 -0
  144. package/dist/provider/index.js +3 -0
  145. package/dist/queuer/index.cjs +14 -0
  146. package/dist/queuer/index.d.cts +5 -0
  147. package/dist/queuer/index.d.ts +5 -0
  148. package/dist/queuer/index.js +7 -0
  149. package/dist/queuer/useQueuedState.cjs +129 -0
  150. package/dist/queuer/useQueuedState.cjs.map +1 -0
  151. package/dist/queuer/useQueuedState.d.cts +123 -0
  152. package/dist/queuer/useQueuedState.d.ts +123 -0
  153. package/dist/queuer/useQueuedState.js +129 -0
  154. package/dist/queuer/useQueuedState.js.map +1 -0
  155. package/dist/queuer/useQueuedValue.cjs +115 -0
  156. package/dist/queuer/useQueuedValue.cjs.map +1 -0
  157. package/dist/queuer/useQueuedValue.d.cts +106 -0
  158. package/dist/queuer/useQueuedValue.d.ts +106 -0
  159. package/dist/queuer/useQueuedValue.js +115 -0
  160. package/dist/queuer/useQueuedValue.js.map +1 -0
  161. package/dist/queuer/useQueuer.cjs +133 -0
  162. package/dist/queuer/useQueuer.cjs.map +1 -0
  163. package/dist/queuer/useQueuer.d.cts +131 -0
  164. package/dist/queuer/useQueuer.d.ts +131 -0
  165. package/dist/queuer/useQueuer.js +133 -0
  166. package/dist/queuer/useQueuer.js.map +1 -0
  167. package/dist/rate-limiter/index.cjs +16 -0
  168. package/dist/rate-limiter/index.d.cts +6 -0
  169. package/dist/rate-limiter/index.d.ts +6 -0
  170. package/dist/rate-limiter/index.js +8 -0
  171. package/dist/rate-limiter/useRateLimitedCallback.cjs +65 -0
  172. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +1 -0
  173. package/dist/rate-limiter/useRateLimitedCallback.d.cts +62 -0
  174. package/dist/rate-limiter/useRateLimitedCallback.d.ts +62 -0
  175. package/dist/rate-limiter/useRateLimitedCallback.js +65 -0
  176. package/dist/rate-limiter/useRateLimitedCallback.js.map +1 -0
  177. package/dist/rate-limiter/useRateLimitedState.cjs +115 -0
  178. package/dist/rate-limiter/useRateLimitedState.cjs.map +1 -0
  179. package/dist/rate-limiter/useRateLimitedState.d.cts +108 -0
  180. package/dist/rate-limiter/useRateLimitedState.d.ts +108 -0
  181. package/dist/rate-limiter/useRateLimitedState.js +115 -0
  182. package/dist/rate-limiter/useRateLimitedState.js.map +1 -0
  183. package/dist/rate-limiter/useRateLimitedValue.cjs +102 -0
  184. package/dist/rate-limiter/useRateLimitedValue.cjs.map +1 -0
  185. package/dist/rate-limiter/useRateLimitedValue.d.cts +97 -0
  186. package/dist/rate-limiter/useRateLimitedValue.d.ts +97 -0
  187. package/dist/rate-limiter/useRateLimitedValue.js +102 -0
  188. package/dist/rate-limiter/useRateLimitedValue.js.map +1 -0
  189. package/dist/rate-limiter/useRateLimiter.cjs +138 -0
  190. package/dist/rate-limiter/useRateLimiter.cjs.map +1 -0
  191. package/dist/rate-limiter/useRateLimiter.d.cts +137 -0
  192. package/dist/rate-limiter/useRateLimiter.d.ts +137 -0
  193. package/dist/rate-limiter/useRateLimiter.js +138 -0
  194. package/dist/rate-limiter/useRateLimiter.js.map +1 -0
  195. package/dist/throttler/index.cjs +16 -0
  196. package/dist/throttler/index.d.cts +6 -0
  197. package/dist/throttler/index.d.ts +6 -0
  198. package/dist/throttler/index.js +8 -0
  199. package/dist/throttler/useThrottledCallback.cjs +49 -0
  200. package/dist/throttler/useThrottledCallback.cjs.map +1 -0
  201. package/dist/throttler/useThrottledCallback.d.cts +46 -0
  202. package/dist/throttler/useThrottledCallback.d.ts +46 -0
  203. package/dist/throttler/useThrottledCallback.js +49 -0
  204. package/dist/throttler/useThrottledCallback.js.map +1 -0
  205. package/dist/throttler/useThrottledState.cjs +100 -0
  206. package/dist/throttler/useThrottledState.cjs.map +1 -0
  207. package/dist/throttler/useThrottledState.d.cts +93 -0
  208. package/dist/throttler/useThrottledState.d.ts +93 -0
  209. package/dist/throttler/useThrottledState.js +100 -0
  210. package/dist/throttler/useThrottledState.js.map +1 -0
  211. package/dist/throttler/useThrottledValue.cjs +91 -0
  212. package/dist/throttler/useThrottledValue.cjs.map +1 -0
  213. package/dist/throttler/useThrottledValue.d.cts +86 -0
  214. package/dist/throttler/useThrottledValue.d.ts +86 -0
  215. package/dist/throttler/useThrottledValue.js +91 -0
  216. package/dist/throttler/useThrottledValue.js.map +1 -0
  217. package/dist/throttler/useThrottler.cjs +109 -0
  218. package/dist/throttler/useThrottler.cjs.map +1 -0
  219. package/dist/throttler/useThrottler.d.cts +103 -0
  220. package/dist/throttler/useThrottler.d.ts +103 -0
  221. package/dist/throttler/useThrottler.js +109 -0
  222. package/dist/throttler/useThrottler.js.map +1 -0
  223. package/dist/types/index.cjs +9 -0
  224. package/dist/types/index.d.cts +1 -0
  225. package/dist/types/index.d.ts +1 -0
  226. package/dist/types/index.js +3 -0
  227. package/dist/utils/index.cjs +9 -0
  228. package/dist/utils/index.d.cts +1 -0
  229. package/dist/utils/index.d.ts +1 -0
  230. package/dist/utils/index.js +3 -0
  231. package/package.json +118 -7
  232. package/src/async-batcher/index.ts +4 -0
  233. package/src/async-batcher/useAsyncBatchedCallback.ts +54 -0
  234. package/src/async-batcher/useAsyncBatcher.ts +198 -0
  235. package/src/async-debouncer/index.ts +5 -0
  236. package/src/async-debouncer/useAsyncDebouncedCallback.ts +54 -0
  237. package/src/async-debouncer/useAsyncDebouncer.ts +184 -0
  238. package/src/async-queuer/index.ts +4 -0
  239. package/src/async-queuer/useAsyncQueuedState.ts +165 -0
  240. package/src/async-queuer/useAsyncQueuer.ts +198 -0
  241. package/src/async-rate-limiter/index.ts +5 -0
  242. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +69 -0
  243. package/src/async-rate-limiter/useAsyncRateLimiter.ts +210 -0
  244. package/src/async-retryer/index.ts +2 -0
  245. package/src/async-throttler/index.ts +5 -0
  246. package/src/async-throttler/useAsyncThrottledCallback.ts +52 -0
  247. package/src/async-throttler/useAsyncThrottler.ts +193 -0
  248. package/src/batcher/index.ts +4 -0
  249. package/src/batcher/useBatchedCallback.ts +50 -0
  250. package/src/batcher/useBatcher.ts +150 -0
  251. package/src/debouncer/index.ts +7 -0
  252. package/src/debouncer/useDebouncedCallback.ts +51 -0
  253. package/src/debouncer/useDebouncedState.ts +109 -0
  254. package/src/debouncer/useDebouncedValue.ts +112 -0
  255. package/src/debouncer/useDebouncer.ts +136 -0
  256. package/src/index.ts +56 -0
  257. package/src/provider/PacerProvider.tsx +70 -0
  258. package/src/provider/index.ts +1 -0
  259. package/src/queuer/index.ts +5 -0
  260. package/src/queuer/useQueuedState.ts +133 -0
  261. package/src/queuer/useQueuedValue.ts +129 -0
  262. package/src/queuer/useQueuer.ts +160 -0
  263. package/src/rate-limiter/index.ts +6 -0
  264. package/src/rate-limiter/useRateLimitedCallback.ts +68 -0
  265. package/src/rate-limiter/useRateLimitedState.ts +124 -0
  266. package/src/rate-limiter/useRateLimitedValue.ts +110 -0
  267. package/src/rate-limiter/useRateLimiter.ts +169 -0
  268. package/src/throttler/index.ts +7 -0
  269. package/src/throttler/useThrottledCallback.ts +52 -0
  270. package/src/throttler/useThrottledState.ts +121 -0
  271. package/src/throttler/useThrottledValue.ts +107 -0
  272. package/src/throttler/useThrottler.ts +141 -0
  273. package/src/types/index.ts +1 -0
  274. package/src/utils/index.ts +1 -0
@@ -0,0 +1,47 @@
1
+ import { useBatcher } from "./useBatcher.js";
2
+ import { useCallback } from "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 = useBatcher(fn, options).addItem;
42
+ return useCallback((...args) => batchedFn(args[0]), [batchedFn]);
43
+ }
44
+
45
+ //#endregion
46
+ export { useBatchedCallback };
47
+ //# sourceMappingURL=useBatchedCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useBatchedCallback.js","names":[],"sources":["../../src/batcher/useBatchedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useBatcher } from './useBatcher'\nimport type { BatcherOptions } from '@tanstack/pacer/batcher'\nimport type { AnyFunction } from '@tanstack/pacer/types'\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<TFn extends AnyFunction>(\n fn: (items: Array<Parameters<TFn>[0]>) => void,\n options: BatcherOptions<Parameters<TFn>[0]>,\n): (...args: Parameters<TFn>) => void {\n const batchedFn = useBatcher(fn, options).addItem\n return useCallback(\n (...args: Parameters<TFn>) => batchedFn(args[0]),\n [batchedFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,mBACd,IACA,SACoC;CACpC,MAAM,YAAY,WAAW,IAAI,QAAQ,CAAC;AAC1C,QAAO,aACJ,GAAG,SAA0B,UAAU,KAAK,GAAG,EAChD,CAAC,UAAU,CACZ"}
@@ -0,0 +1,122 @@
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. The `selector` parameter allows you
22
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
23
+ * unnecessary re-renders when irrelevant state changes occur.
24
+ *
25
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
26
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
27
+ * full control over when your component updates. Only when you provide a selector will the
28
+ * component re-render when the selected state values change.
29
+ *
30
+ * Available state properties:
31
+ * - `executionCount`: Number of batch executions that have been completed
32
+ * - `isEmpty`: Whether the batcher has no items to process
33
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
34
+ * - `isRunning`: Whether the batcher is active and will process items automatically
35
+ * - `items`: Array of items currently queued for batch processing
36
+ * - `size`: Number of items currently in the batch queue
37
+ * - `status`: Current processing status ('idle' | 'pending')
38
+ * - `totalItemsProcessed`: Total number of items processed across all batches
39
+ *
40
+ * @example
41
+ * ```tsx
42
+ * // Default behavior - no reactive state subscriptions
43
+ * const batcher = useBatcher<number>(
44
+ * (items) => console.log('Processing batch:', items),
45
+ * { maxSize: 5, wait: 2000 }
46
+ * );
47
+ *
48
+ * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
49
+ * const batcher = useBatcher<number>(
50
+ * (items) => console.log('Processing batch:', items),
51
+ * { maxSize: 5, wait: 2000 },
52
+ * (state) => ({
53
+ * size: state.size,
54
+ * isEmpty: state.isEmpty
55
+ * })
56
+ * );
57
+ *
58
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
59
+ * const batcher = useBatcher<number>(
60
+ * (items) => console.log('Processing batch:', items),
61
+ * { maxSize: 5, wait: 2000 },
62
+ * (state) => ({
63
+ * executionCount: state.executionCount,
64
+ * totalItemsProcessed: state.totalItemsProcessed
65
+ * })
66
+ * );
67
+ *
68
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
69
+ * const batcher = useBatcher<number>(
70
+ * (items) => console.log('Processing batch:', items),
71
+ * { maxSize: 5, wait: 2000 },
72
+ * (state) => ({
73
+ * isPending: state.isPending,
74
+ * isRunning: state.isRunning,
75
+ * status: state.status
76
+ * })
77
+ * );
78
+ *
79
+ * // Example with custom state management and batching
80
+ * const [items, setItems] = useState([]);
81
+ *
82
+ * const batcher = useBatcher<number>(
83
+ * (items) => console.log('Processing batch:', items),
84
+ * {
85
+ * maxSize: 5,
86
+ * wait: 2000,
87
+ * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
88
+ * getShouldExecute: (items) => items.length >= 3
89
+ * }
90
+ * );
91
+ *
92
+ * // Add items to batch - they'll be processed when conditions are met
93
+ * batcher.addItem(1);
94
+ * batcher.addItem(2);
95
+ * batcher.addItem(3); // Triggers batch processing
96
+ *
97
+ * // Control the batcher
98
+ * batcher.stop(); // Pause batching
99
+ * batcher.start(); // Resume batching
100
+ *
101
+ * // Access the selected state (will be empty object {} unless selector provided)
102
+ * const { size, isPending } = batcher.state;
103
+ * ```
104
+ */
105
+ function useBatcher(fn, options = {}, selector = () => ({})) {
106
+ const mergedOptions = {
107
+ ...require_PacerProvider.useDefaultPacerOptions().batcher,
108
+ ...options
109
+ };
110
+ const [batcher] = (0, preact_hooks.useState)(() => new __tanstack_pacer_batcher.Batcher(fn, mergedOptions));
111
+ batcher.fn = fn;
112
+ batcher.setOptions(mergedOptions);
113
+ const state = (0, __tanstack_preact_store.useStore)(batcher.store, selector);
114
+ return (0, preact_hooks.useMemo)(() => ({
115
+ ...batcher,
116
+ state
117
+ }), [batcher, state]);
118
+ }
119
+
120
+ //#endregion
121
+ exports.useBatcher = useBatcher;
122
+ //# sourceMappingURL=useBatcher.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useBatcher.cjs","names":["useDefaultPacerOptions","Batcher"],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\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 `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<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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * 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 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 * @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 * // Opt-in to re-render when batch size changes (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: BatcherOptions<TValue> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().batcher,\n ...options,\n } as BatcherOptions<TValue>\n\n const [batcher] = useState(() => new Batcher<TValue>(fn, mergedOptions))\n\n batcher.fn = fn\n batcher.setOptions(mergedOptions)\n\n const state = useStore(batcher.store, selector)\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2HA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,4CAA0B,IAAIC,iCAAgB,IAAI,cAAc,CAAC;AAExE,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,8CAAiB,QAAQ,OAAO,SAAS;AAE/C,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}
@@ -0,0 +1,120 @@
1
+ import { Store } from "@tanstack/preact-store";
2
+ import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
3
+
4
+ //#region src/batcher/useBatcher.d.ts
5
+ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
6
+ /**
7
+ * Reactive state that will be updated and re-rendered when the batcher state changes
8
+ *
9
+ * Use this instead of `batcher.store.state`
10
+ */
11
+ readonly state: Readonly<TSelected>;
12
+ /**
13
+ * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
14
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
15
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
16
+ */
17
+ readonly store: Store<Readonly<BatcherState<TValue>>>;
18
+ }
19
+ /**
20
+ * A Preact hook that creates and manages a Batcher instance.
21
+ *
22
+ * This is a lower-level hook that provides direct access to the Batcher's functionality without
23
+ * any built-in state management. This allows you to integrate it with any state management solution
24
+ * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
25
+ *
26
+ * The Batcher collects items and processes them in batches based on configurable conditions:
27
+ * - Maximum batch size
28
+ * - Time-based batching (process after X milliseconds)
29
+ * - Custom batch processing logic via getShouldExecute
30
+ *
31
+ * ## State Management and Selector
32
+ *
33
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
34
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
35
+ * unnecessary re-renders when irrelevant state changes occur.
36
+ *
37
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
38
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
39
+ * full control over when your component updates. Only when you provide a selector will the
40
+ * component re-render when the selected state values change.
41
+ *
42
+ * Available state properties:
43
+ * - `executionCount`: Number of batch executions that have been completed
44
+ * - `isEmpty`: Whether the batcher has no items to process
45
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
46
+ * - `isRunning`: Whether the batcher is active and will process items automatically
47
+ * - `items`: Array of items currently queued for batch processing
48
+ * - `size`: Number of items currently in the batch queue
49
+ * - `status`: Current processing status ('idle' | 'pending')
50
+ * - `totalItemsProcessed`: Total number of items processed across all batches
51
+ *
52
+ * @example
53
+ * ```tsx
54
+ * // Default behavior - no reactive state subscriptions
55
+ * const batcher = useBatcher<number>(
56
+ * (items) => console.log('Processing batch:', items),
57
+ * { maxSize: 5, wait: 2000 }
58
+ * );
59
+ *
60
+ * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
61
+ * const batcher = useBatcher<number>(
62
+ * (items) => console.log('Processing batch:', items),
63
+ * { maxSize: 5, wait: 2000 },
64
+ * (state) => ({
65
+ * size: state.size,
66
+ * isEmpty: state.isEmpty
67
+ * })
68
+ * );
69
+ *
70
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
71
+ * const batcher = useBatcher<number>(
72
+ * (items) => console.log('Processing batch:', items),
73
+ * { maxSize: 5, wait: 2000 },
74
+ * (state) => ({
75
+ * executionCount: state.executionCount,
76
+ * totalItemsProcessed: state.totalItemsProcessed
77
+ * })
78
+ * );
79
+ *
80
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
81
+ * const batcher = useBatcher<number>(
82
+ * (items) => console.log('Processing batch:', items),
83
+ * { maxSize: 5, wait: 2000 },
84
+ * (state) => ({
85
+ * isPending: state.isPending,
86
+ * isRunning: state.isRunning,
87
+ * status: state.status
88
+ * })
89
+ * );
90
+ *
91
+ * // Example with custom state management and batching
92
+ * const [items, setItems] = useState([]);
93
+ *
94
+ * const batcher = useBatcher<number>(
95
+ * (items) => console.log('Processing batch:', items),
96
+ * {
97
+ * maxSize: 5,
98
+ * wait: 2000,
99
+ * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
100
+ * getShouldExecute: (items) => items.length >= 3
101
+ * }
102
+ * );
103
+ *
104
+ * // Add items to batch - they'll be processed when conditions are met
105
+ * batcher.addItem(1);
106
+ * batcher.addItem(2);
107
+ * batcher.addItem(3); // Triggers batch processing
108
+ *
109
+ * // Control the batcher
110
+ * batcher.stop(); // Pause batching
111
+ * batcher.start(); // Resume batching
112
+ *
113
+ * // Access the selected state (will be empty object {} unless selector provided)
114
+ * const { size, isPending } = batcher.state;
115
+ * ```
116
+ */
117
+ declare function useBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): PreactBatcher<TValue, TSelected>;
118
+ //#endregion
119
+ export { PreactBatcher, useBatcher };
120
+ //# sourceMappingURL=useBatcher.d.cts.map
@@ -0,0 +1,120 @@
1
+ import { Store } from "@tanstack/preact-store";
2
+ import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
3
+
4
+ //#region src/batcher/useBatcher.d.ts
5
+ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
6
+ /**
7
+ * Reactive state that will be updated and re-rendered when the batcher state changes
8
+ *
9
+ * Use this instead of `batcher.store.state`
10
+ */
11
+ readonly state: Readonly<TSelected>;
12
+ /**
13
+ * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
14
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
15
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
16
+ */
17
+ readonly store: Store<Readonly<BatcherState<TValue>>>;
18
+ }
19
+ /**
20
+ * A Preact hook that creates and manages a Batcher instance.
21
+ *
22
+ * This is a lower-level hook that provides direct access to the Batcher's functionality without
23
+ * any built-in state management. This allows you to integrate it with any state management solution
24
+ * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
25
+ *
26
+ * The Batcher collects items and processes them in batches based on configurable conditions:
27
+ * - Maximum batch size
28
+ * - Time-based batching (process after X milliseconds)
29
+ * - Custom batch processing logic via getShouldExecute
30
+ *
31
+ * ## State Management and Selector
32
+ *
33
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
34
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
35
+ * unnecessary re-renders when irrelevant state changes occur.
36
+ *
37
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
38
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
39
+ * full control over when your component updates. Only when you provide a selector will the
40
+ * component re-render when the selected state values change.
41
+ *
42
+ * Available state properties:
43
+ * - `executionCount`: Number of batch executions that have been completed
44
+ * - `isEmpty`: Whether the batcher has no items to process
45
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
46
+ * - `isRunning`: Whether the batcher is active and will process items automatically
47
+ * - `items`: Array of items currently queued for batch processing
48
+ * - `size`: Number of items currently in the batch queue
49
+ * - `status`: Current processing status ('idle' | 'pending')
50
+ * - `totalItemsProcessed`: Total number of items processed across all batches
51
+ *
52
+ * @example
53
+ * ```tsx
54
+ * // Default behavior - no reactive state subscriptions
55
+ * const batcher = useBatcher<number>(
56
+ * (items) => console.log('Processing batch:', items),
57
+ * { maxSize: 5, wait: 2000 }
58
+ * );
59
+ *
60
+ * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
61
+ * const batcher = useBatcher<number>(
62
+ * (items) => console.log('Processing batch:', items),
63
+ * { maxSize: 5, wait: 2000 },
64
+ * (state) => ({
65
+ * size: state.size,
66
+ * isEmpty: state.isEmpty
67
+ * })
68
+ * );
69
+ *
70
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
71
+ * const batcher = useBatcher<number>(
72
+ * (items) => console.log('Processing batch:', items),
73
+ * { maxSize: 5, wait: 2000 },
74
+ * (state) => ({
75
+ * executionCount: state.executionCount,
76
+ * totalItemsProcessed: state.totalItemsProcessed
77
+ * })
78
+ * );
79
+ *
80
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
81
+ * const batcher = useBatcher<number>(
82
+ * (items) => console.log('Processing batch:', items),
83
+ * { maxSize: 5, wait: 2000 },
84
+ * (state) => ({
85
+ * isPending: state.isPending,
86
+ * isRunning: state.isRunning,
87
+ * status: state.status
88
+ * })
89
+ * );
90
+ *
91
+ * // Example with custom state management and batching
92
+ * const [items, setItems] = useState([]);
93
+ *
94
+ * const batcher = useBatcher<number>(
95
+ * (items) => console.log('Processing batch:', items),
96
+ * {
97
+ * maxSize: 5,
98
+ * wait: 2000,
99
+ * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
100
+ * getShouldExecute: (items) => items.length >= 3
101
+ * }
102
+ * );
103
+ *
104
+ * // Add items to batch - they'll be processed when conditions are met
105
+ * batcher.addItem(1);
106
+ * batcher.addItem(2);
107
+ * batcher.addItem(3); // Triggers batch processing
108
+ *
109
+ * // Control the batcher
110
+ * batcher.stop(); // Pause batching
111
+ * batcher.start(); // Resume batching
112
+ *
113
+ * // Access the selected state (will be empty object {} unless selector provided)
114
+ * const { size, isPending } = batcher.state;
115
+ * ```
116
+ */
117
+ declare function useBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): PreactBatcher<TValue, TSelected>;
118
+ //#endregion
119
+ export { PreactBatcher, useBatcher };
120
+ //# sourceMappingURL=useBatcher.d.ts.map
@@ -0,0 +1,122 @@
1
+ import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
+ import { useMemo, useState } from "preact/hooks";
3
+ import { useStore } from "@tanstack/preact-store";
4
+ import { Batcher } from "@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. The `selector` parameter allows you
22
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
23
+ * unnecessary re-renders when irrelevant state changes occur.
24
+ *
25
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
26
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
27
+ * full control over when your component updates. Only when you provide a selector will the
28
+ * component re-render when the selected state values change.
29
+ *
30
+ * Available state properties:
31
+ * - `executionCount`: Number of batch executions that have been completed
32
+ * - `isEmpty`: Whether the batcher has no items to process
33
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
34
+ * - `isRunning`: Whether the batcher is active and will process items automatically
35
+ * - `items`: Array of items currently queued for batch processing
36
+ * - `size`: Number of items currently in the batch queue
37
+ * - `status`: Current processing status ('idle' | 'pending')
38
+ * - `totalItemsProcessed`: Total number of items processed across all batches
39
+ *
40
+ * @example
41
+ * ```tsx
42
+ * // Default behavior - no reactive state subscriptions
43
+ * const batcher = useBatcher<number>(
44
+ * (items) => console.log('Processing batch:', items),
45
+ * { maxSize: 5, wait: 2000 }
46
+ * );
47
+ *
48
+ * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
49
+ * const batcher = useBatcher<number>(
50
+ * (items) => console.log('Processing batch:', items),
51
+ * { maxSize: 5, wait: 2000 },
52
+ * (state) => ({
53
+ * size: state.size,
54
+ * isEmpty: state.isEmpty
55
+ * })
56
+ * );
57
+ *
58
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
59
+ * const batcher = useBatcher<number>(
60
+ * (items) => console.log('Processing batch:', items),
61
+ * { maxSize: 5, wait: 2000 },
62
+ * (state) => ({
63
+ * executionCount: state.executionCount,
64
+ * totalItemsProcessed: state.totalItemsProcessed
65
+ * })
66
+ * );
67
+ *
68
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
69
+ * const batcher = useBatcher<number>(
70
+ * (items) => console.log('Processing batch:', items),
71
+ * { maxSize: 5, wait: 2000 },
72
+ * (state) => ({
73
+ * isPending: state.isPending,
74
+ * isRunning: state.isRunning,
75
+ * status: state.status
76
+ * })
77
+ * );
78
+ *
79
+ * // Example with custom state management and batching
80
+ * const [items, setItems] = useState([]);
81
+ *
82
+ * const batcher = useBatcher<number>(
83
+ * (items) => console.log('Processing batch:', items),
84
+ * {
85
+ * maxSize: 5,
86
+ * wait: 2000,
87
+ * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
88
+ * getShouldExecute: (items) => items.length >= 3
89
+ * }
90
+ * );
91
+ *
92
+ * // Add items to batch - they'll be processed when conditions are met
93
+ * batcher.addItem(1);
94
+ * batcher.addItem(2);
95
+ * batcher.addItem(3); // Triggers batch processing
96
+ *
97
+ * // Control the batcher
98
+ * batcher.stop(); // Pause batching
99
+ * batcher.start(); // Resume batching
100
+ *
101
+ * // Access the selected state (will be empty object {} unless selector provided)
102
+ * const { size, isPending } = batcher.state;
103
+ * ```
104
+ */
105
+ function useBatcher(fn, options = {}, selector = () => ({})) {
106
+ const mergedOptions = {
107
+ ...useDefaultPacerOptions().batcher,
108
+ ...options
109
+ };
110
+ const [batcher] = useState(() => new Batcher(fn, mergedOptions));
111
+ batcher.fn = fn;
112
+ batcher.setOptions(mergedOptions);
113
+ const state = useStore(batcher.store, selector);
114
+ return useMemo(() => ({
115
+ ...batcher,
116
+ state
117
+ }), [batcher, state]);
118
+ }
119
+
120
+ //#endregion
121
+ export { useBatcher };
122
+ //# sourceMappingURL=useBatcher.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useBatcher.js","names":[],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\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 `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<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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * 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 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 * @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 * // Opt-in to re-render when batch size changes (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: BatcherOptions<TValue> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().batcher,\n ...options,\n } as BatcherOptions<TValue>\n\n const [batcher] = useState(() => new Batcher<TValue>(fn, mergedOptions))\n\n batcher.fn = fn\n batcher.setOptions(mergedOptions)\n\n const state = useStore(batcher.store, selector)\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2HA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,WAAW,eAAe,IAAI,QAAgB,IAAI,cAAc,CAAC;AAExE,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,QAAQ,SAAS,QAAQ,OAAO,SAAS;AAE/C,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}
@@ -0,0 +1,16 @@
1
+ const require_useDebouncer = require('./useDebouncer.cjs');
2
+ const require_useDebouncedCallback = require('./useDebouncedCallback.cjs');
3
+ const require_useDebouncedState = require('./useDebouncedState.cjs');
4
+ const require_useDebouncedValue = require('./useDebouncedValue.cjs');
5
+
6
+ exports.useDebouncedCallback = require_useDebouncedCallback.useDebouncedCallback;
7
+ exports.useDebouncedState = require_useDebouncedState.useDebouncedState;
8
+ exports.useDebouncedValue = require_useDebouncedValue.useDebouncedValue;
9
+ exports.useDebouncer = require_useDebouncer.useDebouncer;
10
+ var __tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
11
+ Object.keys(__tanstack_pacer_debouncer).forEach(function (k) {
12
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
13
+ enumerable: true,
14
+ get: function () { return __tanstack_pacer_debouncer[k]; }
15
+ });
16
+ });
@@ -0,0 +1,6 @@
1
+ import { useDebouncedCallback } from "./useDebouncedCallback.cjs";
2
+ import { PreactDebouncer, useDebouncer } from "./useDebouncer.cjs";
3
+ import { useDebouncedState } from "./useDebouncedState.cjs";
4
+ import { useDebouncedValue } from "./useDebouncedValue.cjs";
5
+ export * from "@tanstack/pacer/debouncer";
6
+ export { PreactDebouncer, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };
@@ -0,0 +1,6 @@
1
+ import { useDebouncedCallback } from "./useDebouncedCallback.js";
2
+ import { PreactDebouncer, useDebouncer } from "./useDebouncer.js";
3
+ import { useDebouncedState } from "./useDebouncedState.js";
4
+ import { useDebouncedValue } from "./useDebouncedValue.js";
5
+ export * from "@tanstack/pacer/debouncer";
6
+ export { PreactDebouncer, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };
@@ -0,0 +1,8 @@
1
+ import { useDebouncer } from "./useDebouncer.js";
2
+ import { useDebouncedCallback } from "./useDebouncedCallback.js";
3
+ import { useDebouncedState } from "./useDebouncedState.js";
4
+ import { useDebouncedValue } from "./useDebouncedValue.js";
5
+
6
+ export * from "@tanstack/pacer/debouncer"
7
+
8
+ export { useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };
@@ -0,0 +1,48 @@
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