@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,54 @@
1
+ import { useCallback } from 'preact/hooks'
2
+ import { useAsyncBatcher } from './useAsyncBatcher'
3
+ import type { AsyncBatcherOptions } from '@tanstack/pacer/async-batcher'
4
+ import type { AnyAsyncFunction } from '@tanstack/pacer/types'
5
+
6
+ /**
7
+ * A Preact hook that creates a batched version of an async callback function.
8
+ * This hook is a convenient wrapper around the `useAsyncBatcher` hook,
9
+ * providing a stable, batched async function reference for use in Preact components.
10
+ *
11
+ * The batched async 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
+ * The returned function always returns a promise that resolves with undefined (since the
14
+ * batch function processes multiple items together).
15
+ *
16
+ * This hook provides a simpler API compared to `useAsyncBatcher`, making it ideal for basic
17
+ * async batching needs. However, it does not expose the underlying AsyncBatcher instance.
18
+ *
19
+ * For advanced usage requiring features like:
20
+ * - Manual batch execution
21
+ * - Access to batch results and state
22
+ * - Custom useCallback dependencies
23
+ *
24
+ * Consider using the `useAsyncBatcher` hook instead.
25
+ *
26
+ * @example
27
+ * ```tsx
28
+ * // Batch API requests
29
+ * const batchApiCall = useAsyncBatchedCallback(async (requests: ApiRequest[]) => {
30
+ * const results = await Promise.all(requests.map(req => fetch(req.url)));
31
+ * return results.map(res => res.json());
32
+ * }, {
33
+ * maxSize: 10, // Process when 10 requests collected
34
+ * wait: 1000 // Or after 1 second
35
+ * });
36
+ *
37
+ * // Use in event handlers
38
+ * <button onClick={() => batchApiCall({ url: '/api/analytics', data: eventData })}>
39
+ * Track Event
40
+ * </button>
41
+ * ```
42
+ */
43
+ export function useAsyncBatchedCallback<TFn extends AnyAsyncFunction>(
44
+ fn: (items: Array<Parameters<TFn>[0]>) => Promise<any>,
45
+ options: AsyncBatcherOptions<Parameters<TFn>[0]>,
46
+ ): (...args: Parameters<TFn>) => Promise<void> {
47
+ const asyncBatchedFn = useAsyncBatcher(fn, options).addItem
48
+ return useCallback(
49
+ async (...args: Parameters<TFn>) => {
50
+ asyncBatchedFn(args[0])
51
+ },
52
+ [asyncBatchedFn],
53
+ )
54
+ }
@@ -0,0 +1,198 @@
1
+ import { useMemo, useState } from 'preact/hooks'
2
+ import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
3
+ import { useStore } from '@tanstack/preact-store'
4
+ import { useDefaultPacerOptions } from '../provider/PacerProvider'
5
+ import type { Store } from '@tanstack/preact-store'
6
+ import type {
7
+ AsyncBatcherOptions,
8
+ AsyncBatcherState,
9
+ } from '@tanstack/pacer/async-batcher'
10
+
11
+ export interface ReactAsyncBatcher<TValue, TSelected = {}> extends Omit<
12
+ AsyncBatcher<TValue>,
13
+ 'store'
14
+ > {
15
+ /**
16
+ * Reactive state that will be updated and re-rendered when the batcher state changes
17
+ *
18
+ * Use this instead of `batcher.store.state`
19
+ */
20
+ readonly state: Readonly<TSelected>
21
+ /**
22
+ * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
23
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
24
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
25
+ */
26
+ readonly store: Store<Readonly<AsyncBatcherState<TValue>>>
27
+ }
28
+
29
+ /**
30
+ * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
31
+ *
32
+ * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
33
+ * - Handles promises and returns results from batch executions
34
+ * - Provides error handling with configurable error behavior
35
+ * - Tracks success, error, and settle counts separately
36
+ * - Has state tracking for when batches are executing
37
+ * - Returns the result of the batch function execution
38
+ *
39
+ * Features:
40
+ * - Configurable batch size and wait time
41
+ * - Custom batch processing logic via getShouldExecute
42
+ * - Event callbacks for monitoring batch operations
43
+ * - Error handling for failed batch operations
44
+ * - Automatic or manual batch processing
45
+ *
46
+ * The batcher collects items and processes them in batches based on:
47
+ * - Maximum batch size (number of items per batch)
48
+ * - Time-based batching (process after X milliseconds)
49
+ * - Custom batch processing logic via getShouldExecute
50
+ *
51
+ * Error Handling:
52
+ * - If an `onError` handler is provided, it will be called with the error and batcher instance
53
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
54
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
55
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
56
+ * - The error state can be checked using the underlying AsyncBatcher instance
57
+ *
58
+ * ## State Management and Selector
59
+ *
60
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
61
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
62
+ * unnecessary re-renders when irrelevant state changes occur.
63
+ *
64
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
65
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
66
+ * full control over when your component updates. Only when you provide a selector will the
67
+ * component re-render when the selected state values change.
68
+ *
69
+ * Available state properties:
70
+ * - `errorCount`: Number of batch executions that have resulted in errors
71
+ * - `failedItems`: Array of items that failed during batch processing
72
+ * - `isEmpty`: Whether the batcher has no items to process
73
+ * - `isExecuting`: Whether a batch is currently being processed asynchronously
74
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
75
+ * - `isRunning`: Whether the batcher is active and will process items automatically
76
+ * - `items`: Array of items currently queued for batch processing
77
+ * - `lastResult`: The result from the most recent batch execution
78
+ * - `settleCount`: Number of batch executions that have completed (success or error)
79
+ * - `size`: Number of items currently in the batch queue
80
+ * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
81
+ * - `successCount`: Number of batch executions that have completed successfully
82
+ * - `totalItemsProcessed`: Total number of items processed across all batches
83
+ * - `totalItemsFailed`: Total number of items that have failed processing
84
+ *
85
+ * @example
86
+ * ```tsx
87
+ * // Basic async batcher for API requests - no reactive state subscriptions
88
+ * const asyncBatcher = useAsyncBatcher(
89
+ * async (items) => {
90
+ * const results = await Promise.all(items.map(item => processItem(item)));
91
+ * return results;
92
+ * },
93
+ * { maxSize: 10, wait: 2000 }
94
+ * );
95
+ *
96
+ * // Opt-in to re-render when execution state changes (optimized for loading indicators)
97
+ * const asyncBatcher = useAsyncBatcher(
98
+ * async (items) => {
99
+ * const results = await Promise.all(items.map(item => processItem(item)));
100
+ * return results;
101
+ * },
102
+ * { maxSize: 10, wait: 2000 },
103
+ * (state) => ({
104
+ * isExecuting: state.isExecuting,
105
+ * isPending: state.isPending,
106
+ * status: state.status
107
+ * })
108
+ * );
109
+ *
110
+ * // Opt-in to re-render when results are available (optimized for data display)
111
+ * const asyncBatcher = useAsyncBatcher(
112
+ * async (items) => {
113
+ * const results = await Promise.all(items.map(item => processItem(item)));
114
+ * return results;
115
+ * },
116
+ * { maxSize: 10, wait: 2000 },
117
+ * (state) => ({
118
+ * lastResult: state.lastResult,
119
+ * successCount: state.successCount,
120
+ * totalItemsProcessed: state.totalItemsProcessed
121
+ * })
122
+ * );
123
+ *
124
+ * // Opt-in to re-render when error state changes (optimized for error handling)
125
+ * const asyncBatcher = useAsyncBatcher(
126
+ * async (items) => {
127
+ * const results = await Promise.all(items.map(item => processItem(item)));
128
+ * return results;
129
+ * },
130
+ * {
131
+ * maxSize: 10,
132
+ * wait: 2000,
133
+ * onError: (error) => console.error('Batch processing failed:', error)
134
+ * },
135
+ * (state) => ({
136
+ * errorCount: state.errorCount,
137
+ * failedItems: state.failedItems,
138
+ * totalItemsFailed: state.totalItemsFailed
139
+ * })
140
+ * );
141
+ *
142
+ * // Complete example with all callbacks
143
+ * const asyncBatcher = useAsyncBatcher(
144
+ * async (items) => {
145
+ * const results = await Promise.all(items.map(item => processItem(item)));
146
+ * return results;
147
+ * },
148
+ * {
149
+ * maxSize: 10,
150
+ * wait: 2000,
151
+ * onSuccess: (result) => {
152
+ * console.log('Batch processed successfully:', result);
153
+ * },
154
+ * onError: (error) => {
155
+ * console.error('Batch processing failed:', error);
156
+ * }
157
+ * }
158
+ * );
159
+ *
160
+ * // Add items to batch
161
+ * asyncBatcher.addItem(newItem);
162
+ *
163
+ * // Manually execute batch
164
+ * const result = await asyncBatcher.execute();
165
+ *
166
+ * // Access the selected state (will be empty object {} unless selector provided)
167
+ * const { isExecuting, lastResult, size } = asyncBatcher.state;
168
+ * ```
169
+ */
170
+ export function useAsyncBatcher<TValue, TSelected = {}>(
171
+ fn: (items: Array<TValue>) => Promise<any>,
172
+ options: AsyncBatcherOptions<TValue> = {},
173
+ selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>
174
+ ({}) as TSelected,
175
+ ): ReactAsyncBatcher<TValue, TSelected> {
176
+ const mergedOptions = {
177
+ ...useDefaultPacerOptions().asyncBatcher,
178
+ ...options,
179
+ } as AsyncBatcherOptions<TValue>
180
+
181
+ const [asyncBatcher] = useState(
182
+ () => new AsyncBatcher<TValue>(fn, mergedOptions),
183
+ )
184
+
185
+ asyncBatcher.fn = fn
186
+ asyncBatcher.setOptions(mergedOptions)
187
+
188
+ const state = useStore(asyncBatcher.store, selector)
189
+
190
+ return useMemo(
191
+ () =>
192
+ ({
193
+ ...asyncBatcher,
194
+ state,
195
+ }) as ReactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`
196
+ [asyncBatcher, state],
197
+ )
198
+ }
@@ -0,0 +1,5 @@
1
+ // re-export everything from the core pacer package, BUT ONLY from the async-debouncer module
2
+ export * from '@tanstack/pacer/async-debouncer'
3
+
4
+ export * from './useAsyncDebouncer'
5
+ export * from './useAsyncDebouncedCallback'
@@ -0,0 +1,54 @@
1
+ import { useCallback } from 'preact/hooks'
2
+ import { useAsyncDebouncer } from './useAsyncDebouncer'
3
+ import type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'
4
+ import type { AnyAsyncFunction } from '@tanstack/pacer/types'
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
+ export function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(
45
+ fn: TFn,
46
+ options: AsyncDebouncerOptions<TFn>,
47
+ ): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {
48
+ const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute
49
+ return useCallback(
50
+ (...args: Parameters<TFn>) =>
51
+ asyncDebouncedFn(...args) as Promise<ReturnType<TFn>>,
52
+ [asyncDebouncedFn],
53
+ )
54
+ }
@@ -0,0 +1,184 @@
1
+ import { useEffect, useMemo, useState } from 'preact/hooks'
2
+ import { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'
3
+ import { useStore } from '@tanstack/preact-store'
4
+ import { useDefaultPacerOptions } from '../provider/PacerProvider'
5
+ import type { Store } from '@tanstack/preact-store'
6
+ import type { AnyAsyncFunction } from '@tanstack/pacer/types'
7
+ import type {
8
+ AsyncDebouncerOptions,
9
+ AsyncDebouncerState,
10
+ } from '@tanstack/pacer/async-debouncer'
11
+
12
+ export interface ReactAsyncDebouncer<
13
+ TFn extends AnyAsyncFunction,
14
+ TSelected = {},
15
+ > extends Omit<AsyncDebouncer<TFn>, 'store'> {
16
+ /**
17
+ * Reactive state that will be updated and re-rendered when the debouncer state changes
18
+ *
19
+ * Use this instead of `debouncer.store.state`
20
+ */
21
+ readonly state: Readonly<TSelected>
22
+ /**
23
+ * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
24
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
25
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
26
+ */
27
+ readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>
28
+ }
29
+
30
+ /**
31
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
32
+ *
33
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
34
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
35
+ *
36
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
37
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
38
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
39
+ *
40
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
41
+ * the function stops being called for the specified delay period.
42
+ *
43
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
44
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
45
+ * instead of setting the result on a state variable from within the debounced function.
46
+ *
47
+ * Error Handling:
48
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
49
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
50
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
51
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
52
+ * - The error state can be checked using the underlying AsyncDebouncer instance
53
+ *
54
+ * ## State Management and Selector
55
+ *
56
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
57
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
58
+ * unnecessary re-renders when irrelevant state changes occur.
59
+ *
60
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
61
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
62
+ * full control over when your component updates. Only when you provide a selector will the
63
+ * component re-render when the selected state values change.
64
+ *
65
+ * Available state properties:
66
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
67
+ * - `errorCount`: Number of function executions that have resulted in errors
68
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
69
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
70
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
71
+ * - `lastResult`: The result from the most recent successful function execution
72
+ * - `settleCount`: Number of function executions that have completed (success or error)
73
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
74
+ * - `successCount`: Number of function executions that have completed successfully
75
+ *
76
+ * @example
77
+ * ```tsx
78
+ * // Default behavior - no reactive state subscriptions
79
+ * const searchDebouncer = useAsyncDebouncer(
80
+ * async (query: string) => {
81
+ * const results = await api.search(query);
82
+ * return results;
83
+ * },
84
+ * { wait: 500 }
85
+ * );
86
+ *
87
+ * // Opt-in to re-render when execution state changes (optimized for loading indicators)
88
+ * const searchDebouncer = useAsyncDebouncer(
89
+ * async (query: string) => {
90
+ * const results = await api.search(query);
91
+ * return results;
92
+ * },
93
+ * { wait: 500 },
94
+ * (state) => ({
95
+ * isExecuting: state.isExecuting,
96
+ * isPending: state.isPending
97
+ * })
98
+ * );
99
+ *
100
+ * // Opt-in to re-render when results are available (optimized for data display)
101
+ * const searchDebouncer = useAsyncDebouncer(
102
+ * async (query: string) => {
103
+ * const results = await api.search(query);
104
+ * return results;
105
+ * },
106
+ * { wait: 500 },
107
+ * (state) => ({
108
+ * lastResult: state.lastResult,
109
+ * successCount: state.successCount
110
+ * })
111
+ * );
112
+ *
113
+ * // Opt-in to re-render when error state changes (optimized for error handling)
114
+ * const searchDebouncer = useAsyncDebouncer(
115
+ * async (query: string) => {
116
+ * const results = await api.search(query);
117
+ * return results;
118
+ * },
119
+ * {
120
+ * wait: 500,
121
+ * onError: (error) => console.error('Search failed:', error)
122
+ * },
123
+ * (state) => ({
124
+ * errorCount: state.errorCount,
125
+ * status: state.status
126
+ * })
127
+ * );
128
+ *
129
+ * // With state management
130
+ * const [results, setResults] = useState([]);
131
+ * const { maybeExecute, state } = useAsyncDebouncer(
132
+ * async (searchTerm) => {
133
+ * const data = await searchAPI(searchTerm);
134
+ * setResults(data);
135
+ * },
136
+ * {
137
+ * wait: 300,
138
+ * leading: true, // Execute immediately on first call
139
+ * trailing: false, // Skip trailing edge updates
140
+ * onError: (error) => {
141
+ * console.error('API call failed:', error);
142
+ * }
143
+ * }
144
+ * );
145
+ *
146
+ * // Access the selected state (will be empty object {} unless selector provided)
147
+ * const { isExecuting, lastResult } = state;
148
+ * ```
149
+ */
150
+ export function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(
151
+ fn: TFn,
152
+ options: AsyncDebouncerOptions<TFn>,
153
+ selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>
154
+ ({}) as TSelected,
155
+ ): ReactAsyncDebouncer<TFn, TSelected> {
156
+ const mergedOptions = {
157
+ ...useDefaultPacerOptions().asyncDebouncer,
158
+ ...options,
159
+ } as AsyncDebouncerOptions<TFn>
160
+
161
+ const [asyncDebouncer] = useState(
162
+ () => new AsyncDebouncer<TFn>(fn, mergedOptions),
163
+ )
164
+
165
+ asyncDebouncer.fn = fn
166
+ asyncDebouncer.setOptions(mergedOptions)
167
+
168
+ const state = useStore(asyncDebouncer.store, selector)
169
+
170
+ useEffect(() => {
171
+ return () => {
172
+ asyncDebouncer.cancel()
173
+ }
174
+ }, [asyncDebouncer])
175
+
176
+ return useMemo(
177
+ () =>
178
+ ({
179
+ ...asyncDebouncer,
180
+ state,
181
+ }) as ReactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`
182
+ [asyncDebouncer, state],
183
+ )
184
+ }
@@ -0,0 +1,4 @@
1
+ export * from '@tanstack/pacer/async-queuer'
2
+
3
+ export * from './useAsyncQueuer'
4
+ export * from './useAsyncQueuedState'
@@ -0,0 +1,165 @@
1
+ import { useAsyncQueuer } from './useAsyncQueuer'
2
+ import type { ReactAsyncQueuer } from './useAsyncQueuer'
3
+ import type {
4
+ AsyncQueuerOptions,
5
+ AsyncQueuerState,
6
+ } from '@tanstack/pacer/async-queuer'
7
+
8
+ /**
9
+ * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.
10
+ *
11
+ * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.
12
+ * It returns a tuple containing:
13
+ * - The current array of queued items as Preact state
14
+ * - The queuer instance with methods to control the queue
15
+ *
16
+ * The queue can be configured with:
17
+ * - Maximum concurrent operations
18
+ * - Maximum queue size
19
+ * - Processing function for queue items
20
+ * - Various lifecycle callbacks
21
+ *
22
+ * The state will automatically update whenever items are:
23
+ * - Added to the queue
24
+ * - Removed from the queue
25
+ * - Started processing
26
+ * - Completed processing
27
+ *
28
+ * ## State Management and Selector
29
+ *
30
+ * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.
31
+ * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,
32
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
33
+ *
34
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
35
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
36
+ * full control over when your component updates. Only when you provide a selector will the
37
+ * component re-render when the selected state values change.
38
+ *
39
+ * Available async queuer state properties:
40
+ * - `activeItems`: Items currently being processed by the queuer
41
+ * - `errorCount`: Number of task executions that have resulted in errors
42
+ * - `expirationCount`: Number of items that have been removed due to expiration
43
+ * - `isEmpty`: Whether the queuer has no items to process
44
+ * - `isFull`: Whether the queuer has reached its maximum capacity
45
+ * - `isIdle`: Whether the queuer is not currently processing any items
46
+ * - `isRunning`: Whether the queuer is active and will process items automatically
47
+ * - `items`: Array of items currently waiting to be processed
48
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
49
+ * - `lastResult`: The result from the most recent task execution
50
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
51
+ * - `rejectionCount`: Number of items that have been rejected from being added
52
+ * - `settledCount`: Number of task executions that have completed (success or error)
53
+ * - `size`: Number of items currently in the queue
54
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
55
+ * - `successCount`: Number of task executions that have completed successfully
56
+ *
57
+ * @example
58
+ * ```tsx
59
+ * // Default behavior - no reactive state subscriptions
60
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
61
+ * async (item) => {
62
+ * const result = await processItem(item);
63
+ * return result;
64
+ * },
65
+ * {
66
+ * concurrency: 2,
67
+ * maxSize: 100,
68
+ * started: true
69
+ * }
70
+ * );
71
+ *
72
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
73
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
74
+ * async (item) => {
75
+ * const result = await processItem(item);
76
+ * return result;
77
+ * },
78
+ * { concurrency: 2, maxSize: 100, started: true },
79
+ * (state) => ({
80
+ * items: state.items,
81
+ * size: state.size,
82
+ * isEmpty: state.isEmpty,
83
+ * isFull: state.isFull
84
+ * })
85
+ * );
86
+ *
87
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
88
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
89
+ * async (item) => {
90
+ * const result = await processItem(item);
91
+ * return result;
92
+ * },
93
+ * { concurrency: 2, maxSize: 100, started: true },
94
+ * (state) => ({
95
+ * isRunning: state.isRunning,
96
+ * isIdle: state.isIdle,
97
+ * status: state.status,
98
+ * activeItems: state.activeItems,
99
+ * pendingTick: state.pendingTick
100
+ * })
101
+ * );
102
+ *
103
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
104
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
105
+ * async (item) => {
106
+ * const result = await processItem(item);
107
+ * return result;
108
+ * },
109
+ * { concurrency: 2, maxSize: 100, started: true },
110
+ * (state) => ({
111
+ * successCount: state.successCount,
112
+ * errorCount: state.errorCount,
113
+ * settledCount: state.settledCount,
114
+ * expirationCount: state.expirationCount,
115
+ * rejectionCount: state.rejectionCount
116
+ * })
117
+ * );
118
+ *
119
+ * // Opt-in to re-render when results are available (optimized for data display)
120
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
121
+ * async (item) => {
122
+ * const result = await processItem(item);
123
+ * return result;
124
+ * },
125
+ * { concurrency: 2, maxSize: 100, started: true },
126
+ * (state) => ({
127
+ * lastResult: state.lastResult,
128
+ * successCount: state.successCount
129
+ * })
130
+ * );
131
+ *
132
+ * // Add items to queue - state updates automatically
133
+ * asyncQueuer.addItem(async () => {
134
+ * const result = await fetchData();
135
+ * return result;
136
+ * });
137
+ *
138
+ * // Start processing
139
+ * asyncQueuer.start();
140
+ *
141
+ * // Stop processing
142
+ * asyncQueuer.stop();
143
+ *
144
+ * // queueItems reflects current queue state
145
+ * const pendingCount = asyncQueuer.peekPendingItems().length;
146
+ *
147
+ * // Access the selected async queuer state (will be empty object {} unless selector provided)
148
+ * const { size, isRunning, activeItems } = asyncQueuer.state;
149
+ * ```
150
+ */
151
+ export function useAsyncQueuedState<
152
+ TValue,
153
+ TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<
154
+ AsyncQueuerState<TValue>,
155
+ 'items'
156
+ >,
157
+ >(
158
+ fn: (value: TValue) => Promise<any>,
159
+ options: AsyncQueuerOptions<TValue> = {},
160
+ selector?: (state: AsyncQueuerState<TValue>) => TSelected,
161
+ ): [Array<TValue>, ReactAsyncQueuer<TValue, TSelected>] {
162
+ const asyncQueuer = useAsyncQueuer(fn, options, selector)
163
+
164
+ return [asyncQueuer.state.items, asyncQueuer]
165
+ }