@tanstack/preact-pacer 0.23.0 → 0.24.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 (242) hide show
  1. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -4
  2. package/dist/async-batcher/useAsyncBatchedCallback.js +1 -2
  3. package/dist/async-batcher/useAsyncBatcher.d.ts +4 -7
  4. package/dist/async-batcher/useAsyncBatcher.js +1 -3
  5. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +2 -4
  6. package/dist/async-debouncer/useAsyncDebouncedCallback.js +1 -2
  7. package/dist/async-debouncer/useAsyncDebouncer.d.ts +4 -6
  8. package/dist/async-debouncer/useAsyncDebouncer.js +1 -2
  9. package/dist/async-queuer/useAsyncQueuedState.d.ts +4 -6
  10. package/dist/async-queuer/useAsyncQueuedState.js +3 -4
  11. package/dist/async-queuer/useAsyncQueuer.d.ts +6 -8
  12. package/dist/async-queuer/useAsyncQueuer.js +3 -4
  13. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -4
  14. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +1 -2
  15. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +4 -6
  16. package/dist/async-rate-limiter/useAsyncRateLimiter.js +1 -2
  17. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +2 -4
  18. package/dist/async-throttler/useAsyncThrottledCallback.js +1 -2
  19. package/dist/async-throttler/useAsyncThrottler.d.ts +4 -6
  20. package/dist/async-throttler/useAsyncThrottler.js +1 -2
  21. package/dist/batcher/useBatchedCallback.d.ts +2 -4
  22. package/dist/batcher/useBatchedCallback.js +1 -2
  23. package/dist/batcher/useBatcher.d.ts +6 -10
  24. package/dist/batcher/useBatcher.js +3 -6
  25. package/dist/debouncer/useDebouncedCallback.d.ts +2 -4
  26. package/dist/debouncer/useDebouncedCallback.js +1 -2
  27. package/dist/debouncer/useDebouncedState.d.ts +2 -4
  28. package/dist/debouncer/useDebouncedState.js +1 -2
  29. package/dist/debouncer/useDebouncedValue.d.ts +2 -4
  30. package/dist/debouncer/useDebouncedValue.js +1 -2
  31. package/dist/debouncer/useDebouncer.d.ts +4 -6
  32. package/dist/debouncer/useDebouncer.js +1 -2
  33. package/dist/provider/PacerProvider.d.ts +6 -8
  34. package/dist/provider/PacerProvider.js +1 -2
  35. package/dist/queuer/useQueuedState.d.ts +2 -4
  36. package/dist/queuer/useQueuedState.js +1 -2
  37. package/dist/queuer/useQueuedValue.d.ts +2 -4
  38. package/dist/queuer/useQueuedValue.js +1 -2
  39. package/dist/queuer/useQueuer.d.ts +4 -6
  40. package/dist/queuer/useQueuer.js +1 -2
  41. package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -4
  42. package/dist/rate-limiter/useRateLimitedCallback.js +1 -2
  43. package/dist/rate-limiter/useRateLimitedState.d.ts +2 -4
  44. package/dist/rate-limiter/useRateLimitedState.js +1 -2
  45. package/dist/rate-limiter/useRateLimitedValue.d.ts +2 -4
  46. package/dist/rate-limiter/useRateLimitedValue.js +1 -2
  47. package/dist/rate-limiter/useRateLimiter.d.ts +4 -6
  48. package/dist/rate-limiter/useRateLimiter.js +1 -2
  49. package/dist/throttler/useThrottledCallback.d.ts +2 -4
  50. package/dist/throttler/useThrottledCallback.js +1 -2
  51. package/dist/throttler/useThrottledState.d.ts +2 -4
  52. package/dist/throttler/useThrottledState.js +1 -2
  53. package/dist/throttler/useThrottledValue.d.ts +2 -4
  54. package/dist/throttler/useThrottledValue.js +1 -2
  55. package/dist/throttler/useThrottler.d.ts +4 -6
  56. package/dist/throttler/useThrottler.js +1 -2
  57. package/package.json +22 -70
  58. package/dist/async-batcher/index.cjs +0 -13
  59. package/dist/async-batcher/index.d.cts +0 -4
  60. package/dist/async-batcher/useAsyncBatchedCallback.cjs +0 -51
  61. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +0 -1
  62. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +0 -43
  63. package/dist/async-batcher/useAsyncBatchedCallback.js.map +0 -1
  64. package/dist/async-batcher/useAsyncBatcher.cjs +0 -217
  65. package/dist/async-batcher/useAsyncBatcher.cjs.map +0 -1
  66. package/dist/async-batcher/useAsyncBatcher.d.cts +0 -223
  67. package/dist/async-batcher/useAsyncBatcher.js.map +0 -1
  68. package/dist/async-debouncer/index.cjs +0 -13
  69. package/dist/async-debouncer/index.d.cts +0 -4
  70. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs +0 -52
  71. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +0 -1
  72. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +0 -47
  73. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +0 -1
  74. package/dist/async-debouncer/useAsyncDebouncer.cjs +0 -195
  75. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +0 -1
  76. package/dist/async-debouncer/useAsyncDebouncer.d.cts +0 -202
  77. package/dist/async-debouncer/useAsyncDebouncer.js.map +0 -1
  78. package/dist/async-queuer/index.cjs +0 -13
  79. package/dist/async-queuer/index.d.cts +0 -4
  80. package/dist/async-queuer/useAsyncQueuedState.cjs +0 -154
  81. package/dist/async-queuer/useAsyncQueuedState.cjs.map +0 -1
  82. package/dist/async-queuer/useAsyncQueuedState.d.cts +0 -150
  83. package/dist/async-queuer/useAsyncQueuedState.js.map +0 -1
  84. package/dist/async-queuer/useAsyncQueuer.cjs +0 -217
  85. package/dist/async-queuer/useAsyncQueuer.cjs.map +0 -1
  86. package/dist/async-queuer/useAsyncQueuer.d.cts +0 -223
  87. package/dist/async-queuer/useAsyncQueuer.js.map +0 -1
  88. package/dist/async-rate-limiter/index.cjs +0 -13
  89. package/dist/async-rate-limiter/index.d.cts +0 -4
  90. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs +0 -65
  91. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +0 -1
  92. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +0 -60
  93. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +0 -1
  94. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +0 -209
  95. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +0 -1
  96. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +0 -219
  97. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +0 -1
  98. package/dist/async-retryer/index.cjs +0 -8
  99. package/dist/async-retryer/index.d.cts +0 -1
  100. package/dist/async-throttler/index.cjs +0 -13
  101. package/dist/async-throttler/index.d.cts +0 -4
  102. package/dist/async-throttler/useAsyncThrottledCallback.cjs +0 -49
  103. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +0 -1
  104. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +0 -44
  105. package/dist/async-throttler/useAsyncThrottledCallback.js.map +0 -1
  106. package/dist/async-throttler/useAsyncThrottler.cjs +0 -206
  107. package/dist/async-throttler/useAsyncThrottler.cjs.map +0 -1
  108. package/dist/async-throttler/useAsyncThrottler.d.cts +0 -213
  109. package/dist/async-throttler/useAsyncThrottler.js.map +0 -1
  110. package/dist/batcher/index.cjs +0 -13
  111. package/dist/batcher/index.d.cts +0 -4
  112. package/dist/batcher/useBatchedCallback.cjs +0 -47
  113. package/dist/batcher/useBatchedCallback.cjs.map +0 -1
  114. package/dist/batcher/useBatchedCallback.d.cts +0 -41
  115. package/dist/batcher/useBatchedCallback.js.map +0 -1
  116. package/dist/batcher/useBatcher.cjs +0 -165
  117. package/dist/batcher/useBatcher.cjs.map +0 -1
  118. package/dist/batcher/useBatcher.d.cts +0 -174
  119. package/dist/batcher/useBatcher.js.map +0 -1
  120. package/dist/debouncer/index.cjs +0 -17
  121. package/dist/debouncer/index.d.cts +0 -6
  122. package/dist/debouncer/useDebouncedCallback.cjs +0 -48
  123. package/dist/debouncer/useDebouncedCallback.cjs.map +0 -1
  124. package/dist/debouncer/useDebouncedCallback.d.cts +0 -43
  125. package/dist/debouncer/useDebouncedCallback.js.map +0 -1
  126. package/dist/debouncer/useDebouncedState.cjs +0 -89
  127. package/dist/debouncer/useDebouncedState.cjs.map +0 -1
  128. package/dist/debouncer/useDebouncedState.d.cts +0 -80
  129. package/dist/debouncer/useDebouncedState.js.map +0 -1
  130. package/dist/debouncer/useDebouncedValue.cjs +0 -96
  131. package/dist/debouncer/useDebouncedValue.cjs.map +0 -1
  132. package/dist/debouncer/useDebouncedValue.d.cts +0 -89
  133. package/dist/debouncer/useDebouncedValue.js.map +0 -1
  134. package/dist/debouncer/useDebouncer.cjs +0 -141
  135. package/dist/debouncer/useDebouncer.cjs.map +0 -1
  136. package/dist/debouncer/useDebouncer.d.cts +0 -151
  137. package/dist/debouncer/useDebouncer.js.map +0 -1
  138. package/dist/index.cjs +0 -67
  139. package/dist/index.d.cts +0 -30
  140. package/dist/provider/PacerProvider.cjs +0 -26
  141. package/dist/provider/PacerProvider.cjs.map +0 -1
  142. package/dist/provider/PacerProvider.d.cts +0 -28
  143. package/dist/provider/PacerProvider.js.map +0 -1
  144. package/dist/provider/index.cjs +0 -6
  145. package/dist/provider/index.d.cts +0 -2
  146. package/dist/queuer/index.cjs +0 -15
  147. package/dist/queuer/index.d.cts +0 -5
  148. package/dist/queuer/useQueuedState.cjs +0 -129
  149. package/dist/queuer/useQueuedState.cjs.map +0 -1
  150. package/dist/queuer/useQueuedState.d.cts +0 -121
  151. package/dist/queuer/useQueuedState.js.map +0 -1
  152. package/dist/queuer/useQueuedValue.cjs +0 -115
  153. package/dist/queuer/useQueuedValue.cjs.map +0 -1
  154. package/dist/queuer/useQueuedValue.d.cts +0 -104
  155. package/dist/queuer/useQueuedValue.js.map +0 -1
  156. package/dist/queuer/useQueuer.cjs +0 -176
  157. package/dist/queuer/useQueuer.cjs.map +0 -1
  158. package/dist/queuer/useQueuer.d.cts +0 -185
  159. package/dist/queuer/useQueuer.js.map +0 -1
  160. package/dist/rate-limiter/index.cjs +0 -17
  161. package/dist/rate-limiter/index.d.cts +0 -6
  162. package/dist/rate-limiter/useRateLimitedCallback.cjs +0 -65
  163. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +0 -1
  164. package/dist/rate-limiter/useRateLimitedCallback.d.cts +0 -60
  165. package/dist/rate-limiter/useRateLimitedCallback.js.map +0 -1
  166. package/dist/rate-limiter/useRateLimitedState.cjs +0 -115
  167. package/dist/rate-limiter/useRateLimitedState.cjs.map +0 -1
  168. package/dist/rate-limiter/useRateLimitedState.d.cts +0 -106
  169. package/dist/rate-limiter/useRateLimitedState.js.map +0 -1
  170. package/dist/rate-limiter/useRateLimitedValue.cjs +0 -102
  171. package/dist/rate-limiter/useRateLimitedValue.cjs.map +0 -1
  172. package/dist/rate-limiter/useRateLimitedValue.d.cts +0 -95
  173. package/dist/rate-limiter/useRateLimitedValue.js.map +0 -1
  174. package/dist/rate-limiter/useRateLimiter.cjs +0 -167
  175. package/dist/rate-limiter/useRateLimiter.cjs.map +0 -1
  176. package/dist/rate-limiter/useRateLimiter.d.cts +0 -178
  177. package/dist/rate-limiter/useRateLimiter.js.map +0 -1
  178. package/dist/throttler/index.cjs +0 -17
  179. package/dist/throttler/index.d.cts +0 -6
  180. package/dist/throttler/useThrottledCallback.cjs +0 -49
  181. package/dist/throttler/useThrottledCallback.cjs.map +0 -1
  182. package/dist/throttler/useThrottledCallback.d.cts +0 -44
  183. package/dist/throttler/useThrottledCallback.js.map +0 -1
  184. package/dist/throttler/useThrottledState.cjs +0 -100
  185. package/dist/throttler/useThrottledState.cjs.map +0 -1
  186. package/dist/throttler/useThrottledState.d.cts +0 -91
  187. package/dist/throttler/useThrottledState.js.map +0 -1
  188. package/dist/throttler/useThrottledValue.cjs +0 -91
  189. package/dist/throttler/useThrottledValue.cjs.map +0 -1
  190. package/dist/throttler/useThrottledValue.d.cts +0 -84
  191. package/dist/throttler/useThrottledValue.js.map +0 -1
  192. package/dist/throttler/useThrottler.cjs +0 -146
  193. package/dist/throttler/useThrottler.cjs.map +0 -1
  194. package/dist/throttler/useThrottler.d.cts +0 -156
  195. package/dist/throttler/useThrottler.js.map +0 -1
  196. package/dist/types/index.cjs +0 -8
  197. package/dist/types/index.d.cts +0 -1
  198. package/dist/utils/index.cjs +0 -8
  199. package/dist/utils/index.d.cts +0 -1
  200. package/src/async-batcher/index.ts +0 -4
  201. package/src/async-batcher/useAsyncBatchedCallback.ts +0 -53
  202. package/src/async-batcher/useAsyncBatcher.ts +0 -293
  203. package/src/async-debouncer/index.ts +0 -5
  204. package/src/async-debouncer/useAsyncDebouncedCallback.ts +0 -55
  205. package/src/async-debouncer/useAsyncDebouncer.ts +0 -274
  206. package/src/async-queuer/index.ts +0 -4
  207. package/src/async-queuer/useAsyncQueuedState.ts +0 -165
  208. package/src/async-queuer/useAsyncQueuer.ts +0 -293
  209. package/src/async-rate-limiter/index.ts +0 -5
  210. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +0 -68
  211. package/src/async-rate-limiter/useAsyncRateLimiter.ts +0 -294
  212. package/src/async-retryer/index.ts +0 -2
  213. package/src/async-throttler/index.ts +0 -5
  214. package/src/async-throttler/useAsyncThrottledCallback.ts +0 -52
  215. package/src/async-throttler/useAsyncThrottler.ts +0 -285
  216. package/src/batcher/index.ts +0 -4
  217. package/src/batcher/useBatchedCallback.ts +0 -46
  218. package/src/batcher/useBatcher.ts +0 -241
  219. package/src/debouncer/index.ts +0 -7
  220. package/src/debouncer/useDebouncedCallback.ts +0 -51
  221. package/src/debouncer/useDebouncedState.ts +0 -106
  222. package/src/debouncer/useDebouncedValue.ts +0 -109
  223. package/src/debouncer/useDebouncer.ts +0 -219
  224. package/src/index.ts +0 -56
  225. package/src/provider/PacerProvider.tsx +0 -70
  226. package/src/provider/index.ts +0 -1
  227. package/src/queuer/index.ts +0 -5
  228. package/src/queuer/useQueuedState.ts +0 -133
  229. package/src/queuer/useQueuedValue.ts +0 -129
  230. package/src/queuer/useQueuer.ts +0 -251
  231. package/src/rate-limiter/index.ts +0 -6
  232. package/src/rate-limiter/useRateLimitedCallback.ts +0 -68
  233. package/src/rate-limiter/useRateLimitedState.ts +0 -124
  234. package/src/rate-limiter/useRateLimitedValue.ts +0 -110
  235. package/src/rate-limiter/useRateLimiter.ts +0 -244
  236. package/src/throttler/index.ts +0 -7
  237. package/src/throttler/useThrottledCallback.ts +0 -52
  238. package/src/throttler/useThrottledState.ts +0 -118
  239. package/src/throttler/useThrottledValue.ts +0 -104
  240. package/src/throttler/useThrottler.ts +0 -224
  241. package/src/types/index.ts +0 -1
  242. package/src/utils/index.ts +0 -1
