@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,136 @@
1
+ import { useEffect, useMemo, useState } from 'preact/hooks'
2
+ import { Debouncer } from '@tanstack/pacer/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 {
7
+ DebouncerOptions,
8
+ DebouncerState,
9
+ } from '@tanstack/pacer/debouncer'
10
+ import type { AnyFunction } from '@tanstack/pacer/types'
11
+
12
+ export interface PreactDebouncer<
13
+ TFn extends AnyFunction,
14
+ TSelected = {},
15
+ > extends Omit<Debouncer<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<DebouncerState<TFn>>>
28
+ }
29
+
30
+ /**
31
+ * A Preact hook that creates and manages a Debouncer instance.
32
+ *
33
+ * This is a lower-level hook that provides direct access to the Debouncer's functionality without
34
+ * any built-in state management. This allows you to integrate it with any state management solution
35
+ * you prefer (useState, Redux, Zustand, etc.).
36
+ *
37
+ * This hook provides debouncing functionality to limit how often a function can be called,
38
+ * waiting for a specified delay before executing the latest call. This is useful for handling
39
+ * frequent events like window resizing, scroll events, or real-time search inputs.
40
+ *
41
+ * The debouncer will only execute the function after the specified wait time has elapsed
42
+ * since the last call. If the function is called again before the wait time expires, the
43
+ * timer resets and starts waiting again.
44
+ *
45
+ * ## State Management and Selector
46
+ *
47
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
48
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
49
+ * unnecessary re-renders when irrelevant state changes occur.
50
+ *
51
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
52
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
53
+ * full control over when your component updates. Only when you provide a selector will the
54
+ * component re-render when the selected state values change.
55
+ *
56
+ * Available state properties:
57
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
58
+ * - `executionCount`: Number of function executions that have been completed
59
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
60
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
61
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
62
+ *
63
+ * @example
64
+ * ```tsx
65
+ * // Default behavior - no reactive state subscriptions
66
+ * const searchDebouncer = useDebouncer(
67
+ * (query: string) => fetchSearchResults(query),
68
+ * { wait: 500 }
69
+ * );
70
+ *
71
+ * // Opt-in to re-render when isPending changes (optimized for loading states)
72
+ * const searchDebouncer = useDebouncer(
73
+ * (query: string) => fetchSearchResults(query),
74
+ * { wait: 500 },
75
+ * (state) => ({ isPending: state.isPending })
76
+ * );
77
+ *
78
+ * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
79
+ * const searchDebouncer = useDebouncer(
80
+ * (query: string) => fetchSearchResults(query),
81
+ * { wait: 500 },
82
+ * (state) => ({ executionCount: state.executionCount })
83
+ * );
84
+ *
85
+ * // Multiple state properties - re-render when any of these change
86
+ * const searchDebouncer = useDebouncer(
87
+ * (query: string) => fetchSearchResults(query),
88
+ * { wait: 500 },
89
+ * (state) => ({
90
+ * isPending: state.isPending,
91
+ * executionCount: state.executionCount,
92
+ * status: state.status
93
+ * })
94
+ * );
95
+ *
96
+ * // In an event handler
97
+ * const handleChange = (e) => {
98
+ * searchDebouncer.maybeExecute(e.target.value);
99
+ * };
100
+ *
101
+ * // Access the selected state (will be empty object {} unless selector provided)
102
+ * const { isPending } = searchDebouncer.state;
103
+ * ```
104
+ */
105
+ export function useDebouncer<TFn extends AnyFunction, TSelected = {}>(
106
+ fn: TFn,
107
+ options: DebouncerOptions<TFn>,
108
+ selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,
109
+ ): PreactDebouncer<TFn, TSelected> {
110
+ const mergedOptions = {
111
+ ...useDefaultPacerOptions().debouncer,
112
+ ...options,
113
+ } as DebouncerOptions<TFn>
114
+
115
+ const [debouncer] = useState(() => new Debouncer(fn, mergedOptions))
116
+
117
+ debouncer.fn = fn
118
+ debouncer.setOptions(mergedOptions)
119
+
120
+ useEffect(() => {
121
+ return () => {
122
+ debouncer.cancel()
123
+ }
124
+ }, [debouncer])
125
+
126
+ const state = useStore(debouncer.store, selector)
127
+
128
+ return useMemo(
129
+ () =>
130
+ ({
131
+ ...debouncer,
132
+ state,
133
+ }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`
134
+ [debouncer, state],
135
+ )
136
+ }
package/src/index.ts ADDED
@@ -0,0 +1,56 @@
1
+ // re-export everything from the core pacer package
2
+ export * from '@tanstack/pacer'
3
+
4
+ // provider
5
+ export * from './provider/PacerProvider'
6
+
7
+ /**
8
+ * Export every hook individually - DON'T export from barrel files
9
+ */
10
+
11
+ // async-batcher
12
+ export * from './async-batcher/useAsyncBatcher'
13
+ export * from './async-batcher/useAsyncBatchedCallback'
14
+
15
+ // async-debouncer
16
+ export * from './async-debouncer/useAsyncDebouncer'
17
+ export * from './async-debouncer/useAsyncDebouncedCallback'
18
+
19
+ // async-queuer
20
+ export * from './async-queuer/useAsyncQueuer'
21
+ export * from './async-queuer/useAsyncQueuedState'
22
+
23
+ // async-rate-limiter
24
+ export * from './async-rate-limiter/useAsyncRateLimiter'
25
+ export * from './async-rate-limiter/useAsyncRateLimitedCallback'
26
+
27
+ // async-throttler
28
+ export * from './async-throttler/useAsyncThrottler'
29
+ export * from './async-throttler/useAsyncThrottledCallback'
30
+
31
+ // batcher
32
+ export * from './batcher/useBatcher'
33
+ export * from './batcher/useBatchedCallback'
34
+
35
+ // debouncer
36
+ export * from './debouncer/useDebouncedCallback'
37
+ export * from './debouncer/useDebouncedState'
38
+ export * from './debouncer/useDebouncedValue'
39
+ export * from './debouncer/useDebouncer'
40
+
41
+ // queuer
42
+ export * from './queuer/useQueuer'
43
+ export * from './queuer/useQueuedState'
44
+ export * from './queuer/useQueuedValue'
45
+
46
+ // rate-limiter
47
+ export * from './rate-limiter/useRateLimitedCallback'
48
+ export * from './rate-limiter/useRateLimiter'
49
+ export * from './rate-limiter/useRateLimitedState'
50
+ export * from './rate-limiter/useRateLimitedValue'
51
+
52
+ // throttler
53
+ export * from './throttler/useThrottledCallback'
54
+ export * from './throttler/useThrottledState'
55
+ export * from './throttler/useThrottledValue'
56
+ export * from './throttler/useThrottler'
@@ -0,0 +1,70 @@
1
+ import { useContext, useMemo } from 'preact/hooks'
2
+ import { createContext } from 'preact'
3
+ import type { ComponentChildren } from 'preact'
4
+ import type {
5
+ AnyAsyncFunction,
6
+ AnyFunction,
7
+ AsyncBatcherOptions,
8
+ AsyncDebouncerOptions,
9
+ AsyncQueuerOptions,
10
+ AsyncRateLimiterOptions,
11
+ AsyncThrottlerOptions,
12
+ BatcherOptions,
13
+ DebouncerOptions,
14
+ QueuerOptions,
15
+ RateLimiterOptions,
16
+ ThrottlerOptions,
17
+ } from '@tanstack/pacer'
18
+
19
+ export interface PacerProviderOptions {
20
+ asyncBatcher?: Partial<AsyncBatcherOptions<any>>
21
+ asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>
22
+ asyncQueuer?: Partial<AsyncQueuerOptions<any>>
23
+ asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>
24
+ asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>
25
+ batcher?: Partial<BatcherOptions<any>>
26
+ debouncer?: Partial<DebouncerOptions<AnyFunction>>
27
+ queuer?: Partial<QueuerOptions<any>>
28
+ rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>
29
+ throttler?: Partial<ThrottlerOptions<AnyFunction>>
30
+ }
31
+
32
+ interface PacerContextValue {
33
+ defaultOptions: PacerProviderOptions
34
+ }
35
+
36
+ const PacerContext = createContext<PacerContextValue | null>(null)
37
+
38
+ export interface PacerProviderProps {
39
+ children: ComponentChildren
40
+ defaultOptions?: PacerProviderOptions
41
+ }
42
+
43
+ const DEFAULT_OPTIONS: PacerProviderOptions = {}
44
+
45
+ export function PacerProvider({
46
+ children,
47
+ defaultOptions = DEFAULT_OPTIONS,
48
+ }: PacerProviderProps) {
49
+ const contextValue: PacerContextValue = useMemo(
50
+ () => ({
51
+ defaultOptions,
52
+ }),
53
+ [defaultOptions],
54
+ )
55
+
56
+ return (
57
+ <PacerContext.Provider value={contextValue}>
58
+ {children}
59
+ </PacerContext.Provider>
60
+ )
61
+ }
62
+
63
+ export function usePacerContext() {
64
+ return useContext(PacerContext)
65
+ }
66
+
67
+ export function useDefaultPacerOptions() {
68
+ const context = useContext(PacerContext)
69
+ return context?.defaultOptions ?? {}
70
+ }
@@ -0,0 +1 @@
1
+ export * from './PacerProvider'
@@ -0,0 +1,5 @@
1
+ export * from '@tanstack/pacer/queuer'
2
+
3
+ export * from './useQueuer'
4
+ export * from './useQueuedState'
5
+ export * from './useQueuedValue'
@@ -0,0 +1,133 @@
1
+ import { useQueuer } from './useQueuer'
2
+ import type { PreactQueuer } from './useQueuer'
3
+ import type { Queuer, QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
4
+
5
+ /**
6
+ * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.
7
+ * This hook provides both the current queue state and queue control methods.
8
+ *
9
+ * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
10
+ * All queue operations are reflected in the state array returned by the hook.
11
+ *
12
+ * The queue can be started and stopped to automatically process items at a specified interval,
13
+ * making it useful as a scheduler. When started, it will process one item per tick, with an
14
+ * optional wait time between ticks.
15
+ *
16
+ * The hook returns a tuple containing:
17
+ * - The current queue state as an array
18
+ * - The queue instance with methods for queue manipulation
19
+ *
20
+ * ## State Management and Selector
21
+ *
22
+ * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
23
+ * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
24
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
25
+ *
26
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
27
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
28
+ * full control over when your component updates. Only when you provide a selector will the
29
+ * component re-render when the selected state values change.
30
+ *
31
+ * Available queuer state properties:
32
+ * - `executionCount`: Number of items that have been processed by the queuer
33
+ * - `expirationCount`: Number of items that have been removed due to expiration
34
+ * - `isEmpty`: Whether the queuer has no items to process
35
+ * - `isFull`: Whether the queuer has reached its maximum capacity
36
+ * - `isIdle`: Whether the queuer is not currently processing any items
37
+ * - `isRunning`: Whether the queuer is active and will process items automatically
38
+ * - `items`: Array of items currently waiting to be processed
39
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
40
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
41
+ * - `rejectionCount`: Number of items that have been rejected from being added
42
+ * - `size`: Number of items currently in the queue
43
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
44
+ *
45
+ * @example
46
+ * ```tsx
47
+ * // Default behavior - no reactive state subscriptions
48
+ * const [items, addItem, queue] = useQueuedState(
49
+ * (item) => console.log('Processing:', item),
50
+ * {
51
+ * initialItems: ['item1', 'item2'],
52
+ * started: true,
53
+ * wait: 1000,
54
+ * getPriority: (item) => item.priority
55
+ * }
56
+ * );
57
+ *
58
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
59
+ * const [items, addItem, queue] = useQueuedState(
60
+ * (item) => console.log('Processing:', item),
61
+ * { started: true, wait: 1000 },
62
+ * (state) => ({
63
+ * items: state.items,
64
+ * size: state.size,
65
+ * isEmpty: state.isEmpty
66
+ * })
67
+ * );
68
+ *
69
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
70
+ * const [items, addItem, queue] = useQueuedState(
71
+ * (item) => console.log('Processing:', item),
72
+ * { started: true, wait: 1000 },
73
+ * (state) => ({
74
+ * isRunning: state.isRunning,
75
+ * isIdle: state.isIdle,
76
+ * status: state.status,
77
+ * pendingTick: state.pendingTick
78
+ * })
79
+ * );
80
+ *
81
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
82
+ * const [items, addItem, queue] = useQueuedState(
83
+ * (item) => console.log('Processing:', item),
84
+ * { started: true, wait: 1000 },
85
+ * (state) => ({
86
+ * executionCount: state.executionCount,
87
+ * expirationCount: state.expirationCount,
88
+ * rejectionCount: state.rejectionCount
89
+ * })
90
+ * );
91
+ *
92
+ * // Add items to queue
93
+ * const handleAdd = (item) => {
94
+ * addItem(item);
95
+ * };
96
+ *
97
+ * // Start automatic processing
98
+ * const startProcessing = () => {
99
+ * queue.start();
100
+ * };
101
+ *
102
+ * // Stop automatic processing
103
+ * const stopProcessing = () => {
104
+ * queue.stop();
105
+ * };
106
+ *
107
+ * // Manual processing still available
108
+ * const handleProcess = () => {
109
+ * const nextItem = queue.getNextItem();
110
+ * if (nextItem) {
111
+ * processItem(nextItem);
112
+ * }
113
+ * };
114
+ *
115
+ * // Access the selected queuer state (will be empty object {} unless selector provided)
116
+ * const { size, isRunning, executionCount } = queue.state;
117
+ * ```
118
+ */
119
+ export function useQueuedState<
120
+ TValue,
121
+ TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<
122
+ QueuerState<TValue>,
123
+ 'items'
124
+ >,
125
+ >(
126
+ fn: (item: TValue) => void,
127
+ options: QueuerOptions<TValue> = {},
128
+ selector?: (state: QueuerState<TValue>) => TSelected,
129
+ ): [Array<TValue>, Queuer<TValue>['addItem'], PreactQueuer<TValue, TSelected>] {
130
+ const queue = useQueuer(fn, options, selector)
131
+
132
+ return [queue.state.items, queue.addItem, queue]
133
+ }
@@ -0,0 +1,129 @@
1
+ import { useEffect, useState } from 'preact/hooks'
2
+ import { useQueuedState } from './useQueuedState'
3
+ import type { PreactQueuer } from './useQueuer'
4
+ import type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
5
+
6
+ /**
7
+ * A Preact hook that creates a queued value that processes state changes in order with an optional delay.
8
+ * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.
9
+ *
10
+ * The queued value will process changes in the order they are received, with optional delays between
11
+ * processing each change. This is useful for handling state updates that need to be processed
12
+ * in a specific order, like animations or sequential UI updates.
13
+ *
14
+ * The hook returns a tuple containing:
15
+ * - The current queued value
16
+ * - The queuer instance with control methods
17
+ *
18
+ * ## State Management and Selector
19
+ *
20
+ * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
21
+ * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
22
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
23
+ *
24
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
25
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
26
+ * full control over when your component updates. Only when you provide a selector will the
27
+ * component re-render when the selected state values change.
28
+ *
29
+ * Available queuer state properties:
30
+ * - `executionCount`: Number of items that have been processed by the queuer
31
+ * - `expirationCount`: Number of items that have been removed due to expiration
32
+ * - `isEmpty`: Whether the queuer has no items to process
33
+ * - `isFull`: Whether the queuer has reached its maximum capacity
34
+ * - `isIdle`: Whether the queuer is not currently processing any items
35
+ * - `isRunning`: Whether the queuer is active and will process items automatically
36
+ * - `items`: Array of items currently waiting to be processed
37
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
38
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
39
+ * - `rejectionCount`: Number of items that have been rejected from being added
40
+ * - `size`: Number of items currently in the queue
41
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
42
+ *
43
+ * @example
44
+ * ```tsx
45
+ * // Default behavior - no reactive state subscriptions
46
+ * const [value, queuer] = useQueuedValue(initialValue, {
47
+ * wait: 500, // Wait 500ms between processing each change
48
+ * started: true // Start processing immediately
49
+ * });
50
+ *
51
+ * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)
52
+ * const [value, queuer] = useQueuedValue(
53
+ * initialValue,
54
+ * { wait: 500, started: true },
55
+ * (state) => ({
56
+ * isRunning: state.isRunning,
57
+ * isIdle: state.isIdle,
58
+ * status: state.status,
59
+ * pendingTick: state.pendingTick
60
+ * })
61
+ * );
62
+ *
63
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue status)
64
+ * const [value, queuer] = useQueuedValue(
65
+ * initialValue,
66
+ * { wait: 500, started: true },
67
+ * (state) => ({
68
+ * size: state.size,
69
+ * isEmpty: state.isEmpty,
70
+ * isFull: state.isFull
71
+ * })
72
+ * );
73
+ *
74
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
75
+ * const [value, queuer] = useQueuedValue(
76
+ * initialValue,
77
+ * { wait: 500, started: true },
78
+ * (state) => ({
79
+ * executionCount: state.executionCount,
80
+ * expirationCount: state.expirationCount,
81
+ * rejectionCount: state.rejectionCount
82
+ * })
83
+ * );
84
+ *
85
+ * // Add changes to the queue
86
+ * const handleChange = (newValue) => {
87
+ * queuer.addItem(newValue);
88
+ * };
89
+ *
90
+ * // Control the queue
91
+ * const pauseProcessing = () => {
92
+ * queuer.stop();
93
+ * };
94
+ *
95
+ * const resumeProcessing = () => {
96
+ * queuer.start();
97
+ * };
98
+ *
99
+ * // Access the selected queuer state (will be empty object {} unless selector provided)
100
+ * const { size, isRunning, executionCount } = queuer.state;
101
+ * ```
102
+ */
103
+ export function useQueuedValue<
104
+ TValue,
105
+ TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<
106
+ QueuerState<TValue>,
107
+ 'items'
108
+ >,
109
+ >(
110
+ initialValue: TValue,
111
+ options: QueuerOptions<TValue> = {},
112
+ selector?: (state: QueuerState<TValue>) => TSelected,
113
+ ): [TValue, PreactQueuer<TValue, TSelected>] {
114
+ const [value, setValue] = useState<TValue>(initialValue)
115
+
116
+ const [, addItem, queuer] = useQueuedState(
117
+ (item) => {
118
+ setValue(item)
119
+ },
120
+ options,
121
+ selector,
122
+ )
123
+
124
+ useEffect(() => {
125
+ addItem(initialValue)
126
+ }, [initialValue, addItem])
127
+
128
+ return [value, queuer]
129
+ }
@@ -0,0 +1,160 @@
1
+ import { useMemo, useState } from 'preact/hooks'
2
+ import { Queuer } from '@tanstack/pacer/queuer'
3
+ import { useStore } from '@tanstack/preact-store'
4
+ import { useDefaultPacerOptions } from '../provider/PacerProvider'
5
+ import type { Store } from '@tanstack/preact-store'
6
+ import type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
7
+
8
+ export interface PreactQueuer<TValue, TSelected = {}> extends Omit<
9
+ Queuer<TValue>,
10
+ 'store'
11
+ > {
12
+ /**
13
+ * Reactive state that will be updated and re-rendered when the queuer state changes
14
+ *
15
+ * Use this instead of `queuer.store.state`
16
+ */
17
+ readonly state: Readonly<TSelected>
18
+ /**
19
+ * @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.
20
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
21
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
22
+ */
23
+ readonly store: Store<Readonly<QueuerState<TValue>>>
24
+ }
25
+
26
+ /**
27
+ * A Preact hook that creates and manages a Queuer instance.
28
+ *
29
+ * This is a lower-level hook that provides direct access to the Queuer's functionality without
30
+ * any built-in state management. This allows you to integrate it with any state management solution
31
+ * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
32
+ *
33
+ * For a hook with built-in state management, see useQueuedState.
34
+ *
35
+ * The Queuer extends the base Queue to add processing capabilities. Items are processed
36
+ * synchronously in order, with optional delays between processing each item. The queuer includes
37
+ * an internal tick mechanism that can be started and stopped, making it useful as a scheduler.
38
+ * When started, it will process one item per tick, with an optional wait time between ticks.
39
+ *
40
+ * By default uses FIFO (First In First Out) behavior, but can be configured for LIFO
41
+ * (Last In First Out) by specifying 'front' position when adding items.
42
+ *
43
+ * ## State Management and Selector
44
+ *
45
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
46
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
47
+ * unnecessary re-renders when irrelevant state changes occur.
48
+ *
49
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
50
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
51
+ * full control over when your component updates. Only when you provide a selector will the
52
+ * component re-render when the selected state values change.
53
+ *
54
+ * Available state properties:
55
+ * - `executionCount`: Number of items that have been processed by the queuer
56
+ * - `expirationCount`: Number of items that have been removed due to expiration
57
+ * - `isEmpty`: Whether the queuer has no items to process
58
+ * - `isFull`: Whether the queuer has reached its maximum capacity
59
+ * - `isIdle`: Whether the queuer is not currently processing any items
60
+ * - `isRunning`: Whether the queuer is active and will process items automatically
61
+ * - `items`: Array of items currently waiting to be processed
62
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
63
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
64
+ * - `rejectionCount`: Number of items that have been rejected from being added
65
+ * - `size`: Number of items currently in the queue
66
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
67
+ *
68
+ * @example
69
+ * ```tsx
70
+ * // Default behavior - no reactive state subscriptions
71
+ * const queue = useQueuer(
72
+ * (item) => console.log('Processing:', item),
73
+ * { started: true, wait: 1000 }
74
+ * );
75
+ *
76
+ * // Opt-in to re-render when queue size changes (optimized for displaying queue length)
77
+ * const queue = useQueuer(
78
+ * (item) => console.log('Processing:', item),
79
+ * { started: true, wait: 1000 },
80
+ * (state) => ({
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 queue = useQueuer(
89
+ * (item) => console.log('Processing:', item),
90
+ * { started: true, wait: 1000 },
91
+ * (state) => ({
92
+ * isRunning: state.isRunning,
93
+ * isIdle: state.isIdle,
94
+ * status: state.status,
95
+ * pendingTick: state.pendingTick
96
+ * })
97
+ * );
98
+ *
99
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
100
+ * const queue = useQueuer(
101
+ * (item) => console.log('Processing:', item),
102
+ * { started: true, wait: 1000 },
103
+ * (state) => ({
104
+ * executionCount: state.executionCount,
105
+ * expirationCount: state.expirationCount,
106
+ * rejectionCount: state.rejectionCount
107
+ * })
108
+ * );
109
+ *
110
+ * // Example with custom state management and scheduling
111
+ * const [items, setItems] = useState([]);
112
+ *
113
+ * const queue = useQueuer(
114
+ * (item) => console.log('Processing:', item),
115
+ * {
116
+ * started: true, // Start processing immediately
117
+ * wait: 1000, // Process one item every second
118
+ * onItemsChange: (queue) => setItems(queue.peekAllItems()),
119
+ * getPriority: (item) => item.priority // Process higher priority items first
120
+ * }
121
+ * );
122
+ *
123
+ * // Add items to process - they'll be handled automatically
124
+ * queue.addItem('task1');
125
+ * queue.addItem('task2');
126
+ *
127
+ * // Control the scheduler
128
+ * queue.stop(); // Pause processing
129
+ * queue.start(); // Resume processing
130
+ *
131
+ * // Access the selected state (will be empty object {} unless selector provided)
132
+ * const { size, isRunning, executionCount } = queue.state;
133
+ * ```
134
+ */
135
+ export function useQueuer<TValue, TSelected = {}>(
136
+ fn: (item: TValue) => void,
137
+ options: QueuerOptions<TValue> = {},
138
+ selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,
139
+ ): PreactQueuer<TValue, TSelected> {
140
+ const mergedOptions = {
141
+ ...useDefaultPacerOptions().queuer,
142
+ ...options,
143
+ } as QueuerOptions<TValue>
144
+
145
+ const [queuer] = useState(() => new Queuer<TValue>(fn, mergedOptions))
146
+
147
+ queuer.fn = fn
148
+ queuer.setOptions(mergedOptions)
149
+
150
+ const state = useStore(queuer.store, selector)
151
+
152
+ return useMemo(
153
+ () =>
154
+ ({
155
+ ...queuer,
156
+ state,
157
+ }) as PreactQueuer<TValue, TSelected>, // omit `store` in favor of `state`
158
+ [queuer, state],
159
+ )
160
+ }