@tanstack/preact-pacer 0.0.1 → 0.19.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 +189 -0
  14. package/dist/async-batcher/useAsyncBatcher.cjs.map +1 -0
  15. package/dist/async-batcher/useAsyncBatcher.d.cts +198 -0
  16. package/dist/async-batcher/useAsyncBatcher.d.ts +198 -0
  17. package/dist/async-batcher/useAsyncBatcher.js +189 -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 +173 -0
  30. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +1 -0
  31. package/dist/async-debouncer/useAsyncDebouncer.d.cts +178 -0
  32. package/dist/async-debouncer/useAsyncDebouncer.d.ts +178 -0
  33. package/dist/async-debouncer/useAsyncDebouncer.js +173 -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 +189 -0
  46. package/dist/async-queuer/useAsyncQueuer.cjs.map +1 -0
  47. package/dist/async-queuer/useAsyncQueuer.d.cts +198 -0
  48. package/dist/async-queuer/useAsyncQueuer.d.ts +198 -0
  49. package/dist/async-queuer/useAsyncQueuer.js +189 -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 +197 -0
  62. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +1 -0
  63. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +207 -0
  64. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +207 -0
  65. package/dist/async-rate-limiter/useAsyncRateLimiter.js +197 -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 +182 -0
  82. package/dist/async-throttler/useAsyncThrottler.cjs.map +1 -0
  83. package/dist/async-throttler/useAsyncThrottler.d.cts +189 -0
  84. package/dist/async-throttler/useAsyncThrottler.d.ts +189 -0
  85. package/dist/async-throttler/useAsyncThrottler.js +182 -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 +146 -0
  98. package/dist/batcher/useBatcher.cjs.map +1 -0
  99. package/dist/batcher/useBatcher.d.cts +155 -0
  100. package/dist/batcher/useBatcher.d.ts +155 -0
  101. package/dist/batcher/useBatcher.js +146 -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 +128 -0
  126. package/dist/debouncer/useDebouncer.cjs.map +1 -0
  127. package/dist/debouncer/useDebouncer.d.cts +133 -0
  128. package/dist/debouncer/useDebouncer.d.ts +133 -0
  129. package/dist/debouncer/useDebouncer.js +128 -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 +157 -0
  162. package/dist/queuer/useQueuer.cjs.map +1 -0
  163. package/dist/queuer/useQueuer.d.cts +166 -0
  164. package/dist/queuer/useQueuer.d.ts +166 -0
  165. package/dist/queuer/useQueuer.js +157 -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 +162 -0
  190. package/dist/rate-limiter/useRateLimiter.cjs.map +1 -0
  191. package/dist/rate-limiter/useRateLimiter.d.cts +172 -0
  192. package/dist/rate-limiter/useRateLimiter.d.ts +172 -0
  193. package/dist/rate-limiter/useRateLimiter.js +162 -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 +133 -0
  218. package/dist/throttler/useThrottler.cjs.map +1 -0
  219. package/dist/throttler/useThrottler.d.cts +138 -0
  220. package/dist/throttler/useThrottler.d.ts +138 -0
  221. package/dist/throttler/useThrottler.js +133 -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 +249 -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 +235 -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 +249 -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 +261 -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 +244 -0
  248. package/src/batcher/index.ts +4 -0
  249. package/src/batcher/useBatchedCallback.ts +50 -0
  250. package/src/batcher/useBatcher.ts +203 -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 +189 -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 +213 -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 +222 -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 +194 -0
  273. package/src/types/index.ts +1 -0
  274. package/src/utils/index.ts +1 -0
