@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,178 @@
1
+ import { Store } from "@tanstack/preact-store";
2
+ import { ComponentChildren } from "preact";
3
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
4
+ import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
5
+
6
+ //#region src/async-debouncer/useAsyncDebouncer.d.ts
7
+ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
+ /**
9
+ * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.
10
+ *
11
+ * This is useful for opting into state re-renders for specific parts of the debouncer state
12
+ * deep in your component tree without needing to pass a selector to the hook.
13
+ *
14
+ * @example
15
+ * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
16
+ * {({ isPending }) => (
17
+ * <div>{isPending ? 'Loading...' : 'Ready'}</div>
18
+ * )}
19
+ * </debouncer.Subscribe>
20
+ */
21
+ Subscribe: <TSelected>(props: {
22
+ selector: (state: AsyncDebouncerState<TFn>) => TSelected;
23
+ children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
24
+ }) => ComponentChildren;
25
+ /**
26
+ * Reactive state that will be updated and re-rendered when the debouncer state changes
27
+ *
28
+ * Use this instead of `debouncer.store.state`
29
+ */
30
+ readonly state: Readonly<TSelected>;
31
+ /**
32
+ * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
33
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
34
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
35
+ */
36
+ readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
37
+ }
38
+ /**
39
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
40
+ *
41
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
42
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
43
+ *
44
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
45
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
46
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
47
+ *
48
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
49
+ * the function stops being called for the specified delay period.
50
+ *
51
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
52
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
53
+ * instead of setting the result on a state variable from within the debounced function.
54
+ *
55
+ * Error Handling:
56
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
57
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
58
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
59
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
60
+ * - The error state can be checked using the underlying AsyncDebouncer instance
61
+ *
62
+ * ## State Management and Selector
63
+ *
64
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
65
+ * in two ways:
66
+ *
67
+ * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
68
+ *
69
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
70
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
71
+ * in child components.
72
+ *
73
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
74
+ *
75
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
76
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
77
+ * state changes occur.
78
+ *
79
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
80
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
81
+ * re-renders and gives you full control over when your component updates.
82
+ *
83
+ * Available state properties:
84
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
85
+ * - `errorCount`: Number of function executions that have resulted in errors
86
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
87
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
88
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
89
+ * - `lastResult`: The result from the most recent successful function execution
90
+ * - `settleCount`: Number of function executions that have completed (success or error)
91
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
92
+ * - `successCount`: Number of function executions that have completed successfully
93
+ *
94
+ * @example
95
+ * ```tsx
96
+ * // Default behavior - no reactive state subscriptions
97
+ * const searchDebouncer = useAsyncDebouncer(
98
+ * async (query: string) => {
99
+ * const results = await api.search(query);
100
+ * return results;
101
+ * },
102
+ * { wait: 500 }
103
+ * );
104
+ *
105
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
106
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
107
+ * {({ isPending }) => (
108
+ * <div>{isPending ? 'Searching...' : 'Ready'}</div>
109
+ * )}
110
+ * </searchDebouncer.Subscribe>
111
+ *
112
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
113
+ * const searchDebouncer = useAsyncDebouncer(
114
+ * async (query: string) => {
115
+ * const results = await api.search(query);
116
+ * return results;
117
+ * },
118
+ * { wait: 500 },
119
+ * (state) => ({
120
+ * isExecuting: state.isExecuting,
121
+ * isPending: state.isPending
122
+ * })
123
+ * );
124
+ *
125
+ * // Opt-in to re-render when results are available (optimized for data display)
126
+ * const searchDebouncer = useAsyncDebouncer(
127
+ * async (query: string) => {
128
+ * const results = await api.search(query);
129
+ * return results;
130
+ * },
131
+ * { wait: 500 },
132
+ * (state) => ({
133
+ * lastResult: state.lastResult,
134
+ * successCount: state.successCount
135
+ * })
136
+ * );
137
+ *
138
+ * // Opt-in to re-render when error state changes (optimized for error handling)
139
+ * const searchDebouncer = useAsyncDebouncer(
140
+ * async (query: string) => {
141
+ * const results = await api.search(query);
142
+ * return results;
143
+ * },
144
+ * {
145
+ * wait: 500,
146
+ * onError: (error) => console.error('Search failed:', error)
147
+ * },
148
+ * (state) => ({
149
+ * errorCount: state.errorCount,
150
+ * status: state.status
151
+ * })
152
+ * );
153
+ *
154
+ * // With state management
155
+ * const [results, setResults] = useState([]);
156
+ * const { maybeExecute, state } = useAsyncDebouncer(
157
+ * async (searchTerm) => {
158
+ * const data = await searchAPI(searchTerm);
159
+ * setResults(data);
160
+ * },
161
+ * {
162
+ * wait: 300,
163
+ * leading: true, // Execute immediately on first call
164
+ * trailing: false, // Skip trailing edge updates
165
+ * onError: (error) => {
166
+ * console.error('API call failed:', error);
167
+ * }
168
+ * }
169
+ * );
170
+ *
171
+ * // Access the selected state (will be empty object {} unless selector provided)
172
+ * const { isExecuting, lastResult } = state;
173
+ * ```
174
+ */
175
+ declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
176
+ //#endregion
177
+ export { PreactAsyncDebouncer, useAsyncDebouncer };
178
+ //# sourceMappingURL=useAsyncDebouncer.d.cts.map
@@ -0,0 +1,178 @@
1
+ import { ComponentChildren } from "preact";
2
+ import { Store } from "@tanstack/preact-store";
3
+ import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
4
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
5
+
6
+ //#region src/async-debouncer/useAsyncDebouncer.d.ts
7
+ interface PreactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
+ /**
9
+ * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.
10
+ *
11
+ * This is useful for opting into state re-renders for specific parts of the debouncer state
12
+ * deep in your component tree without needing to pass a selector to the hook.
13
+ *
14
+ * @example
15
+ * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
16
+ * {({ isPending }) => (
17
+ * <div>{isPending ? 'Loading...' : 'Ready'}</div>
18
+ * )}
19
+ * </debouncer.Subscribe>
20
+ */
21
+ Subscribe: <TSelected>(props: {
22
+ selector: (state: AsyncDebouncerState<TFn>) => TSelected;
23
+ children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
24
+ }) => ComponentChildren;
25
+ /**
26
+ * Reactive state that will be updated and re-rendered when the debouncer state changes
27
+ *
28
+ * Use this instead of `debouncer.store.state`
29
+ */
30
+ readonly state: Readonly<TSelected>;
31
+ /**
32
+ * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
33
+ * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
34
+ * Although, you can make the state reactive by using the `useStore` in your own usage.
35
+ */
36
+ readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
37
+ }
38
+ /**
39
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
40
+ *
41
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
42
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
43
+ *
44
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
45
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
46
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
47
+ *
48
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
49
+ * the function stops being called for the specified delay period.
50
+ *
51
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
52
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
53
+ * instead of setting the result on a state variable from within the debounced function.
54
+ *
55
+ * Error Handling:
56
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
57
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
58
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
59
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
60
+ * - The error state can be checked using the underlying AsyncDebouncer instance
61
+ *
62
+ * ## State Management and Selector
63
+ *
64
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
65
+ * in two ways:
66
+ *
67
+ * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
68
+ *
69
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
70
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
71
+ * in child components.
72
+ *
73
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
74
+ *
75
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
76
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
77
+ * state changes occur.
78
+ *
79
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
80
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
81
+ * re-renders and gives you full control over when your component updates.
82
+ *
83
+ * Available state properties:
84
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
85
+ * - `errorCount`: Number of function executions that have resulted in errors
86
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
87
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
88
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
89
+ * - `lastResult`: The result from the most recent successful function execution
90
+ * - `settleCount`: Number of function executions that have completed (success or error)
91
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
92
+ * - `successCount`: Number of function executions that have completed successfully
93
+ *
94
+ * @example
95
+ * ```tsx
96
+ * // Default behavior - no reactive state subscriptions
97
+ * const searchDebouncer = useAsyncDebouncer(
98
+ * async (query: string) => {
99
+ * const results = await api.search(query);
100
+ * return results;
101
+ * },
102
+ * { wait: 500 }
103
+ * );
104
+ *
105
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
106
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
107
+ * {({ isPending }) => (
108
+ * <div>{isPending ? 'Searching...' : 'Ready'}</div>
109
+ * )}
110
+ * </searchDebouncer.Subscribe>
111
+ *
112
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
113
+ * const searchDebouncer = useAsyncDebouncer(
114
+ * async (query: string) => {
115
+ * const results = await api.search(query);
116
+ * return results;
117
+ * },
118
+ * { wait: 500 },
119
+ * (state) => ({
120
+ * isExecuting: state.isExecuting,
121
+ * isPending: state.isPending
122
+ * })
123
+ * );
124
+ *
125
+ * // Opt-in to re-render when results are available (optimized for data display)
126
+ * const searchDebouncer = useAsyncDebouncer(
127
+ * async (query: string) => {
128
+ * const results = await api.search(query);
129
+ * return results;
130
+ * },
131
+ * { wait: 500 },
132
+ * (state) => ({
133
+ * lastResult: state.lastResult,
134
+ * successCount: state.successCount
135
+ * })
136
+ * );
137
+ *
138
+ * // Opt-in to re-render when error state changes (optimized for error handling)
139
+ * const searchDebouncer = useAsyncDebouncer(
140
+ * async (query: string) => {
141
+ * const results = await api.search(query);
142
+ * return results;
143
+ * },
144
+ * {
145
+ * wait: 500,
146
+ * onError: (error) => console.error('Search failed:', error)
147
+ * },
148
+ * (state) => ({
149
+ * errorCount: state.errorCount,
150
+ * status: state.status
151
+ * })
152
+ * );
153
+ *
154
+ * // With state management
155
+ * const [results, setResults] = useState([]);
156
+ * const { maybeExecute, state } = useAsyncDebouncer(
157
+ * async (searchTerm) => {
158
+ * const data = await searchAPI(searchTerm);
159
+ * setResults(data);
160
+ * },
161
+ * {
162
+ * wait: 300,
163
+ * leading: true, // Execute immediately on first call
164
+ * trailing: false, // Skip trailing edge updates
165
+ * onError: (error) => {
166
+ * console.error('API call failed:', error);
167
+ * }
168
+ * }
169
+ * );
170
+ *
171
+ * // Access the selected state (will be empty object {} unless selector provided)
172
+ * const { isExecuting, lastResult } = state;
173
+ * ```
174
+ */
175
+ declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): PreactAsyncDebouncer<TFn, TSelected>;
176
+ //#endregion
177
+ export { PreactAsyncDebouncer, useAsyncDebouncer };
178
+ //# sourceMappingURL=useAsyncDebouncer.d.ts.map
@@ -0,0 +1,173 @@
1
+ import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
+ import { useEffect, useMemo, useState } from "preact/hooks";
3
+ import { useStore } from "@tanstack/preact-store";
4
+ import { AsyncDebouncer } from "@tanstack/pacer/async-debouncer";
5
+
6
+ //#region src/async-debouncer/useAsyncDebouncer.ts
7
+ /**
8
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
9
+ *
10
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
11
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
12
+ *
13
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
14
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
15
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
16
+ *
17
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
18
+ * the function stops being called for the specified delay period.
19
+ *
20
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
21
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
22
+ * instead of setting the result on a state variable from within the debounced function.
23
+ *
24
+ * Error Handling:
25
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
26
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
27
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
28
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
29
+ * - The error state can be checked using the underlying AsyncDebouncer instance
30
+ *
31
+ * ## State Management and Selector
32
+ *
33
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
34
+ * in two ways:
35
+ *
36
+ * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
37
+ *
38
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
39
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
40
+ * in child components.
41
+ *
42
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
43
+ *
44
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
45
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
46
+ * state changes occur.
47
+ *
48
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
49
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
50
+ * re-renders and gives you full control over when your component updates.
51
+ *
52
+ * Available state properties:
53
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
54
+ * - `errorCount`: Number of function executions that have resulted in errors
55
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
56
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
57
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
58
+ * - `lastResult`: The result from the most recent successful function execution
59
+ * - `settleCount`: Number of function executions that have completed (success or error)
60
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
61
+ * - `successCount`: Number of function executions that have completed successfully
62
+ *
63
+ * @example
64
+ * ```tsx
65
+ * // Default behavior - no reactive state subscriptions
66
+ * const searchDebouncer = useAsyncDebouncer(
67
+ * async (query: string) => {
68
+ * const results = await api.search(query);
69
+ * return results;
70
+ * },
71
+ * { wait: 500 }
72
+ * );
73
+ *
74
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
75
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
76
+ * {({ isPending }) => (
77
+ * <div>{isPending ? 'Searching...' : 'Ready'}</div>
78
+ * )}
79
+ * </searchDebouncer.Subscribe>
80
+ *
81
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
82
+ * const searchDebouncer = useAsyncDebouncer(
83
+ * async (query: string) => {
84
+ * const results = await api.search(query);
85
+ * return results;
86
+ * },
87
+ * { wait: 500 },
88
+ * (state) => ({
89
+ * isExecuting: state.isExecuting,
90
+ * isPending: state.isPending
91
+ * })
92
+ * );
93
+ *
94
+ * // Opt-in to re-render when results are available (optimized for data display)
95
+ * const searchDebouncer = useAsyncDebouncer(
96
+ * async (query: string) => {
97
+ * const results = await api.search(query);
98
+ * return results;
99
+ * },
100
+ * { wait: 500 },
101
+ * (state) => ({
102
+ * lastResult: state.lastResult,
103
+ * successCount: state.successCount
104
+ * })
105
+ * );
106
+ *
107
+ * // Opt-in to re-render when error state changes (optimized for error handling)
108
+ * const searchDebouncer = useAsyncDebouncer(
109
+ * async (query: string) => {
110
+ * const results = await api.search(query);
111
+ * return results;
112
+ * },
113
+ * {
114
+ * wait: 500,
115
+ * onError: (error) => console.error('Search failed:', error)
116
+ * },
117
+ * (state) => ({
118
+ * errorCount: state.errorCount,
119
+ * status: state.status
120
+ * })
121
+ * );
122
+ *
123
+ * // With state management
124
+ * const [results, setResults] = useState([]);
125
+ * const { maybeExecute, state } = useAsyncDebouncer(
126
+ * async (searchTerm) => {
127
+ * const data = await searchAPI(searchTerm);
128
+ * setResults(data);
129
+ * },
130
+ * {
131
+ * wait: 300,
132
+ * leading: true, // Execute immediately on first call
133
+ * trailing: false, // Skip trailing edge updates
134
+ * onError: (error) => {
135
+ * console.error('API call failed:', error);
136
+ * }
137
+ * }
138
+ * );
139
+ *
140
+ * // Access the selected state (will be empty object {} unless selector provided)
141
+ * const { isExecuting, lastResult } = state;
142
+ * ```
143
+ */
144
+ function useAsyncDebouncer(fn, options, selector = () => ({})) {
145
+ const mergedOptions = {
146
+ ...useDefaultPacerOptions().asyncDebouncer,
147
+ ...options
148
+ };
149
+ const [asyncDebouncer] = useState(() => {
150
+ const debouncerInstance = new AsyncDebouncer(fn, mergedOptions);
151
+ debouncerInstance.Subscribe = function Subscribe(props) {
152
+ const selected = useStore(debouncerInstance.store, props.selector);
153
+ return typeof props.children === "function" ? props.children(selected) : props.children;
154
+ };
155
+ return debouncerInstance;
156
+ });
157
+ asyncDebouncer.fn = fn;
158
+ asyncDebouncer.setOptions(mergedOptions);
159
+ const state = useStore(asyncDebouncer.store, selector);
160
+ useEffect(() => {
161
+ return () => {
162
+ asyncDebouncer.cancel();
163
+ };
164
+ }, [asyncDebouncer]);
165
+ return useMemo(() => ({
166
+ ...asyncDebouncer,
167
+ state
168
+ }), [asyncDebouncer, state]);
169
+ }
170
+
171
+ //#endregion
172
+ export { useAsyncDebouncer };
173
+ //# sourceMappingURL=useAsyncDebouncer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAsyncDebouncer.js","names":[],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` in your own usage.\n */\n readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncDebouncer instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * { wait: 500 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n * async (query: string) => {\n * const results = await api.search(query);\n * return results;\n * },\n * {\n * wait: 500,\n * onError: (error) => console.error('Search failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n * async (searchTerm) => {\n * const data = await searchAPI(searchTerm);\n * setResults(data);\n * },\n * {\n * wait: 300,\n * leading: true, // Execute immediately on first call\n * trailing: false, // Skip trailing edge updates\n * onError: (error) => {\n * console.error('API call failed:', error);\n * }\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncDebouncer,\n ...options,\n } as AsyncDebouncerOptions<TFn>\n\n const [asyncDebouncer] = useState(() => {\n const debouncerInstance = new AsyncDebouncer<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncDebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useStore(debouncerInstance.store, props.selector)\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n asyncDebouncer.fn = fn\n asyncDebouncer.setOptions(mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector)\n\n useEffect(() => {\n return () => {\n asyncDebouncer.cancel()\n }\n }, [asyncDebouncer])\n\n return useMemo(\n () =>\n ({\n ...asyncDebouncer,\n state,\n }) as PreactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncDebouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwLA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,kBAAkB,eAAe;EACtC,MAAM,oBAAoB,IAAI,eAC5B,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,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,iBAAgB;AACd,eAAa;AACX,kBAAe,QAAQ;;IAExB,CAAC,eAAe,CAAC;AAEpB,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}
@@ -0,0 +1,12 @@
1
+ const require_useAsyncQueuer = require('./useAsyncQueuer.cjs');
2
+ const require_useAsyncQueuedState = require('./useAsyncQueuedState.cjs');
3
+
4
+ exports.useAsyncQueuedState = require_useAsyncQueuedState.useAsyncQueuedState;
5
+ exports.useAsyncQueuer = require_useAsyncQueuer.useAsyncQueuer;
6
+ var _tanstack_pacer_async_queuer = require("@tanstack/pacer/async-queuer");
7
+ Object.keys(_tanstack_pacer_async_queuer).forEach(function (k) {
8
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
9
+ enumerable: true,
10
+ get: function () { return _tanstack_pacer_async_queuer[k]; }
11
+ });
12
+ });
@@ -0,0 +1,4 @@
1
+ import { PreactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.cjs";
2
+ import { useAsyncQueuedState } from "./useAsyncQueuedState.cjs";
3
+ export * from "@tanstack/pacer/async-queuer";
4
+ export { PreactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };
@@ -0,0 +1,4 @@
1
+ import { PreactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.js";
2
+ import { useAsyncQueuedState } from "./useAsyncQueuedState.js";
3
+ export * from "@tanstack/pacer/async-queuer";
4
+ export { PreactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };
@@ -0,0 +1,6 @@
1
+ import { useAsyncQueuer } from "./useAsyncQueuer.js";
2
+ import { useAsyncQueuedState } from "./useAsyncQueuedState.js";
3
+
4
+ export * from "@tanstack/pacer/async-queuer"
5
+
6
+ export { useAsyncQueuedState, useAsyncQueuer };