@@ -1,52 +0,0 @@
1
- import { useCallback } from 'preact/hooks'
2
- import { useAsyncThrottler } from './useAsyncThrottler'
3
- import type { PreactAsyncThrottlerOptions } from './useAsyncThrottler'
4
- import type { AnyAsyncFunction } from '@tanstack/pacer/types'
5
-
6
- /**
7
- * A Preact hook that creates a throttled version of an async callback function.
8
- * This hook is a convenient wrapper around the `useAsyncThrottler` hook,
9
- * providing a stable, throttled async function reference for use in Preact components.
10
- *
11
- * The throttled async function will execute at most once within the specified wait time period,
12
- * regardless of how many times it is called. Calls made during the wait period reschedule a
13
- * single trailing execution with the latest arguments when `trailing` is enabled (the default).
14
- * The most recent call's promise resolves or rejects with the trailing execution's result;
15
- * each earlier call's promise resolves immediately with the most recent previous result (or
16
- * `undefined` if nothing has executed yet), as does every call when the throttler is disabled.
17
- *
18
- * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
19
- * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
20
- *
21
- * For advanced usage requiring features like:
22
- * - Manual cancellation
23
- * - Access to execution/error state
24
- * - Custom useCallback dependencies
25
- *
26
- * Consider using the `useAsyncThrottler` hook instead.
27
- *
28
- *
29
- * @example
30
- * ```tsx
31
- * // Throttle an async API call
32
- * const handleApiCall = useAsyncThrottledCallback(async (data) => {
33
- * const result = await sendDataToServer(data);
34
- * return result;
35
- * }, {
36
- * wait: 200 // Execute at most once every 200ms
37
- * });
38
- *
39
- * // Use in an event handler
40
- * <button onClick={() => handleApiCall(formData)}>Send</button>
41
- * ```
42
- */
43
- export function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(
44
- fn: TFn,
45
- options: PreactAsyncThrottlerOptions<TFn, {}>,
46
- ): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {
47
- const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute
48
- return useCallback(
49
- (...args: Parameters<TFn>) => asyncThrottledFn(...args),
50
- [asyncThrottledFn],
51
- )
52
- }
@@ -1,285 +0,0 @@
1
- import { useEffect, useMemo, useState } from 'preact/hooks'
2
- import { AsyncThrottler } from '@tanstack/pacer/async-throttler'
3
- import { shallow, useSelector } from '@tanstack/preact-store'
4
- import { useDefaultPacerOptions } from '../provider/PacerProvider'
5
- import type { Store } from '@tanstack/preact-store'
6
- import type { AnyAsyncFunction } from '@tanstack/pacer/types'
7
- import type {
8
- AsyncThrottlerOptions,
9
- AsyncThrottlerState,
10
- } from '@tanstack/pacer/async-throttler'
11
- import type { ComponentChildren } from 'preact'
12
-
13
- export interface PreactAsyncThrottlerOptions<
14
- TFn extends AnyAsyncFunction,
15
- TSelected = {},
16
- > extends AsyncThrottlerOptions<TFn> {
17
- /**
18
- * Optional callback invoked when the component unmounts. Receives the throttler instance.
19
- * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
20
- */
21
- onUnmount?: (throttler: PreactAsyncThrottler<TFn, TSelected>) => void
22
- }
23
-
24
- export interface PreactAsyncThrottler<
25
- TFn extends AnyAsyncFunction,
26
- TSelected = {},
27
- > extends Omit<AsyncThrottler<TFn>, 'store'> {
28
- /**
29
- * A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state.
30
- *
31
- * This is useful for opting into state re-renders for specific parts of the throttler state
32
- * deep in your component tree without needing to pass a selector to the hook.
33
- *
34
- * @example
35
- * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
36
- * {({ isPending }) => (
37
- * <div>{isPending ? 'Loading...' : 'Ready'}</div>
38
- * )}
39
- * </throttler.Subscribe>
40
- */
41
- Subscribe: <TSelected>(props: {
42
- selector: (state: AsyncThrottlerState<TFn>) => TSelected
43
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren
44
- }) => ComponentChildren
45
- /**
46
- * Reactive state that will be updated and re-rendered when the throttler state changes
47
- *
48
- * Use this instead of `throttler.store.state`
49
- */
50
- readonly state: Readonly<TSelected>
51
- /**
52
- * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
53
- * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
54
- * Although, you can make the state reactive by using the `useSelector` in your own usage.
55
- */
56
- readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>
57
- }
58
-
59
- /**
60
- * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
61
- *
62
- * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
63
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
64
- *
65
- * Async throttling ensures an async function executes at most once within a specified time window,
66
- * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,
67
- * database operations, or other async tasks.
68
- *
69
- * Unlike the non-async Throttler, this async version supports returning values from the throttled function,
70
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
71
- * instead of setting the result on a state variable from within the throttled function.
72
- *
73
- * Error Handling:
74
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
75
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
76
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
77
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
78
- * - The error state can be checked using the underlying AsyncThrottler instance
79
- *
80
- * ## State Management and Selector
81
- *
82
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
83
- * in two ways:
84
- *
85
- * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
86
- *
87
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
88
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
89
- * in child components.
90
- *
91
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
92
- *
93
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
94
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
95
- * state changes occur.
96
- *
97
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
98
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
99
- * re-renders and gives you full control over when your component updates.
100
- *
101
- * Available state properties:
102
- * - `errorCount`: Number of function executions that have resulted in errors
103
- * - `isExecuting`: Whether the throttled function is currently executing asynchronously
104
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
105
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
106
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
107
- * - `lastResult`: The result from the most recent successful function execution
108
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
109
- * - `settleCount`: Number of function executions that have completed (success or error)
110
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
111
- * - `successCount`: Number of function executions that have completed successfully
112
- *
113
- * ## Unmount behavior
114
- *
115
- * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
116
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
117
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
118
- *
119
- * ```tsx
120
- * const throttler = useAsyncThrottler(fn, {
121
- * wait: 1000,
122
- * onUnmount: (t) => t.flush()
123
- * });
124
- * ```
125
- *
126
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
127
- * If your throttled function updates Preact state, those updates may run after the component has
128
- * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
129
- * accordingly when using onUnmount with flush.
130
- *
131
- * @example
132
- * ```tsx
133
- * // Default behavior - no reactive state subscriptions
134
- * const asyncThrottler = useAsyncThrottler(
135
- * async (id: string) => {
136
- * const data = await api.fetchData(id);
137
- * return data; // Return value is preserved
138
- * },
139
- * { wait: 1000 }
140
- * );
141
- *
142
- * // Subscribe to state changes deep in component tree using Subscribe HOC
143
- * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
144
- * {({ isPending }) => (
145
- * <div>{isPending ? 'Processing...' : 'Ready'}</div>
146
- * )}
147
- * </asyncThrottler.Subscribe>
148
- *
149
- * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
150
- * const asyncThrottler = useAsyncThrottler(
151
- * async (id: string) => {
152
- * const data = await api.fetchData(id);
153
- * return data;
154
- * },
155
- * { wait: 1000 },
156
- * (state) => ({
157
- * isExecuting: state.isExecuting,
158
- * isPending: state.isPending,
159
- * status: state.status
160
- * })
161
- * );
162
- *
163
- * // Opt-in to re-render when results are available (optimized for data display)
164
- * const asyncThrottler = useAsyncThrottler(
165
- * async (id: string) => {
166
- * const data = await api.fetchData(id);
167
- * return data;
168
- * },
169
- * { wait: 1000 },
170
- * (state) => ({
171
- * lastResult: state.lastResult,
172
- * successCount: state.successCount,
173
- * settleCount: state.settleCount
174
- * })
175
- * );
176
- *
177
- * // Opt-in to re-render when error state changes (optimized for error handling)
178
- * const asyncThrottler = useAsyncThrottler(
179
- * async (id: string) => {
180
- * const data = await api.fetchData(id);
181
- * return data;
182
- * },
183
- * {
184
- * wait: 1000,
185
- * onError: (error) => console.error('API call failed:', error)
186
- * },
187
- * (state) => ({
188
- * errorCount: state.errorCount,
189
- * status: state.status
190
- * })
191
- * );
192
- *
193
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
194
- * const asyncThrottler = useAsyncThrottler(
195
- * async (id: string) => {
196
- * const data = await api.fetchData(id);
197
- * return data;
198
- * },
199
- * { wait: 1000 },
200
- * (state) => ({
201
- * lastExecutionTime: state.lastExecutionTime,
202
- * nextExecutionTime: state.nextExecutionTime
203
- * })
204
- * );
205
- *
206
- * // With state management and return value
207
- * const [data, setData] = useState(null);
208
- * const { maybeExecute, state } = useAsyncThrottler(
209
- * async (query) => {
210
- * const result = await searchAPI(query);
211
- * setData(result);
212
- * return result; // Return value can be used by the caller
213
- * },
214
- * {
215
- * wait: 2000,
216
- * leading: true, // Execute immediately on first call
217
- * trailing: false // Skip trailing edge updates
218
- * }
219
- * );
220
- *
221
- * // Access the selected state (will be empty object {} unless selector provided)
222
- * const { isExecuting, lastResult } = state;
223
- * ```
224
- */
225
- export function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(
226
- fn: TFn,
227
- options: PreactAsyncThrottlerOptions<TFn, TSelected>,
228
- selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>
229
- ({}) as TSelected,
230
- ): PreactAsyncThrottler<TFn, TSelected> {
231
- const mergedOptions = {
232
- ...useDefaultPacerOptions().asyncThrottler,
233
- ...options,
234
- } as PreactAsyncThrottlerOptions<TFn, TSelected>
235
- const [asyncThrottler] = useState(() => {
236
- const throttlerInstance = new AsyncThrottler<TFn>(
237
- fn,
238
- mergedOptions,
239
- ) as unknown as PreactAsyncThrottler<TFn, TSelected>
240
-
241
- throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {
242
- selector: (state: AsyncThrottlerState<TFn>) => TSelected
243
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren
244
- }) {
245
- const selected = useSelector(throttlerInstance.store, props.selector, {
246
- compare: shallow,
247
- })
248
-
249
- return typeof props.children === 'function'
250
- ? props.children(selected)
251
- : props.children
252
- }
253
-
254
- return throttlerInstance
255
- })
256
-
257
- asyncThrottler.fn = fn
258
- asyncThrottler.setOptions(mergedOptions)
259
-
260
- const state = useSelector(asyncThrottler.store, selector, {
261
- compare: shallow,
262
- })
263
-
264
- /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
265
- useEffect(() => {
266
- return () => {
267
- if (mergedOptions.onUnmount) {
268
- mergedOptions.onUnmount(asyncThrottler)
269
- } else {
270
- asyncThrottler.cancel()
271
- asyncThrottler.abort()
272
- }
273
- }
274
- }, [])
275
- /* eslint-enable react-hooks/exhaustive-deps */
276
-
277
- return useMemo(
278
- () =>
279
- ({
280
- ...asyncThrottler,
281
- state,
282
- }) as PreactAsyncThrottler<TFn, TSelected>, // omit `store` in favor of `state`
283
- [asyncThrottler, state],
284
- )
285
- }
@@ -1,4 +0,0 @@
1
- export * from '@tanstack/pacer/batcher'
2
-
3
- export * from './useBatcher'
4
- export * from './useBatchedCallback'
@@ -1,46 +0,0 @@
1
- import { useCallback } from 'preact/hooks'
2
- import { useBatcher } from './useBatcher'
3
- import type { PreactBatcherOptions } from './useBatcher'
4
-
5
- /**
6
- * A Preact hook that creates a batched version of a callback function.
7
- * This hook is essentially a wrapper around the basic `batch` function
8
- * that is exported from `@tanstack/pacer`,
9
- * but optimized for Preact with reactive options and a stable function reference.
10
- *
11
- * The batched function will collect individual calls into batches and execute them
12
- * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
13
- *
14
- * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
15
- * batching needs. However, it does not expose the underlying Batcher instance.
16
- *
17
- * For advanced usage requiring features like:
18
- * - Manual batch execution
19
- * - Access to batch state and metrics
20
- * - Custom useCallback dependencies
21
- *
22
- * Consider using the `useBatcher` hook instead.
23
- *
24
- * @example
25
- * ```tsx
26
- * // Batch analytics events
27
- * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
28
- * sendAnalytics(events);
29
- * }, {
30
- * maxSize: 5, // Process when 5 events collected
31
- * wait: 2000 // Or after 2 seconds
32
- * });
33
- *
34
- * // Use in event handlers
35
- * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
36
- * Click me
37
- * </button>
38
- * ```
39
- */
40
- export function useBatchedCallback<TValue>(
41
- fn: (items: Array<TValue>) => void,
42
- options: PreactBatcherOptions<TValue, {}>,
43
- ): (item: TValue) => void {
44
- const batchedFn = useBatcher(fn, options).addItem
45
- return useCallback((item: TValue) => batchedFn(item), [batchedFn])
46
- }
@@ -1,241 +0,0 @@
1
- import { useEffect, useMemo, useState } from 'preact/hooks'
2
- import { Batcher } from '@tanstack/pacer/batcher'
3
- import { shallow, useSelector } from '@tanstack/preact-store'
4
- import { useDefaultPacerOptions } from '../provider/PacerProvider'
5
- import type { Store } from '@tanstack/preact-store'
6
- import type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'
7
- import type { ComponentChildren } from 'preact'
8
-
9
- export interface PreactBatcherOptions<
10
- TValue,
11
- TSelected = {},
12
- > extends BatcherOptions<TValue> {
13
- /**
14
- * Optional callback invoked when the component unmounts. Receives the batcher instance.
15
- * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
16
- */
17
- onUnmount?: (batcher: PreactBatcher<TValue, TSelected>) => void
18
- }
19
-
20
- export interface PreactBatcher<TValue, TSelected = {}> extends Omit<
21
- Batcher<TValue>,
22
- 'store'
23
- > {
24
- /**
25
- * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
26
- *
27
- * This is useful for opting into state re-renders for specific parts of the batcher state
28
- * deep in your component tree without needing to pass a selector to the hook.
29
- *
30
- * @example
31
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
32
- * {({ size }) => (
33
- * <div>Batch Size: {size}</div>
34
- * )}
35
- * </batcher.Subscribe>
36
- */
37
- Subscribe: <TSelected>(props: {
38
- selector: (state: BatcherState<TValue>) => TSelected
39
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren
40
- }) => ComponentChildren
41
- /**
42
- * Reactive state that will be updated and re-rendered when the batcher state changes
43
- *
44
- * Use this instead of `batcher.store.state`
45
- */
46
- readonly state: Readonly<TSelected>
47
- /**
48
- * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
49
- * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
50
- * Although, you can make the state reactive by using the `useSelector` in your own usage.
51
- */
52
- readonly store: Store<Readonly<BatcherState<TValue>>>
53
- }
54
-
55
- /**
56
- * A Preact hook that creates and manages a Batcher instance.
57
- *
58
- * This is a lower-level hook that provides direct access to the Batcher's functionality without
59
- * any built-in state management. This allows you to integrate it with any state management solution
60
- * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
61
- *
62
- * The Batcher collects items and processes them in batches based on configurable conditions:
63
- * - Maximum batch size
64
- * - Time-based batching (process after X milliseconds)
65
- * - Custom batch processing logic via getShouldExecute
66
- *
67
- * ## State Management and Selector
68
- *
69
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
70
- * in two ways:
71
- *
72
- * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
73
- *
74
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
75
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
76
- * in child components.
77
- *
78
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
79
- *
80
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
81
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
82
- * state changes occur.
83
- *
84
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
85
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
86
- * re-renders and gives you full control over when your component updates.
87
- *
88
- * Available state properties:
89
- * - `executionCount`: Number of batch executions that have been completed
90
- * - `isEmpty`: Whether the batcher has no items to process
91
- * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
92
- * - `isRunning`: Whether the batcher is active and will process items automatically
93
- * - `items`: Array of items currently queued for batch processing
94
- * - `size`: Number of items currently in the batch queue
95
- * - `status`: Current processing status ('idle' | 'pending')
96
- * - `totalItemsProcessed`: Total number of items processed across all batches
97
- *
98
- * ## Unmount behavior
99
- *
100
- * By default, the hook cancels any pending batch when the component unmounts.
101
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
102
- *
103
- * ```tsx
104
- * const batcher = useBatcher(fn, {
105
- * maxSize: 10,
106
- * wait: 2000,
107
- * onUnmount: (b) => b.flush()
108
- * });
109
- * ```
110
- *
111
- * @example
112
- * ```tsx
113
- * // Default behavior - no reactive state subscriptions
114
- * const batcher = useBatcher<number>(
115
- * (items) => console.log('Processing batch:', items),
116
- * { maxSize: 5, wait: 2000 }
117
- * );
118
- *
119
- * // Subscribe to state changes deep in component tree using Subscribe HOC
120
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
121
- * {({ size }) => (
122
- * <div>Batch Size: {size}</div>
123
- * )}
124
- * </batcher.Subscribe>
125
- *
126
- * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
127
- * const batcher = useBatcher<number>(
128
- * (items) => console.log('Processing batch:', items),
129
- * { maxSize: 5, wait: 2000 },
130
- * (state) => ({
131
- * size: state.size,
132
- * isEmpty: state.isEmpty
133
- * })
134
- * );
135
- *
136
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
137
- * const batcher = useBatcher<number>(
138
- * (items) => console.log('Processing batch:', items),
139
- * { maxSize: 5, wait: 2000 },
140
- * (state) => ({
141
- * executionCount: state.executionCount,
142
- * totalItemsProcessed: state.totalItemsProcessed
143
- * })
144
- * );
145
- *
146
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
147
- * const batcher = useBatcher<number>(
148
- * (items) => console.log('Processing batch:', items),
149
- * { maxSize: 5, wait: 2000 },
150
- * (state) => ({
151
- * isPending: state.isPending,
152
- * isRunning: state.isRunning,
153
- * status: state.status
154
- * })
155
- * );
156
- *
157
- * // Example with custom state management and batching
158
- * const [items, setItems] = useState([]);
159
- *
160
- * const batcher = useBatcher<number>(
161
- * (items) => console.log('Processing batch:', items),
162
- * {
163
- * maxSize: 5,
164
- * wait: 2000,
165
- * onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
166
- * getShouldExecute: (items) => items.length >= 3
167
- * }
168
- * );
169
- *
170
- * // Add items to batch - they'll be processed when conditions are met
171
- * batcher.addItem(1);
172
- * batcher.addItem(2);
173
- * batcher.addItem(3); // Triggers batch processing
174
- *
175
- * // Control the batcher
176
- * batcher.stop(); // Pause batching
177
- * batcher.start(); // Resume batching
178
- *
179
- * // Access the selected state (will be empty object {} unless selector provided)
180
- * const { size, isPending } = batcher.state;
181
- * ```
182
- */
183
- export function useBatcher<TValue, TSelected = {}>(
184
- fn: (items: Array<TValue>) => void,
185
- options: PreactBatcherOptions<TValue, TSelected> = {},
186
- selector: (state: BatcherState<TValue>) => TSelected = () =>
187
- ({}) as TSelected,
188
- ): PreactBatcher<TValue, TSelected> {
189
- const mergedOptions = {
190
- ...useDefaultPacerOptions().batcher,
191
- ...options,
192
- } as PreactBatcherOptions<TValue, TSelected>
193
-
194
- const [batcher] = useState(() => {
195
- const batcherInstance = new Batcher<TValue>(
196
- fn,
197
- mergedOptions,
198
- ) as unknown as PreactBatcher<TValue, TSelected>
199
-
200
- batcherInstance.Subscribe = function Subscribe<TSelected>(props: {
201
- selector: (state: BatcherState<TValue>) => TSelected
202
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren
203
- }) {
204
- const selected = useSelector(batcherInstance.store, props.selector, {
205
- compare: shallow,
206
- })
207
-
208
- return typeof props.children === 'function'
209
- ? props.children(selected)
210
- : props.children
211
- }
212
-
213
- return batcherInstance
214
- })
215
-
216
- batcher.fn = fn
217
- batcher.setOptions(mergedOptions)
218
-
219
- /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
220
- useEffect(() => {
221
- return () => {
222
- if (mergedOptions.onUnmount) {
223
- mergedOptions.onUnmount(batcher)
224
- } else {
225
- batcher.cancel()
226
- }
227
- }
228
- }, [])
229
- /* eslint-enable react-hooks/exhaustive-deps */
230
-
231
- const state = useSelector(batcher.store, selector, { compare: shallow })
232
-
233
- return useMemo(
234
- () =>
235
- ({
236
- ...batcher,
237
- state,
238
- }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`
239
- [batcher, state],
240
- )
241
- }
@@ -1,7 +0,0 @@
1
- // re-export everything from the core pacer package, BUT ONLY from the debouncer module
2
- export * from '@tanstack/pacer/debouncer'
3
-
4
- export * from './useDebouncedCallback'
5
- export * from './useDebouncedState'
6
- export * from './useDebouncedValue'
7
- export * from './useDebouncer'
@@ -1,51 +0,0 @@
1
- import { useCallback } from 'preact/hooks'
2
- import { useDebouncer } from './useDebouncer'
3
- import type { PreactDebouncerOptions } from './useDebouncer'
4
- import type { AnyFunction } from '@tanstack/pacer/types'
5
-
6
- /**
7
- * A Preact hook that creates a debounced version of a callback function.
8
- * This hook is essentially a wrapper around the basic `debounce` function
9
- * that is exported from `@tanstack/pacer`,
10
- * but optimized for Preact with reactive options and a stable function reference.
11
- *
12
- * The debounced function will only execute after the specified wait time has elapsed
13
- * since its last invocation. If called again before the wait time expires, the timer
14
- * resets and starts waiting again.
15
- *
16
- * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
17
- * debouncing needs. However, it does not expose the underlying Debouncer instance.
18
- *
19
- * For advanced usage requiring features like:
20
- * - Manual cancellation
21
- * - Access to execution counts
22
- * - Custom useCallback dependencies
23
- *
24
- * Consider using the `useDebouncer` hook instead.
25
- *
26
- * @example
27
- * ```tsx
28
- * // Debounce a search handler
29
- * const handleSearch = useDebouncedCallback((query: string) => {
30
- * fetchSearchResults(query);
31
- * }, {
32
- * wait: 500 // Wait 500ms between executions
33
- * });
34
- *
35
- * // Use in an input
36
- * <input
37
- * type="search"
38
- * onChange={(e) => handleSearch(e.target.value)}
39
- * />
40
- * ```
41
- */
42
- export function useDebouncedCallback<TFn extends AnyFunction>(
43
- fn: TFn,
44
- options: PreactDebouncerOptions<TFn, {}>,
45
- ): (...args: Parameters<TFn>) => void {
46
- const debouncedFn = useDebouncer(fn, options).maybeExecute
47
- return useCallback(
48
- (...args: Parameters<TFn>) => debouncedFn(...args),
49
- [debouncedFn],
50
- )
51
- }