@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,128 @@
1
+ import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
+ import { useEffect, useMemo, useState } from "preact/hooks";
3
+ import { useStore } from "@tanstack/preact-store";
4
+ import { Debouncer } from "@tanstack/pacer/debouncer";
5
+
6
+ //#region src/debouncer/useDebouncer.ts
7
+ /**
8
+ * A Preact hook that creates and manages a Debouncer instance.
9
+ *
10
+ * This is a lower-level hook that provides direct access to the Debouncer's functionality without
11
+ * any built-in state management. This allows you to integrate it with any state management solution
12
+ * you prefer (useState, Redux, Zustand, etc.).
13
+ *
14
+ * This hook provides debouncing functionality to limit how often a function can be called,
15
+ * waiting for a specified delay before executing the latest call. This is useful for handling
16
+ * frequent events like window resizing, scroll events, or real-time search inputs.
17
+ *
18
+ * The debouncer will only execute the function after the specified wait time has elapsed
19
+ * since the last call. If the function is called again before the wait time expires, the
20
+ * timer resets and starts waiting again.
21
+ *
22
+ * ## State Management and Selector
23
+ *
24
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
25
+ * in two ways:
26
+ *
27
+ * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
28
+ *
29
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
30
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
31
+ * in child components.
32
+ *
33
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
34
+ *
35
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
36
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
37
+ * state changes occur.
38
+ *
39
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
40
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
41
+ * re-renders and gives you full control over when your component updates.
42
+ *
43
+ * Available state properties:
44
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
45
+ * - `executionCount`: Number of function executions that have been completed
46
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
47
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
48
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
49
+ *
50
+ * @example
51
+ * ```tsx
52
+ * // Default behavior - no reactive state subscriptions
53
+ * const searchDebouncer = useDebouncer(
54
+ * (query: string) => fetchSearchResults(query),
55
+ * { wait: 500 }
56
+ * );
57
+ *
58
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
59
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
60
+ * {({ isPending }) => (
61
+ * <div>{isPending ? 'Searching...' : 'Ready'}</div>
62
+ * )}
63
+ * </searchDebouncer.Subscribe>
64
+ *
65
+ * // Opt-in to re-render when isPending changes at hook level (optimized for loading states)
66
+ * const searchDebouncer = useDebouncer(
67
+ * (query: string) => fetchSearchResults(query),
68
+ * { wait: 500 },
69
+ * (state) => ({ isPending: state.isPending })
70
+ * );
71
+ *
72
+ * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
73
+ * const searchDebouncer = useDebouncer(
74
+ * (query: string) => fetchSearchResults(query),
75
+ * { wait: 500 },
76
+ * (state) => ({ executionCount: state.executionCount })
77
+ * );
78
+ *
79
+ * // Multiple state properties - re-render when any of these change
80
+ * const searchDebouncer = useDebouncer(
81
+ * (query: string) => fetchSearchResults(query),
82
+ * { wait: 500 },
83
+ * (state) => ({
84
+ * isPending: state.isPending,
85
+ * executionCount: state.executionCount,
86
+ * status: state.status
87
+ * })
88
+ * );
89
+ *
90
+ * // In an event handler
91
+ * const handleChange = (e) => {
92
+ * searchDebouncer.maybeExecute(e.target.value);
93
+ * };
94
+ *
95
+ * // Access the selected state (will be empty object {} unless selector provided)
96
+ * const { isPending } = searchDebouncer.state;
97
+ * ```
98
+ */
99
+ function useDebouncer(fn, options, selector = () => ({})) {
100
+ const mergedOptions = {
101
+ ...useDefaultPacerOptions().debouncer,
102
+ ...options
103
+ };
104
+ const [debouncer] = useState(() => {
105
+ const debouncerInstance = new Debouncer(fn, mergedOptions);
106
+ debouncerInstance.Subscribe = function Subscribe(props) {
107
+ const selected = useStore(debouncerInstance.store, props.selector);
108
+ return typeof props.children === "function" ? props.children(selected) : props.children;
109
+ };
110
+ return debouncerInstance;
111
+ });
112
+ debouncer.fn = fn;
113
+ debouncer.setOptions(mergedOptions);
114
+ useEffect(() => {
115
+ return () => {
116
+ debouncer.cancel();
117
+ };
118
+ }, [debouncer]);
119
+ const state = useStore(debouncer.store, selector);
120
+ return useMemo(() => ({
121
+ ...debouncer,
122
+ state
123
+ }), [debouncer, state]);
124
+ }
125
+
126
+ //#endregion
127
+ export { useDebouncer };
128
+ //# sourceMappingURL=useDebouncer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useDebouncer.js","names":[],"sources":["../../src/debouncer/useDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n DebouncerOptions,\n DebouncerState,\n} from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactDebouncer<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the 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: DebouncerState<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<DebouncerState<TFn>>>\n}\n\n/**\n * A Preact hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.).\n *\n * This hook provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 * - `executionCount`: Number of function executions that have been completed\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 * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\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 isPending changes at hook level (optimized for loading states)\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({\n * isPending: state.isPending,\n * executionCount: state.executionCount,\n * status: state.status\n * })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n * searchDebouncer.maybeExecute(e.target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = searchDebouncer.state;\n * ```\n */\nexport function useDebouncer<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: DebouncerOptions<TFn>,\n selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().debouncer,\n ...options,\n } as DebouncerOptions<TFn>\n\n const [debouncer] = useState(() => {\n const debouncerInstance = new Debouncer(\n fn,\n mergedOptions,\n ) as unknown as PreactDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: DebouncerState<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 debouncer.fn = fn\n debouncer.setOptions(mergedOptions)\n\n useEffect(() => {\n return () => {\n debouncer.cancel()\n }\n }, [debouncer])\n\n const state = useStore(debouncer.store, selector)\n\n return useMemo(\n () =>\n ({\n ...debouncer,\n state,\n }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [debouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2IA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,aAAa,eAAe;EACjC,MAAM,oBAAoB,IAAI,UAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;AAEnC,iBAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;CAEf,MAAM,QAAQ,SAAS,UAAU,OAAO,SAAS;AAEjD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
package/dist/index.cjs ADDED
@@ -0,0 +1,66 @@
1
+ const require_PacerProvider = require('./provider/PacerProvider.cjs');
2
+ const require_useAsyncBatcher = require('./async-batcher/useAsyncBatcher.cjs');
3
+ const require_useAsyncBatchedCallback = require('./async-batcher/useAsyncBatchedCallback.cjs');
4
+ const require_useAsyncDebouncer = require('./async-debouncer/useAsyncDebouncer.cjs');
5
+ const require_useAsyncDebouncedCallback = require('./async-debouncer/useAsyncDebouncedCallback.cjs');
6
+ const require_useAsyncQueuer = require('./async-queuer/useAsyncQueuer.cjs');
7
+ const require_useAsyncQueuedState = require('./async-queuer/useAsyncQueuedState.cjs');
8
+ const require_useAsyncRateLimiter = require('./async-rate-limiter/useAsyncRateLimiter.cjs');
9
+ const require_useAsyncRateLimitedCallback = require('./async-rate-limiter/useAsyncRateLimitedCallback.cjs');
10
+ const require_useAsyncThrottler = require('./async-throttler/useAsyncThrottler.cjs');
11
+ const require_useAsyncThrottledCallback = require('./async-throttler/useAsyncThrottledCallback.cjs');
12
+ const require_useBatcher = require('./batcher/useBatcher.cjs');
13
+ const require_useBatchedCallback = require('./batcher/useBatchedCallback.cjs');
14
+ const require_useDebouncer = require('./debouncer/useDebouncer.cjs');
15
+ const require_useDebouncedCallback = require('./debouncer/useDebouncedCallback.cjs');
16
+ const require_useDebouncedState = require('./debouncer/useDebouncedState.cjs');
17
+ const require_useDebouncedValue = require('./debouncer/useDebouncedValue.cjs');
18
+ const require_useQueuer = require('./queuer/useQueuer.cjs');
19
+ const require_useQueuedState = require('./queuer/useQueuedState.cjs');
20
+ const require_useQueuedValue = require('./queuer/useQueuedValue.cjs');
21
+ const require_useRateLimiter = require('./rate-limiter/useRateLimiter.cjs');
22
+ const require_useRateLimitedCallback = require('./rate-limiter/useRateLimitedCallback.cjs');
23
+ const require_useRateLimitedState = require('./rate-limiter/useRateLimitedState.cjs');
24
+ const require_useRateLimitedValue = require('./rate-limiter/useRateLimitedValue.cjs');
25
+ const require_useThrottler = require('./throttler/useThrottler.cjs');
26
+ const require_useThrottledCallback = require('./throttler/useThrottledCallback.cjs');
27
+ const require_useThrottledState = require('./throttler/useThrottledState.cjs');
28
+ const require_useThrottledValue = require('./throttler/useThrottledValue.cjs');
29
+
30
+ exports.PacerProvider = require_PacerProvider.PacerProvider;
31
+ exports.useAsyncBatchedCallback = require_useAsyncBatchedCallback.useAsyncBatchedCallback;
32
+ exports.useAsyncBatcher = require_useAsyncBatcher.useAsyncBatcher;
33
+ exports.useAsyncDebouncedCallback = require_useAsyncDebouncedCallback.useAsyncDebouncedCallback;
34
+ exports.useAsyncDebouncer = require_useAsyncDebouncer.useAsyncDebouncer;
35
+ exports.useAsyncQueuedState = require_useAsyncQueuedState.useAsyncQueuedState;
36
+ exports.useAsyncQueuer = require_useAsyncQueuer.useAsyncQueuer;
37
+ exports.useAsyncRateLimitedCallback = require_useAsyncRateLimitedCallback.useAsyncRateLimitedCallback;
38
+ exports.useAsyncRateLimiter = require_useAsyncRateLimiter.useAsyncRateLimiter;
39
+ exports.useAsyncThrottledCallback = require_useAsyncThrottledCallback.useAsyncThrottledCallback;
40
+ exports.useAsyncThrottler = require_useAsyncThrottler.useAsyncThrottler;
41
+ exports.useBatchedCallback = require_useBatchedCallback.useBatchedCallback;
42
+ exports.useBatcher = require_useBatcher.useBatcher;
43
+ exports.useDebouncedCallback = require_useDebouncedCallback.useDebouncedCallback;
44
+ exports.useDebouncedState = require_useDebouncedState.useDebouncedState;
45
+ exports.useDebouncedValue = require_useDebouncedValue.useDebouncedValue;
46
+ exports.useDebouncer = require_useDebouncer.useDebouncer;
47
+ exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
48
+ exports.usePacerContext = require_PacerProvider.usePacerContext;
49
+ exports.useQueuedState = require_useQueuedState.useQueuedState;
50
+ exports.useQueuedValue = require_useQueuedValue.useQueuedValue;
51
+ exports.useQueuer = require_useQueuer.useQueuer;
52
+ exports.useRateLimitedCallback = require_useRateLimitedCallback.useRateLimitedCallback;
53
+ exports.useRateLimitedState = require_useRateLimitedState.useRateLimitedState;
54
+ exports.useRateLimitedValue = require_useRateLimitedValue.useRateLimitedValue;
55
+ exports.useRateLimiter = require_useRateLimiter.useRateLimiter;
56
+ exports.useThrottledCallback = require_useThrottledCallback.useThrottledCallback;
57
+ exports.useThrottledState = require_useThrottledState.useThrottledState;
58
+ exports.useThrottledValue = require_useThrottledValue.useThrottledValue;
59
+ exports.useThrottler = require_useThrottler.useThrottler;
60
+ var _tanstack_pacer = require("@tanstack/pacer");
61
+ Object.keys(_tanstack_pacer).forEach(function (k) {
62
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
63
+ enumerable: true,
64
+ get: function () { return _tanstack_pacer[k]; }
65
+ });
66
+ });
@@ -0,0 +1,30 @@
1
+ import { PreactAsyncBatcher, useAsyncBatcher } from "./async-batcher/useAsyncBatcher.cjs";
2
+ import { useAsyncBatchedCallback } from "./async-batcher/useAsyncBatchedCallback.cjs";
3
+ import { PreactAsyncDebouncer, useAsyncDebouncer } from "./async-debouncer/useAsyncDebouncer.cjs";
4
+ import { useAsyncDebouncedCallback } from "./async-debouncer/useAsyncDebouncedCallback.cjs";
5
+ import { PreactAsyncQueuer, useAsyncQueuer } from "./async-queuer/useAsyncQueuer.cjs";
6
+ import { useAsyncQueuedState } from "./async-queuer/useAsyncQueuedState.cjs";
7
+ import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./async-rate-limiter/useAsyncRateLimiter.cjs";
8
+ import { useAsyncRateLimitedCallback } from "./async-rate-limiter/useAsyncRateLimitedCallback.cjs";
9
+ import { PreactAsyncThrottler, useAsyncThrottler } from "./async-throttler/useAsyncThrottler.cjs";
10
+ import { useAsyncThrottledCallback } from "./async-throttler/useAsyncThrottledCallback.cjs";
11
+ import { PreactBatcher, useBatcher } from "./batcher/useBatcher.cjs";
12
+ import { useBatchedCallback } from "./batcher/useBatchedCallback.cjs";
13
+ import { useDebouncedCallback } from "./debouncer/useDebouncedCallback.cjs";
14
+ import { PreactDebouncer, useDebouncer } from "./debouncer/useDebouncer.cjs";
15
+ import { useDebouncedState } from "./debouncer/useDebouncedState.cjs";
16
+ import { useDebouncedValue } from "./debouncer/useDebouncedValue.cjs";
17
+ import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.cjs";
18
+ import { PreactQueuer, useQueuer } from "./queuer/useQueuer.cjs";
19
+ import { useQueuedState } from "./queuer/useQueuedState.cjs";
20
+ import { useQueuedValue } from "./queuer/useQueuedValue.cjs";
21
+ import { useRateLimitedCallback } from "./rate-limiter/useRateLimitedCallback.cjs";
22
+ import { PreactRateLimiter, useRateLimiter } from "./rate-limiter/useRateLimiter.cjs";
23
+ import { useRateLimitedState } from "./rate-limiter/useRateLimitedState.cjs";
24
+ import { useRateLimitedValue } from "./rate-limiter/useRateLimitedValue.cjs";
25
+ import { useThrottledCallback } from "./throttler/useThrottledCallback.cjs";
26
+ import { PreactThrottler, useThrottler } from "./throttler/useThrottler.cjs";
27
+ import { useThrottledState } from "./throttler/useThrottledState.cjs";
28
+ import { useThrottledValue } from "./throttler/useThrottledValue.cjs";
29
+ export * from "@tanstack/pacer";
30
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, PreactAsyncBatcher, PreactAsyncDebouncer, PreactAsyncQueuer, PreactAsyncRateLimiter, PreactAsyncThrottler, PreactBatcher, PreactDebouncer, PreactQueuer, PreactRateLimiter, PreactThrottler, useAsyncBatchedCallback, useAsyncBatcher, useAsyncDebouncedCallback, useAsyncDebouncer, useAsyncQueuedState, useAsyncQueuer, useAsyncRateLimitedCallback, useAsyncRateLimiter, useAsyncThrottledCallback, useAsyncThrottler, useBatchedCallback, useBatcher, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer, useDefaultPacerOptions, usePacerContext, useQueuedState, useQueuedValue, useQueuer, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };
@@ -0,0 +1,30 @@
1
+ import { PreactAsyncBatcher, useAsyncBatcher } from "./async-batcher/useAsyncBatcher.js";
2
+ import { useAsyncBatchedCallback } from "./async-batcher/useAsyncBatchedCallback.js";
3
+ import { PreactAsyncDebouncer, useAsyncDebouncer } from "./async-debouncer/useAsyncDebouncer.js";
4
+ import { useAsyncDebouncedCallback } from "./async-debouncer/useAsyncDebouncedCallback.js";
5
+ import { PreactAsyncQueuer, useAsyncQueuer } from "./async-queuer/useAsyncQueuer.js";
6
+ import { useAsyncQueuedState } from "./async-queuer/useAsyncQueuedState.js";
7
+ import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./async-rate-limiter/useAsyncRateLimiter.js";
8
+ import { useAsyncRateLimitedCallback } from "./async-rate-limiter/useAsyncRateLimitedCallback.js";
9
+ import { PreactAsyncThrottler, useAsyncThrottler } from "./async-throttler/useAsyncThrottler.js";
10
+ import { useAsyncThrottledCallback } from "./async-throttler/useAsyncThrottledCallback.js";
11
+ import { PreactBatcher, useBatcher } from "./batcher/useBatcher.js";
12
+ import { useBatchedCallback } from "./batcher/useBatchedCallback.js";
13
+ import { useDebouncedCallback } from "./debouncer/useDebouncedCallback.js";
14
+ import { PreactDebouncer, useDebouncer } from "./debouncer/useDebouncer.js";
15
+ import { useDebouncedState } from "./debouncer/useDebouncedState.js";
16
+ import { useDebouncedValue } from "./debouncer/useDebouncedValue.js";
17
+ import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.js";
18
+ import { PreactQueuer, useQueuer } from "./queuer/useQueuer.js";
19
+ import { useQueuedState } from "./queuer/useQueuedState.js";
20
+ import { useQueuedValue } from "./queuer/useQueuedValue.js";
21
+ import { useRateLimitedCallback } from "./rate-limiter/useRateLimitedCallback.js";
22
+ import { PreactRateLimiter, useRateLimiter } from "./rate-limiter/useRateLimiter.js";
23
+ import { useRateLimitedState } from "./rate-limiter/useRateLimitedState.js";
24
+ import { useRateLimitedValue } from "./rate-limiter/useRateLimitedValue.js";
25
+ import { useThrottledCallback } from "./throttler/useThrottledCallback.js";
26
+ import { PreactThrottler, useThrottler } from "./throttler/useThrottler.js";
27
+ import { useThrottledState } from "./throttler/useThrottledState.js";
28
+ import { useThrottledValue } from "./throttler/useThrottledValue.js";
29
+ export * from "@tanstack/pacer";
30
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, PreactAsyncBatcher, PreactAsyncDebouncer, PreactAsyncQueuer, PreactAsyncRateLimiter, PreactAsyncThrottler, PreactBatcher, PreactDebouncer, PreactQueuer, PreactRateLimiter, PreactThrottler, useAsyncBatchedCallback, useAsyncBatcher, useAsyncDebouncedCallback, useAsyncDebouncer, useAsyncQueuedState, useAsyncQueuer, useAsyncRateLimitedCallback, useAsyncRateLimiter, useAsyncThrottledCallback, useAsyncThrottler, useBatchedCallback, useBatcher, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer, useDefaultPacerOptions, usePacerContext, useQueuedState, useQueuedValue, useQueuer, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };
package/dist/index.js ADDED
@@ -0,0 +1,32 @@
1
+ import { PacerProvider, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.js";
2
+ import { useAsyncBatcher } from "./async-batcher/useAsyncBatcher.js";
3
+ import { useAsyncBatchedCallback } from "./async-batcher/useAsyncBatchedCallback.js";
4
+ import { useAsyncDebouncer } from "./async-debouncer/useAsyncDebouncer.js";
5
+ import { useAsyncDebouncedCallback } from "./async-debouncer/useAsyncDebouncedCallback.js";
6
+ import { useAsyncQueuer } from "./async-queuer/useAsyncQueuer.js";
7
+ import { useAsyncQueuedState } from "./async-queuer/useAsyncQueuedState.js";
8
+ import { useAsyncRateLimiter } from "./async-rate-limiter/useAsyncRateLimiter.js";
9
+ import { useAsyncRateLimitedCallback } from "./async-rate-limiter/useAsyncRateLimitedCallback.js";
10
+ import { useAsyncThrottler } from "./async-throttler/useAsyncThrottler.js";
11
+ import { useAsyncThrottledCallback } from "./async-throttler/useAsyncThrottledCallback.js";
12
+ import { useBatcher } from "./batcher/useBatcher.js";
13
+ import { useBatchedCallback } from "./batcher/useBatchedCallback.js";
14
+ import { useDebouncer } from "./debouncer/useDebouncer.js";
15
+ import { useDebouncedCallback } from "./debouncer/useDebouncedCallback.js";
16
+ import { useDebouncedState } from "./debouncer/useDebouncedState.js";
17
+ import { useDebouncedValue } from "./debouncer/useDebouncedValue.js";
18
+ import { useQueuer } from "./queuer/useQueuer.js";
19
+ import { useQueuedState } from "./queuer/useQueuedState.js";
20
+ import { useQueuedValue } from "./queuer/useQueuedValue.js";
21
+ import { useRateLimiter } from "./rate-limiter/useRateLimiter.js";
22
+ import { useRateLimitedCallback } from "./rate-limiter/useRateLimitedCallback.js";
23
+ import { useRateLimitedState } from "./rate-limiter/useRateLimitedState.js";
24
+ import { useRateLimitedValue } from "./rate-limiter/useRateLimitedValue.js";
25
+ import { useThrottler } from "./throttler/useThrottler.js";
26
+ import { useThrottledCallback } from "./throttler/useThrottledCallback.js";
27
+ import { useThrottledState } from "./throttler/useThrottledState.js";
28
+ import { useThrottledValue } from "./throttler/useThrottledValue.js";
29
+
30
+ export * from "@tanstack/pacer"
31
+
32
+ export { PacerProvider, useAsyncBatchedCallback, useAsyncBatcher, useAsyncDebouncedCallback, useAsyncDebouncer, useAsyncQueuedState, useAsyncQueuer, useAsyncRateLimitedCallback, useAsyncRateLimiter, useAsyncThrottledCallback, useAsyncThrottler, useBatchedCallback, useBatcher, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer, useDefaultPacerOptions, usePacerContext, useQueuedState, useQueuedValue, useQueuer, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };
@@ -0,0 +1,26 @@
1
+ let preact_hooks = require("preact/hooks");
2
+ let preact = require("preact");
3
+ let preact_jsx_runtime = require("preact/jsx-runtime");
4
+
5
+ //#region src/provider/PacerProvider.tsx
6
+ const PacerContext = (0, preact.createContext)(null);
7
+ const DEFAULT_OPTIONS = {};
8
+ function PacerProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
9
+ const contextValue = (0, preact_hooks.useMemo)(() => ({ defaultOptions }), [defaultOptions]);
10
+ return /* @__PURE__ */ (0, preact_jsx_runtime.jsx)(PacerContext.Provider, {
11
+ value: contextValue,
12
+ children
13
+ });
14
+ }
15
+ function usePacerContext() {
16
+ return (0, preact_hooks.useContext)(PacerContext);
17
+ }
18
+ function useDefaultPacerOptions() {
19
+ return (0, preact_hooks.useContext)(PacerContext)?.defaultOptions ?? {};
20
+ }
21
+
22
+ //#endregion
23
+ exports.PacerProvider = PacerProvider;
24
+ exports.useDefaultPacerOptions = useDefaultPacerOptions;
25
+ exports.usePacerContext = usePacerContext;
26
+ //# sourceMappingURL=PacerProvider.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PacerProvider.cjs","names":["DEFAULT_OPTIONS: PacerProviderOptions","contextValue: PacerContextValue"],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { useContext, useMemo } from 'preact/hooks'\nimport { createContext } from 'preact'\nimport type { ComponentChildren } from 'preact'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: ComponentChildren\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider({\n children,\n defaultOptions = DEFAULT_OPTIONS,\n}: PacerProviderProps) {\n const contextValue: PacerContextValue = useMemo(\n () => ({\n defaultOptions,\n }),\n [defaultOptions],\n )\n\n return (\n <PacerContext.Provider value={contextValue}>\n {children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAmCA,MAAM,yCAAuD,KAAK;AAOlE,MAAMA,kBAAwC,EAAE;AAEhD,SAAgB,cAAc,EAC5B,UACA,iBAAiB,mBACI;CACrB,MAAMC,gDACG,EACL,gBACD,GACD,CAAC,eAAe,CACjB;AAED,QACE,4CAAC,aAAa;EAAS,OAAO;EAC3B;GACqB;;AAI5B,SAAgB,kBAAkB;AAChC,qCAAkB,aAAa;;AAGjC,SAAgB,yBAAyB;AAEvC,qCAD2B,aAAa,EACxB,kBAAkB,EAAE"}
@@ -0,0 +1,33 @@
1
+ import * as preact0 from "preact";
2
+ import { ComponentChildren } from "preact";
3
+ import { AnyAsyncFunction, AnyFunction, AsyncBatcherOptions, AsyncDebouncerOptions, AsyncQueuerOptions, AsyncRateLimiterOptions, AsyncThrottlerOptions, BatcherOptions, DebouncerOptions, QueuerOptions, RateLimiterOptions, ThrottlerOptions } from "@tanstack/pacer";
4
+
5
+ //#region src/provider/PacerProvider.d.ts
6
+ interface PacerProviderOptions {
7
+ asyncBatcher?: Partial<AsyncBatcherOptions<any>>;
8
+ asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>;
9
+ asyncQueuer?: Partial<AsyncQueuerOptions<any>>;
10
+ asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>;
11
+ asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>;
12
+ batcher?: Partial<BatcherOptions<any>>;
13
+ debouncer?: Partial<DebouncerOptions<AnyFunction>>;
14
+ queuer?: Partial<QueuerOptions<any>>;
15
+ rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>;
16
+ throttler?: Partial<ThrottlerOptions<AnyFunction>>;
17
+ }
18
+ interface PacerContextValue {
19
+ defaultOptions: PacerProviderOptions;
20
+ }
21
+ interface PacerProviderProps {
22
+ children: ComponentChildren;
23
+ defaultOptions?: PacerProviderOptions;
24
+ }
25
+ declare function PacerProvider({
26
+ children,
27
+ defaultOptions
28
+ }: PacerProviderProps): preact0.JSX.Element;
29
+ declare function usePacerContext(): PacerContextValue | null;
30
+ declare function useDefaultPacerOptions(): PacerProviderOptions;
31
+ //#endregion
32
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
33
+ //# sourceMappingURL=PacerProvider.d.cts.map
@@ -0,0 +1,33 @@
1
+ import { AnyAsyncFunction, AnyFunction, AsyncBatcherOptions, AsyncDebouncerOptions, AsyncQueuerOptions, AsyncRateLimiterOptions, AsyncThrottlerOptions, BatcherOptions, DebouncerOptions, QueuerOptions, RateLimiterOptions, ThrottlerOptions } from "@tanstack/pacer";
2
+ import * as preact0 from "preact";
3
+ import { ComponentChildren } from "preact";
4
+
5
+ //#region src/provider/PacerProvider.d.ts
6
+ interface PacerProviderOptions {
7
+ asyncBatcher?: Partial<AsyncBatcherOptions<any>>;
8
+ asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>;
9
+ asyncQueuer?: Partial<AsyncQueuerOptions<any>>;
10
+ asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>;
11
+ asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>;
12
+ batcher?: Partial<BatcherOptions<any>>;
13
+ debouncer?: Partial<DebouncerOptions<AnyFunction>>;
14
+ queuer?: Partial<QueuerOptions<any>>;
15
+ rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>;
16
+ throttler?: Partial<ThrottlerOptions<AnyFunction>>;
17
+ }
18
+ interface PacerContextValue {
19
+ defaultOptions: PacerProviderOptions;
20
+ }
21
+ interface PacerProviderProps {
22
+ children: ComponentChildren;
23
+ defaultOptions?: PacerProviderOptions;
24
+ }
25
+ declare function PacerProvider({
26
+ children,
27
+ defaultOptions
28
+ }: PacerProviderProps): preact0.JSX.Element;
29
+ declare function usePacerContext(): PacerContextValue | null;
30
+ declare function useDefaultPacerOptions(): PacerProviderOptions;
31
+ //#endregion
32
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
33
+ //# sourceMappingURL=PacerProvider.d.ts.map
@@ -0,0 +1,24 @@
1
+ import { useContext, useMemo } from "preact/hooks";
2
+ import { createContext } from "preact";
3
+ import { jsx } from "preact/jsx-runtime";
4
+
5
+ //#region src/provider/PacerProvider.tsx
6
+ const PacerContext = createContext(null);
7
+ const DEFAULT_OPTIONS = {};
8
+ function PacerProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
9
+ const contextValue = useMemo(() => ({ defaultOptions }), [defaultOptions]);
10
+ return /* @__PURE__ */ jsx(PacerContext.Provider, {
11
+ value: contextValue,
12
+ children
13
+ });
14
+ }
15
+ function usePacerContext() {
16
+ return useContext(PacerContext);
17
+ }
18
+ function useDefaultPacerOptions() {
19
+ return useContext(PacerContext)?.defaultOptions ?? {};
20
+ }
21
+
22
+ //#endregion
23
+ export { PacerProvider, useDefaultPacerOptions, usePacerContext };
24
+ //# sourceMappingURL=PacerProvider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PacerProvider.js","names":["DEFAULT_OPTIONS: PacerProviderOptions","contextValue: PacerContextValue"],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { useContext, useMemo } from 'preact/hooks'\nimport { createContext } from 'preact'\nimport type { ComponentChildren } from 'preact'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: ComponentChildren\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider({\n children,\n defaultOptions = DEFAULT_OPTIONS,\n}: PacerProviderProps) {\n const contextValue: PacerContextValue = useMemo(\n () => ({\n defaultOptions,\n }),\n [defaultOptions],\n )\n\n return (\n <PacerContext.Provider value={contextValue}>\n {children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAmCA,MAAM,eAAe,cAAwC,KAAK;AAOlE,MAAMA,kBAAwC,EAAE;AAEhD,SAAgB,cAAc,EAC5B,UACA,iBAAiB,mBACI;CACrB,MAAMC,eAAkC,eAC/B,EACL,gBACD,GACD,CAAC,eAAe,CACjB;AAED,QACE,oBAAC,aAAa;EAAS,OAAO;EAC3B;GACqB;;AAI5B,SAAgB,kBAAkB;AAChC,QAAO,WAAW,aAAa;;AAGjC,SAAgB,yBAAyB;AAEvC,QADgB,WAAW,aAAa,EACxB,kBAAkB,EAAE"}
@@ -0,0 +1,5 @@
1
+ const require_PacerProvider = require('./PacerProvider.cjs');
2
+
3
+ exports.PacerProvider = require_PacerProvider.PacerProvider;
4
+ exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
5
+ exports.usePacerContext = require_PacerProvider.usePacerContext;
@@ -0,0 +1,2 @@
1
+ import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./PacerProvider.cjs";
2
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
@@ -0,0 +1,2 @@
1
+ import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./PacerProvider.js";
2
+ export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
@@ -0,0 +1,3 @@
1
+ import { PacerProvider, useDefaultPacerOptions, usePacerContext } from "./PacerProvider.js";
2
+
3
+ export { PacerProvider, useDefaultPacerOptions, usePacerContext };
@@ -0,0 +1,14 @@
1
+ const require_useQueuer = require('./useQueuer.cjs');
2
+ const require_useQueuedState = require('./useQueuedState.cjs');
3
+ const require_useQueuedValue = require('./useQueuedValue.cjs');
4
+
5
+ exports.useQueuedState = require_useQueuedState.useQueuedState;
6
+ exports.useQueuedValue = require_useQueuedValue.useQueuedValue;
7
+ exports.useQueuer = require_useQueuer.useQueuer;
8
+ var _tanstack_pacer_queuer = require("@tanstack/pacer/queuer");
9
+ Object.keys(_tanstack_pacer_queuer).forEach(function (k) {
10
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
11
+ enumerable: true,
12
+ get: function () { return _tanstack_pacer_queuer[k]; }
13
+ });
14
+ });
@@ -0,0 +1,5 @@
1
+ import { PreactQueuer, useQueuer } from "./useQueuer.cjs";
2
+ import { useQueuedState } from "./useQueuedState.cjs";
3
+ import { useQueuedValue } from "./useQueuedValue.cjs";
4
+ export * from "@tanstack/pacer/queuer";
5
+ export { PreactQueuer, useQueuedState, useQueuedValue, useQueuer };
@@ -0,0 +1,5 @@
1
+ import { PreactQueuer, useQueuer } from "./useQueuer.js";
2
+ import { useQueuedState } from "./useQueuedState.js";
3
+ import { useQueuedValue } from "./useQueuedValue.js";
4
+ export * from "@tanstack/pacer/queuer";
5
+ export { PreactQueuer, useQueuedState, useQueuedValue, useQueuer };
@@ -0,0 +1,7 @@
1
+ import { useQueuer } from "./useQueuer.js";
2
+ import { useQueuedState } from "./useQueuedState.js";
3
+ import { useQueuedValue } from "./useQueuedValue.js";
4
+
5
+ export * from "@tanstack/pacer/queuer"
6
+
7
+ export { useQueuedState, useQueuedValue, useQueuer };
@@ -0,0 +1,129 @@
1
+ const require_useQueuer = require('./useQueuer.cjs');
2
+
3
+ //#region src/queuer/useQueuedState.ts
4
+ /**
5
+ * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.
6
+ * This hook provides both the current queue state and queue control methods.
7
+ *
8
+ * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
9
+ * All queue operations are reflected in the state array returned by the hook.
10
+ *
11
+ * The queue can be started and stopped to automatically process items at a specified interval,
12
+ * making it useful as a scheduler. When started, it will process one item per tick, with an
13
+ * optional wait time between ticks.
14
+ *
15
+ * The hook returns a tuple containing:
16
+ * - The current queue state as an array
17
+ * - The queue instance with methods for queue manipulation
18
+ *
19
+ * ## State Management and Selector
20
+ *
21
+ * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
22
+ * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
23
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
24
+ *
25
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
26
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
27
+ * full control over when your component updates. Only when you provide a selector will the
28
+ * component re-render when the selected state values change.
29
+ *
30
+ * Available queuer state properties:
31
+ * - `executionCount`: Number of items that have been processed by the queuer
32
+ * - `expirationCount`: Number of items that have been removed due to expiration
33
+ * - `isEmpty`: Whether the queuer has no items to process
34
+ * - `isFull`: Whether the queuer has reached its maximum capacity
35
+ * - `isIdle`: Whether the queuer is not currently processing any items
36
+ * - `isRunning`: Whether the queuer is active and will process items automatically
37
+ * - `items`: Array of items currently waiting to be processed
38
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
39
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
40
+ * - `rejectionCount`: Number of items that have been rejected from being added
41
+ * - `size`: Number of items currently in the queue
42
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
43
+ *
44
+ * @example
45
+ * ```tsx
46
+ * // Default behavior - no reactive state subscriptions
47
+ * const [items, addItem, queue] = useQueuedState(
48
+ * (item) => console.log('Processing:', item),
49
+ * {
50
+ * initialItems: ['item1', 'item2'],
51
+ * started: true,
52
+ * wait: 1000,
53
+ * getPriority: (item) => item.priority
54
+ * }
55
+ * );
56
+ *
57
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
58
+ * const [items, addItem, queue] = useQueuedState(
59
+ * (item) => console.log('Processing:', item),
60
+ * { started: true, wait: 1000 },
61
+ * (state) => ({
62
+ * items: state.items,
63
+ * size: state.size,
64
+ * isEmpty: state.isEmpty
65
+ * })
66
+ * );
67
+ *
68
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
69
+ * const [items, addItem, queue] = useQueuedState(
70
+ * (item) => console.log('Processing:', item),
71
+ * { started: true, wait: 1000 },
72
+ * (state) => ({
73
+ * isRunning: state.isRunning,
74
+ * isIdle: state.isIdle,
75
+ * status: state.status,
76
+ * pendingTick: state.pendingTick
77
+ * })
78
+ * );
79
+ *
80
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
81
+ * const [items, addItem, queue] = useQueuedState(
82
+ * (item) => console.log('Processing:', item),
83
+ * { started: true, wait: 1000 },
84
+ * (state) => ({
85
+ * executionCount: state.executionCount,
86
+ * expirationCount: state.expirationCount,
87
+ * rejectionCount: state.rejectionCount
88
+ * })
89
+ * );
90
+ *
91
+ * // Add items to queue
92
+ * const handleAdd = (item) => {
93
+ * addItem(item);
94
+ * };
95
+ *
96
+ * // Start automatic processing
97
+ * const startProcessing = () => {
98
+ * queue.start();
99
+ * };
100
+ *
101
+ * // Stop automatic processing
102
+ * const stopProcessing = () => {
103
+ * queue.stop();
104
+ * };
105
+ *
106
+ * // Manual processing still available
107
+ * const handleProcess = () => {
108
+ * const nextItem = queue.getNextItem();
109
+ * if (nextItem) {
110
+ * processItem(nextItem);
111
+ * }
112
+ * };
113
+ *
114
+ * // Access the selected queuer state (will be empty object {} unless selector provided)
115
+ * const { size, isRunning, executionCount } = queue.state;
116
+ * ```
117
+ */
118
+ function useQueuedState(fn, options = {}, selector) {
119
+ const queue = require_useQueuer.useQueuer(fn, options, selector);
120
+ return [
121
+ queue.state.items,
122
+ queue.addItem,
123
+ queue
124
+ ];
125
+ }
126
+
127
+ //#endregion
128
+ exports.useQueuedState = useQueuedState;
129
+ //# sourceMappingURL=useQueuedState.cjs.map