@@ -0,0 +1,189 @@
1
+ import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
+ import { useMemo, useState } from "preact/hooks";
3
+ import { AsyncBatcher } from "@tanstack/pacer/async-batcher";
4
+ import { useStore } from "@tanstack/preact-store";
5
+
6
+ //#region src/async-batcher/useAsyncBatcher.ts
7
+ /**
8
+ * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
9
+ *
10
+ * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
11
+ * - Handles promises and returns results from batch executions
12
+ * - Provides error handling with configurable error behavior
13
+ * - Tracks success, error, and settle counts separately
14
+ * - Has state tracking for when batches are executing
15
+ * - Returns the result of the batch function execution
16
+ *
17
+ * Features:
18
+ * - Configurable batch size and wait time
19
+ * - Custom batch processing logic via getShouldExecute
20
+ * - Event callbacks for monitoring batch operations
21
+ * - Error handling for failed batch operations
22
+ * - Automatic or manual batch processing
23
+ *
24
+ * The batcher collects items and processes them in batches based on:
25
+ * - Maximum batch size (number of items per batch)
26
+ * - Time-based batching (process after X milliseconds)
27
+ * - Custom batch processing logic via getShouldExecute
28
+ *
29
+ * Error Handling:
30
+ * - If an `onError` handler is provided, it will be called with the error and batcher instance
31
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
32
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
33
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
34
+ * - The error state can be checked using the underlying AsyncBatcher instance
35
+ *
36
+ * ## State Management and Selector
37
+ *
38
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
39
+ * in two ways:
40
+ *
41
+ * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
42
+ *
43
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
44
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
45
+ * in child components.
46
+ *
47
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
48
+ *
49
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
50
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
51
+ * state changes occur.
52
+ *
53
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
54
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
55
+ * re-renders and gives you full control over when your component updates.
56
+ *
57
+ * Available state properties:
58
+ * - `errorCount`: Number of batch executions that have resulted in errors
59
+ * - `failedItems`: Array of items that failed during batch processing
60
+ * - `isEmpty`: Whether the batcher has no items to process
61
+ * - `isExecuting`: Whether a batch is currently being processed asynchronously
62
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
63
+ * - `isRunning`: Whether the batcher is active and will process items automatically
64
+ * - `items`: Array of items currently queued for batch processing
65
+ * - `lastResult`: The result from the most recent batch execution
66
+ * - `settleCount`: Number of batch executions that have completed (success or error)
67
+ * - `size`: Number of items currently in the batch queue
68
+ * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
69
+ * - `successCount`: Number of batch executions that have completed successfully
70
+ * - `totalItemsProcessed`: Total number of items processed across all batches
71
+ * - `totalItemsFailed`: Total number of items that have failed processing
72
+ *
73
+ * @example
74
+ * ```tsx
75
+ * // Basic async batcher for API requests - no reactive state subscriptions
76
+ * const asyncBatcher = useAsyncBatcher(
77
+ * async (items) => {
78
+ * const results = await Promise.all(items.map(item => processItem(item)));
79
+ * return results;
80
+ * },
81
+ * { maxSize: 10, wait: 2000 }
82
+ * );
83
+ *
84
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
85
+ * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
86
+ * {({ size }) => (
87
+ * <div>Batch Size: {size}</div>
88
+ * )}
89
+ * </asyncBatcher.Subscribe>
90
+ *
91
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
92
+ * const asyncBatcher = useAsyncBatcher(
93
+ * async (items) => {
94
+ * const results = await Promise.all(items.map(item => processItem(item)));
95
+ * return results;
96
+ * },
97
+ * { maxSize: 10, wait: 2000 },
98
+ * (state) => ({
99
+ * isExecuting: state.isExecuting,
100
+ * isPending: state.isPending,
101
+ * status: state.status
102
+ * })
103
+ * );
104
+ *
105
+ * // Opt-in to re-render when results are available (optimized for data display)
106
+ * const asyncBatcher = useAsyncBatcher(
107
+ * async (items) => {
108
+ * const results = await Promise.all(items.map(item => processItem(item)));
109
+ * return results;
110
+ * },
111
+ * { maxSize: 10, wait: 2000 },
112
+ * (state) => ({
113
+ * lastResult: state.lastResult,
114
+ * successCount: state.successCount,
115
+ * totalItemsProcessed: state.totalItemsProcessed
116
+ * })
117
+ * );
118
+ *
119
+ * // Opt-in to re-render when error state changes (optimized for error handling)
120
+ * const asyncBatcher = useAsyncBatcher(
121
+ * async (items) => {
122
+ * const results = await Promise.all(items.map(item => processItem(item)));
123
+ * return results;
124
+ * },
125
+ * {
126
+ * maxSize: 10,
127
+ * wait: 2000,
128
+ * onError: (error) => console.error('Batch processing failed:', error)
129
+ * },
130
+ * (state) => ({
131
+ * errorCount: state.errorCount,
132
+ * failedItems: state.failedItems,
133
+ * totalItemsFailed: state.totalItemsFailed
134
+ * })
135
+ * );
136
+ *
137
+ * // Complete example with all callbacks
138
+ * const asyncBatcher = useAsyncBatcher(
139
+ * async (items) => {
140
+ * const results = await Promise.all(items.map(item => processItem(item)));
141
+ * return results;
142
+ * },
143
+ * {
144
+ * maxSize: 10,
145
+ * wait: 2000,
146
+ * onSuccess: (result) => {
147
+ * console.log('Batch processed successfully:', result);
148
+ * },
149
+ * onError: (error) => {
150
+ * console.error('Batch processing failed:', error);
151
+ * }
152
+ * }
153
+ * );
154
+ *
155
+ * // Add items to batch
156
+ * asyncBatcher.addItem(newItem);
157
+ *
158
+ * // Manually execute batch
159
+ * const result = await asyncBatcher.execute();
160
+ *
161
+ * // Access the selected state (will be empty object {} unless selector provided)
162
+ * const { isExecuting, lastResult, size } = asyncBatcher.state;
163
+ * ```
164
+ */
165
+ function useAsyncBatcher(fn, options = {}, selector = () => ({})) {
166
+ const mergedOptions = {
167
+ ...useDefaultPacerOptions().asyncBatcher,
168
+ ...options
169
+ };
170
+ const [asyncBatcher] = useState(() => {
171
+ const batcherInstance = new AsyncBatcher(fn, mergedOptions);
172
+ batcherInstance.Subscribe = function Subscribe(props) {
173
+ const selected = useStore(batcherInstance.store, props.selector);
174
+ return typeof props.children === "function" ? props.children(selected) : props.children;
175
+ };
176
+ return batcherInstance;
177
+ });
178
+ asyncBatcher.fn = fn;
179
+ asyncBatcher.setOptions(mergedOptions);
180
+ const state = useStore(asyncBatcher.store, selector);
181
+ return useMemo(() => ({
182
+ ...asyncBatcher,
183
+ state
184
+ }), [asyncBatcher, state]);
185
+ }
186
+
187
+ //#endregion
188
+ export { useAsyncBatcher };
189
+ //# sourceMappingURL=useAsyncBatcher.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAsyncBatcher.js","names":[],"sources":["../../src/async-batcher/useAsyncBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncBatcher } from '@tanstack/pacer/async-batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n AsyncBatcherOptions,\n AsyncBatcherState,\n} from '@tanstack/pacer/async-batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<\n AsyncBatcher<TValue>,\n 'store'\n> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async 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: AsyncBatcherState<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 `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<AsyncBatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.\n *\n * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:\n * - Handles promises and returns results from batch executions\n * - Provides error handling with configurable error behavior\n * - Tracks success, error, and settle counts separately\n * - Has state tracking for when batches are executing\n * - Returns the result of the batch function execution\n *\n * Features:\n * - Configurable batch size and wait time\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n * - Error handling for failed batch operations\n * - Automatic or manual batch processing\n *\n * The batcher collects items and processes them in batches based on:\n * - Maximum batch size (number of items per batch)\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and batcher 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 AsyncBatcher 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 `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 * - `errorCount`: Number of batch executions that have resulted in errors\n * - `failedItems`: Array of items that failed during batch processing\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isExecuting`: Whether a batch is currently being processed asynchronously\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 * - `lastResult`: The result from the most recent batch execution\n * - `settleCount`: Number of batch executions that have completed (success or error)\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')\n * - `successCount`: Number of batch executions that have completed successfully\n * - `totalItemsProcessed`: Total number of items processed across all batches\n * - `totalItemsFailed`: Total number of items that have failed processing\n *\n * @example\n * ```tsx\n * // Basic async batcher for API requests - no reactive state subscriptions\n * const asyncBatcher = useAsyncBatcher(\n * async (items) => {\n * const results = await Promise.all(items.map(item => processItem(item)));\n * return results;\n * },\n * { maxSize: 10, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>\n * {({ size }) => (\n * <div>Batch Size: {size}</div>\n * )}\n * </asyncBatcher.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncBatcher = useAsyncBatcher(\n * async (items) => {\n * const results = await Promise.all(items.map(item => processItem(item)));\n * return results;\n * },\n * { maxSize: 10, wait: 2000 },\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 asyncBatcher = useAsyncBatcher(\n * async (items) => {\n * const results = await Promise.all(items.map(item => processItem(item)));\n * return results;\n * },\n * { maxSize: 10, wait: 2000 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount,\n * totalItemsProcessed: state.totalItemsProcessed\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncBatcher = useAsyncBatcher(\n * async (items) => {\n * const results = await Promise.all(items.map(item => processItem(item)));\n * return results;\n * },\n * {\n * maxSize: 10,\n * wait: 2000,\n * onError: (error) => console.error('Batch processing failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * failedItems: state.failedItems,\n * totalItemsFailed: state.totalItemsFailed\n * })\n * );\n *\n * // Complete example with all callbacks\n * const asyncBatcher = useAsyncBatcher(\n * async (items) => {\n * const results = await Promise.all(items.map(item => processItem(item)));\n * return results;\n * },\n * {\n * maxSize: 10,\n * wait: 2000,\n * onSuccess: (result) => {\n * console.log('Batch processed successfully:', result);\n * },\n * onError: (error) => {\n * console.error('Batch processing failed:', error);\n * }\n * }\n * );\n *\n * // Add items to batch\n * asyncBatcher.addItem(newItem);\n *\n * // Manually execute batch\n * const result = await asyncBatcher.execute();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, size } = asyncBatcher.state;\n * ```\n */\nexport function useAsyncBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => Promise<any>,\n options: AsyncBatcherOptions<TValue> = {},\n selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncBatcher,\n ...options,\n } as AsyncBatcherOptions<TValue>\n\n const [asyncBatcher] = useState(() => {\n const batcherInstance = new AsyncBatcher<TValue>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncBatcher<TValue, TSelected>\n\n batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncBatcherState<TValue>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(batcherInstance.store, props.selector)\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return batcherInstance\n })\n\n asyncBatcher.fn = fn\n asyncBatcher.setOptions(mergedOptions)\n\n const state = useStore(asyncBatcher.store, selector)\n\n return useMemo(\n () =>\n ({\n ...asyncBatcher,\n state,\n }) as PreactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n [asyncBatcher, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4MA,SAAgB,gBACd,IACA,UAAuC,EAAE,EACzC,kBACG,EAAE,GACkC;CACvC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,gBAAgB,eAAe;EACpC,MAAM,kBAAkB,IAAI,aAC1B,IACA,cACD;AAED,kBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,WAAW,SAAS,gBAAgB,OAAO,MAAM,SAAS;AAEhE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,cAAa,KAAK;AAClB,cAAa,WAAW,cAAc;CAEtC,MAAM,QAAQ,SAAS,aAAa,OAAO,SAAS;AAEpD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,cAAc,MAAM,CACtB"}
@@ -0,0 +1,12 @@
1
+ const require_useAsyncDebouncer = require('./useAsyncDebouncer.cjs');
2
+ const require_useAsyncDebouncedCallback = require('./useAsyncDebouncedCallback.cjs');
3
+
4
+ exports.useAsyncDebouncedCallback = require_useAsyncDebouncedCallback.useAsyncDebouncedCallback;
5
+ exports.useAsyncDebouncer = require_useAsyncDebouncer.useAsyncDebouncer;
6
+ var _tanstack_pacer_async_debouncer = require("@tanstack/pacer/async-debouncer");
7
+ Object.keys(_tanstack_pacer_async_debouncer).forEach(function (k) {
8
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
+ enumerable: true,
10
+ get: function () { return _tanstack_pacer_async_debouncer[k]; }
11
+ });
12
+ });
@@ -0,0 +1,4 @@
1
+ import { PreactAsyncDebouncer, useAsyncDebouncer } from "./useAsyncDebouncer.cjs";
2
+ import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.cjs";
3
+ export * from "@tanstack/pacer/async-debouncer";
4
+ export { PreactAsyncDebouncer, useAsyncDebouncedCallback, useAsyncDebouncer };
@@ -0,0 +1,4 @@
1
+ import { PreactAsyncDebouncer, useAsyncDebouncer } from "./useAsyncDebouncer.js";
2
+ import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.js";
3
+ export * from "@tanstack/pacer/async-debouncer";
4
+ export { PreactAsyncDebouncer, useAsyncDebouncedCallback, useAsyncDebouncer };
@@ -0,0 +1,6 @@
1
+ import { useAsyncDebouncer } from "./useAsyncDebouncer.js";
2
+ import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.js";
3
+
4
+ export * from "@tanstack/pacer/async-debouncer"
5
+
6
+ export { useAsyncDebouncedCallback, useAsyncDebouncer };
@@ -0,0 +1,50 @@
1
+ const require_useAsyncDebouncer = require('./useAsyncDebouncer.cjs');
2
+ let preact_hooks = require("preact/hooks");
3
+
4
+ //#region src/async-debouncer/useAsyncDebouncedCallback.ts
5
+ /**
6
+ * A Preact hook that creates a debounced version of an async callback function.
7
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
8
+ * providing a stable, debounced async function reference for use in Preact components.
9
+ *
10
+ * The debounced async function will only execute after the specified wait time has elapsed
11
+ * since its last invocation. If called again before the wait time expires, the timer
12
+ * resets and starts waiting again. The returned function always returns a promise
13
+ * that resolves or rejects with the result of the original async function.
14
+ *
15
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
16
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
17
+ *
18
+ * For advanced usage requiring features like:
19
+ * - Manual cancellation
20
+ * - Access to execution/error state
21
+ * - Custom useCallback dependencies
22
+ *
23
+ * Consider using the `useAsyncDebouncer` hook instead.
24
+ *
25
+ *
26
+ * @example
27
+ * ```tsx
28
+ * // Debounce an async search handler
29
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
30
+ * const results = await fetchSearchResults(query);
31
+ * return results;
32
+ * }, {
33
+ * wait: 500 // Wait 500ms between executions
34
+ * });
35
+ *
36
+ * // Use in an input
37
+ * <input
38
+ * type="search"
39
+ * onChange={e => handleSearch(e.target.value)}
40
+ * />
41
+ * ```
42
+ */
43
+ function useAsyncDebouncedCallback(fn, options) {
44
+ const asyncDebouncedFn = require_useAsyncDebouncer.useAsyncDebouncer(fn, options).maybeExecute;
45
+ return (0, preact_hooks.useCallback)((...args) => asyncDebouncedFn(...args), [asyncDebouncedFn]);
46
+ }
47
+
48
+ //#endregion
49
+ exports.useAsyncDebouncedCallback = useAsyncDebouncedCallback;
50
+ //# sourceMappingURL=useAsyncDebouncedCallback.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAsyncDebouncedCallback.cjs","names":["useAsyncDebouncer"],"sources":["../../src/async-debouncer/useAsyncDebouncedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncDebouncer } from './useAsyncDebouncer'\nimport type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a debounced version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,\n * providing a stable, debounced async function reference for use in Preact components.\n *\n * The debounced async 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. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic\n * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncDebouncer` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Debounce an async search handler\n * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {\n * const results = await fetchSearchResults(query);\n * return results;\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 useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) =>\n asyncDebouncedFn(...args) as Promise<ReturnType<TFn>>,\n [asyncDebouncedFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmBA,4CAAkB,IAAI,QAAQ,CAAC;AACxD,uCACG,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}
@@ -0,0 +1,47 @@
1
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
2
+ import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
3
+
4
+ //#region src/async-debouncer/useAsyncDebouncedCallback.d.ts
5
+
6
+ /**
7
+ * A Preact hook that creates a debounced version of an async callback function.
8
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
9
+ * providing a stable, debounced async function reference for use in Preact components.
10
+ *
11
+ * The debounced async 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. The returned function always returns a promise
14
+ * that resolves or rejects with the result of the original async function.
15
+ *
16
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
17
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
18
+ *
19
+ * For advanced usage requiring features like:
20
+ * - Manual cancellation
21
+ * - Access to execution/error state
22
+ * - Custom useCallback dependencies
23
+ *
24
+ * Consider using the `useAsyncDebouncer` hook instead.
25
+ *
26
+ *
27
+ * @example
28
+ * ```tsx
29
+ * // Debounce an async search handler
30
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
31
+ * const results = await fetchSearchResults(query);
32
+ * return results;
33
+ * }, {
34
+ * wait: 500 // Wait 500ms between executions
35
+ * });
36
+ *
37
+ * // Use in an input
38
+ * <input
39
+ * type="search"
40
+ * onChange={e => handleSearch(e.target.value)}
41
+ * />
42
+ * ```
43
+ */
44
+ declare function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
45
+ //#endregion
46
+ export { useAsyncDebouncedCallback };
47
+ //# sourceMappingURL=useAsyncDebouncedCallback.d.cts.map
@@ -0,0 +1,47 @@
1
+ import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
2
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
3
+
4
+ //#region src/async-debouncer/useAsyncDebouncedCallback.d.ts
5
+
6
+ /**
7
+ * A Preact hook that creates a debounced version of an async callback function.
8
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
9
+ * providing a stable, debounced async function reference for use in Preact components.
10
+ *
11
+ * The debounced async 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. The returned function always returns a promise
14
+ * that resolves or rejects with the result of the original async function.
15
+ *
16
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
17
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
18
+ *
19
+ * For advanced usage requiring features like:
20
+ * - Manual cancellation
21
+ * - Access to execution/error state
22
+ * - Custom useCallback dependencies
23
+ *
24
+ * Consider using the `useAsyncDebouncer` hook instead.
25
+ *
26
+ *
27
+ * @example
28
+ * ```tsx
29
+ * // Debounce an async search handler
30
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
31
+ * const results = await fetchSearchResults(query);
32
+ * return results;
33
+ * }, {
34
+ * wait: 500 // Wait 500ms between executions
35
+ * });
36
+ *
37
+ * // Use in an input
38
+ * <input
39
+ * type="search"
40
+ * onChange={e => handleSearch(e.target.value)}
41
+ * />
42
+ * ```
43
+ */
44
+ declare function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
45
+ //#endregion
46
+ export { useAsyncDebouncedCallback };
47
+ //# sourceMappingURL=useAsyncDebouncedCallback.d.ts.map
@@ -0,0 +1,50 @@
1
+ import { useAsyncDebouncer } from "./useAsyncDebouncer.js";
2
+ import { useCallback } from "preact/hooks";
3
+
4
+ //#region src/async-debouncer/useAsyncDebouncedCallback.ts
5
+ /**
6
+ * A Preact hook that creates a debounced version of an async callback function.
7
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
8
+ * providing a stable, debounced async function reference for use in Preact components.
9
+ *
10
+ * The debounced async function will only execute after the specified wait time has elapsed
11
+ * since its last invocation. If called again before the wait time expires, the timer
12
+ * resets and starts waiting again. The returned function always returns a promise
13
+ * that resolves or rejects with the result of the original async function.
14
+ *
15
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
16
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
17
+ *
18
+ * For advanced usage requiring features like:
19
+ * - Manual cancellation
20
+ * - Access to execution/error state
21
+ * - Custom useCallback dependencies
22
+ *
23
+ * Consider using the `useAsyncDebouncer` hook instead.
24
+ *
25
+ *
26
+ * @example
27
+ * ```tsx
28
+ * // Debounce an async search handler
29
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
30
+ * const results = await fetchSearchResults(query);
31
+ * return results;
32
+ * }, {
33
+ * wait: 500 // Wait 500ms between executions
34
+ * });
35
+ *
36
+ * // Use in an input
37
+ * <input
38
+ * type="search"
39
+ * onChange={e => handleSearch(e.target.value)}
40
+ * />
41
+ * ```
42
+ */
43
+ function useAsyncDebouncedCallback(fn, options) {
44
+ const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute;
45
+ return useCallback((...args) => asyncDebouncedFn(...args), [asyncDebouncedFn]);
46
+ }
47
+
48
+ //#endregion
49
+ export { useAsyncDebouncedCallback };
50
+ //# sourceMappingURL=useAsyncDebouncedCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAsyncDebouncedCallback.js","names":[],"sources":["../../src/async-debouncer/useAsyncDebouncedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncDebouncer } from './useAsyncDebouncer'\nimport type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a debounced version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,\n * providing a stable, debounced async function reference for use in Preact components.\n *\n * The debounced async 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. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic\n * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncDebouncer` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Debounce an async search handler\n * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {\n * const results = await fetchSearchResults(query);\n * return results;\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 useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) =>\n asyncDebouncedFn(...args) as Promise<ReturnType<TFn>>,\n [asyncDebouncedFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmB,kBAAkB,IAAI,QAAQ,CAAC;AACxD,QAAO,aACJ,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}
@@ -0,0 +1,173 @@
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_async_debouncer = require("@tanstack/pacer/async-debouncer");
5
+
6
+ //#region src/async-debouncer/useAsyncDebouncer.ts
7
+ /**
8
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
9
+ *
10
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
11
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
12
+ *
13
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
14
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
15
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
16
+ *
17
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
18
+ * the function stops being called for the specified delay period.
19
+ *
20
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
21
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
22
+ * instead of setting the result on a state variable from within the debounced function.
23
+ *
24
+ * Error Handling:
25
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
26
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
27
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
28
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
29
+ * - The error state can be checked using the underlying AsyncDebouncer instance
30
+ *
31
+ * ## State Management and Selector
32
+ *
33
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
34
+ * in two ways:
35
+ *
36
+ * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
37
+ *
38
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
39
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
40
+ * in child components.
41
+ *
42
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
43
+ *
44
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
45
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
46
+ * state changes occur.
47
+ *
48
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
49
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
50
+ * re-renders and gives you full control over when your component updates.
51
+ *
52
+ * Available state properties:
53
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
54
+ * - `errorCount`: Number of function executions that have resulted in errors
55
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
56
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
57
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
58
+ * - `lastResult`: The result from the most recent successful function execution
59
+ * - `settleCount`: Number of function executions that have completed (success or error)
60
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
61
+ * - `successCount`: Number of function executions that have completed successfully
62
+ *
63
+ * @example
64
+ * ```tsx
65
+ * // Default behavior - no reactive state subscriptions
66
+ * const searchDebouncer = useAsyncDebouncer(
67
+ * async (query: string) => {
68
+ * const results = await api.search(query);
69
+ * return results;
70
+ * },
71
+ * { wait: 500 }
72
+ * );
73
+ *
74
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
75
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
76
+ * {({ isPending }) => (
77
+ * <div>{isPending ? 'Searching...' : 'Ready'}</div>
78
+ * )}
79
+ * </searchDebouncer.Subscribe>
80
+ *
81
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
82
+ * const searchDebouncer = useAsyncDebouncer(
83
+ * async (query: string) => {
84
+ * const results = await api.search(query);
85
+ * return results;
86
+ * },
87
+ * { wait: 500 },
88
+ * (state) => ({
89
+ * isExecuting: state.isExecuting,
90
+ * isPending: state.isPending
91
+ * })
92
+ * );
93
+ *
94
+ * // Opt-in to re-render when results are available (optimized for data display)
95
+ * const searchDebouncer = useAsyncDebouncer(
96
+ * async (query: string) => {
97
+ * const results = await api.search(query);
98
+ * return results;
99
+ * },
100
+ * { wait: 500 },
101
+ * (state) => ({
102
+ * lastResult: state.lastResult,
103
+ * successCount: state.successCount
104
+ * })
105
+ * );
106
+ *
107
+ * // Opt-in to re-render when error state changes (optimized for error handling)
108
+ * const searchDebouncer = useAsyncDebouncer(
109
+ * async (query: string) => {
110
+ * const results = await api.search(query);
111
+ * return results;
112
+ * },
113
+ * {
114
+ * wait: 500,
115
+ * onError: (error) => console.error('Search failed:', error)
116
+ * },
117
+ * (state) => ({
118
+ * errorCount: state.errorCount,
119
+ * status: state.status
120
+ * })
121
+ * );
122
+ *
123
+ * // With state management
124
+ * const [results, setResults] = useState([]);
125
+ * const { maybeExecute, state } = useAsyncDebouncer(
126
+ * async (searchTerm) => {
127
+ * const data = await searchAPI(searchTerm);
128
+ * setResults(data);
129
+ * },
130
+ * {
131
+ * wait: 300,
132
+ * leading: true, // Execute immediately on first call
133
+ * trailing: false, // Skip trailing edge updates
134
+ * onError: (error) => {
135
+ * console.error('API call failed:', error);
136
+ * }
137
+ * }
138
+ * );
139
+ *
140
+ * // Access the selected state (will be empty object {} unless selector provided)
141
+ * const { isExecuting, lastResult } = state;
142
+ * ```
143
+ */
144
+ function useAsyncDebouncer(fn, options, selector = () => ({})) {
145
+ const mergedOptions = {
146
+ ...require_PacerProvider.useDefaultPacerOptions().asyncDebouncer,
147
+ ...options
148
+ };
149
+ const [asyncDebouncer] = (0, preact_hooks.useState)(() => {
150
+ const debouncerInstance = new _tanstack_pacer_async_debouncer.AsyncDebouncer(fn, mergedOptions);
151
+ debouncerInstance.Subscribe = function Subscribe(props) {
152
+ const selected = (0, _tanstack_preact_store.useStore)(debouncerInstance.store, props.selector);
153
+ return typeof props.children === "function" ? props.children(selected) : props.children;
154
+ };
155
+ return debouncerInstance;
156
+ });
157
+ asyncDebouncer.fn = fn;
158
+ asyncDebouncer.setOptions(mergedOptions);
159
+ const state = (0, _tanstack_preact_store.useStore)(asyncDebouncer.store, selector);
160
+ (0, preact_hooks.useEffect)(() => {
161
+ return () => {
162
+ asyncDebouncer.cancel();
163
+ };
164
+ }, [asyncDebouncer]);
165
+ return (0, preact_hooks.useMemo)(() => ({
166
+ ...asyncDebouncer,
167
+ state
168
+ }), [asyncDebouncer, state]);
169
+ }
170
+
171
+ //#endregion
172
+ exports.useAsyncDebouncer = useAsyncDebouncer;
173
+ //# sourceMappingURL=useAsyncDebouncer.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAsyncDebouncer.cjs","names":["useDefaultPacerOptions","AsyncDebouncer"],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` in your own usage.\n */\n readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncDebouncer instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\n * onError: (error) => {\n * console.error('API call failed:', error);\n * }\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as AsyncDebouncerOptions<TFn>\n\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector)\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector)\n\n useEffect(() => {\n return () => {\n asyncDebouncer.cancel()\n }\n }, [asyncDebouncer])\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwLA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,mDAAiC;EACtC,MAAM,oBAAoB,IAAIC,+CAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,gDAAoB,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,6CAAiB,eAAe,OAAO,SAAS;AAEtD,mCAAgB;AACd,eAAa;AACX,kBAAe,QAAQ;;IAExB,CAAC,eAAe,CAAC;AAEpB,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}