@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,151 +0,0 @@
1
- import { Store } from "@tanstack/preact-store";
2
- import { ComponentChildren } from "preact";
3
- import { AnyFunction } from "@tanstack/pacer/types";
4
- import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
5
- //#region src/debouncer/useDebouncer.d.ts
6
- interface PreactDebouncerOptions<TFn extends AnyFunction, TSelected = {}> extends DebouncerOptions<TFn> {
7
- /**
8
- * Optional callback invoked when the component unmounts. Receives the debouncer instance.
9
- * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
10
- */
11
- onUnmount?: (debouncer: PreactDebouncer<TFn, TSelected>) => void;
12
- }
13
- interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
14
- /**
15
- * A Preact HOC (Higher Order Component) that allows you to subscribe to the debouncer state.
16
- *
17
- * This is useful for opting into state re-renders for specific parts of the debouncer state
18
- * deep in your component tree without needing to pass a selector to the hook.
19
- *
20
- * @example
21
- * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
22
- * {({ isPending }) => (
23
- * <div>{isPending ? 'Loading...' : 'Ready'}</div>
24
- * )}
25
- * </debouncer.Subscribe>
26
- */
27
- Subscribe: <TSelected>(props: {
28
- selector: (state: DebouncerState<TFn>) => TSelected;
29
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
30
- }) => ComponentChildren;
31
- /**
32
- * Reactive state that will be updated and re-rendered when the debouncer state changes
33
- *
34
- * Use this instead of `debouncer.store.state`
35
- */
36
- readonly state: Readonly<TSelected>;
37
- /**
38
- * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
39
- * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
40
- * Although, you can make the state reactive by using the `useSelector` in your own usage.
41
- */
42
- readonly store: Store<Readonly<DebouncerState<TFn>>>;
43
- }
44
- /**
45
- * A Preact hook that creates and manages a Debouncer instance.
46
- *
47
- * This is a lower-level hook that provides direct access to the Debouncer's functionality without
48
- * any built-in state management. This allows you to integrate it with any state management solution
49
- * you prefer (useState, Redux, Zustand, etc.).
50
- *
51
- * This hook provides debouncing functionality to limit how often a function can be called,
52
- * waiting for a specified delay before executing the latest call. This is useful for handling
53
- * frequent events like window resizing, scroll events, or real-time search inputs.
54
- *
55
- * The debouncer will only execute the function after the specified wait time has elapsed
56
- * since the last call. If the function is called again before the wait time expires, the
57
- * timer resets and starts waiting again.
58
- *
59
- * ## State Management and Selector
60
- *
61
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
62
- * in two ways:
63
- *
64
- * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**
65
- *
66
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
67
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
68
- * in child components.
69
- *
70
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
71
- *
72
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
73
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
74
- * state changes occur.
75
- *
76
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
77
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
78
- * re-renders and gives you full control over when your component updates.
79
- *
80
- * Available state properties:
81
- * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
82
- * - `executionCount`: Number of function executions that have been completed
83
- * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
84
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
85
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
86
- *
87
- * ## Unmount behavior
88
- *
89
- * By default, the hook cancels any pending execution when the component unmounts.
90
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
91
- *
92
- * ```tsx
93
- * const debouncer = useDebouncer(fn, {
94
- * wait: 500,
95
- * onUnmount: (d) => d.flush()
96
- * });
97
- * ```
98
- *
99
- * @example
100
- * ```tsx
101
- * // Default behavior - no reactive state subscriptions
102
- * const searchDebouncer = useDebouncer(
103
- * (query: string) => fetchSearchResults(query),
104
- * { wait: 500 }
105
- * );
106
- *
107
- * // Subscribe to state changes deep in component tree using Subscribe HOC
108
- * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
109
- * {({ isPending }) => (
110
- * <div>{isPending ? 'Searching...' : 'Ready'}</div>
111
- * )}
112
- * </searchDebouncer.Subscribe>
113
- *
114
- * // Opt-in to re-render when isPending changes at hook level (optimized for loading states)
115
- * const searchDebouncer = useDebouncer(
116
- * (query: string) => fetchSearchResults(query),
117
- * { wait: 500 },
118
- * (state) => ({ isPending: state.isPending })
119
- * );
120
- *
121
- * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
122
- * const searchDebouncer = useDebouncer(
123
- * (query: string) => fetchSearchResults(query),
124
- * { wait: 500 },
125
- * (state) => ({ executionCount: state.executionCount })
126
- * );
127
- *
128
- * // Multiple state properties - re-render when any of these change
129
- * const searchDebouncer = useDebouncer(
130
- * (query: string) => fetchSearchResults(query),
131
- * { wait: 500 },
132
- * (state) => ({
133
- * isPending: state.isPending,
134
- * executionCount: state.executionCount,
135
- * status: state.status
136
- * })
137
- * );
138
- *
139
- * // In an event handler
140
- * const handleChange = (e) => {
141
- * searchDebouncer.maybeExecute(e.target.value);
142
- * };
143
- *
144
- * // Access the selected state (will be empty object {} unless selector provided)
145
- * const { isPending } = searchDebouncer.state;
146
- * ```
147
- */
148
- declare function useDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: PreactDebouncerOptions<TFn, TSelected>, selector?: (state: DebouncerState<TFn>) => TSelected): PreactDebouncer<TFn, TSelected>;
149
- //#endregion
150
- export { PreactDebouncer, PreactDebouncerOptions, useDebouncer };
151
- //# sourceMappingURL=useDebouncer.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useDebouncer.js","names":[],"sources":["../../src/debouncer/useDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n DebouncerOptions,\n DebouncerState,\n} from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactDebouncerOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends DebouncerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the debouncer instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (debouncer: PreactDebouncer<TFn, TSelected>) => void\n}\n\nexport interface PreactDebouncer<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the debouncer state.\n *\n * This is useful for opting into state re-renders for specific parts of the debouncer state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </debouncer.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: DebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<DebouncerState<TFn>>>\n}\n\n/**\n * A Preact hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.).\n *\n * This hook provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `debouncer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const debouncer = useDebouncer(fn, {\n * wait: 500,\n * onUnmount: (d) => d.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Searching...' : 'Ready'}</div>\n * )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when isPending changes at hook level (optimized for loading states)\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const searchDebouncer = useDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({\n * isPending: state.isPending,\n * executionCount: state.executionCount,\n * status: state.status\n * })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n * searchDebouncer.maybeExecute(e.target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = searchDebouncer.state;\n * ```\n */\nexport function useDebouncer<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: PreactDebouncerOptions<TFn, TSelected>,\n selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().debouncer,\n ...options,\n } as PreactDebouncerOptions<TFn, TSelected>\n const [debouncer] = useState(() => {\n const debouncerInstance = new Debouncer(\n fn,\n mergedOptions,\n ) as unknown as PreactDebouncer<TFn, TSelected>\n\n debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: DebouncerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(debouncerInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return debouncerInstance\n })\n\n debouncer.fn = fn\n debouncer.setOptions(mergedOptions)\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(debouncer)\n } else {\n debouncer.cancel()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n const state = useSelector(debouncer.store, selector, { compare: shallow })\n\n return useMemo(\n () =>\n ({\n ...debouncer,\n state,\n }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n [debouncer, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkKA,SAAgB,aACd,IACA,SACA,kBAA6D,CAAC,IAC7B;CACjC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,CAAC,aAAa,eAAe;EACjC,MAAM,oBAAoB,IAAI,UAC5B,IACA,aACF;EAEA,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,YAAY,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAAS,QACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,UAAU,KAAK;CACf,UAAU,WAAW,aAAa;CAGlC,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,SAAS;QAEjC,UAAU,OAAO;EAErB;CACF,GAAG,CAAC,CAAC;CAGL,MAAM,QAAQ,YAAY,UAAU,OAAO,UAAU,EAAE,SAAS,QAAQ,CAAC;CAEzE,OAAO,eAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,WAAW,KAAK,CACnB;AACF"}
package/dist/index.cjs DELETED
@@ -1,67 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_PacerProvider = require('./provider/PacerProvider.cjs');
3
- const require_useAsyncBatcher = require('./async-batcher/useAsyncBatcher.cjs');
4
- const require_useAsyncBatchedCallback = require('./async-batcher/useAsyncBatchedCallback.cjs');
5
- const require_useAsyncDebouncer = require('./async-debouncer/useAsyncDebouncer.cjs');
6
- const require_useAsyncDebouncedCallback = require('./async-debouncer/useAsyncDebouncedCallback.cjs');
7
- const require_useAsyncQueuer = require('./async-queuer/useAsyncQueuer.cjs');
8
- const require_useAsyncQueuedState = require('./async-queuer/useAsyncQueuedState.cjs');
9
- const require_useAsyncRateLimiter = require('./async-rate-limiter/useAsyncRateLimiter.cjs');
10
- const require_useAsyncRateLimitedCallback = require('./async-rate-limiter/useAsyncRateLimitedCallback.cjs');
11
- const require_useAsyncThrottler = require('./async-throttler/useAsyncThrottler.cjs');
12
- const require_useAsyncThrottledCallback = require('./async-throttler/useAsyncThrottledCallback.cjs');
13
- const require_useBatcher = require('./batcher/useBatcher.cjs');
14
- const require_useBatchedCallback = require('./batcher/useBatchedCallback.cjs');
15
- const require_useDebouncer = require('./debouncer/useDebouncer.cjs');
16
- const require_useDebouncedCallback = require('./debouncer/useDebouncedCallback.cjs');
17
- const require_useDebouncedState = require('./debouncer/useDebouncedState.cjs');
18
- const require_useDebouncedValue = require('./debouncer/useDebouncedValue.cjs');
19
- const require_useQueuer = require('./queuer/useQueuer.cjs');
20
- const require_useQueuedState = require('./queuer/useQueuedState.cjs');
21
- const require_useQueuedValue = require('./queuer/useQueuedValue.cjs');
22
- const require_useRateLimiter = require('./rate-limiter/useRateLimiter.cjs');
23
- const require_useRateLimitedCallback = require('./rate-limiter/useRateLimitedCallback.cjs');
24
- const require_useRateLimitedState = require('./rate-limiter/useRateLimitedState.cjs');
25
- const require_useRateLimitedValue = require('./rate-limiter/useRateLimitedValue.cjs');
26
- const require_useThrottler = require('./throttler/useThrottler.cjs');
27
- const require_useThrottledCallback = require('./throttler/useThrottledCallback.cjs');
28
- const require_useThrottledState = require('./throttler/useThrottledState.cjs');
29
- const require_useThrottledValue = require('./throttler/useThrottledValue.cjs');
30
-
31
- exports.PacerProvider = require_PacerProvider.PacerProvider;
32
- exports.useAsyncBatchedCallback = require_useAsyncBatchedCallback.useAsyncBatchedCallback;
33
- exports.useAsyncBatcher = require_useAsyncBatcher.useAsyncBatcher;
34
- exports.useAsyncDebouncedCallback = require_useAsyncDebouncedCallback.useAsyncDebouncedCallback;
35
- exports.useAsyncDebouncer = require_useAsyncDebouncer.useAsyncDebouncer;
36
- exports.useAsyncQueuedState = require_useAsyncQueuedState.useAsyncQueuedState;
37
- exports.useAsyncQueuer = require_useAsyncQueuer.useAsyncQueuer;
38
- exports.useAsyncRateLimitedCallback = require_useAsyncRateLimitedCallback.useAsyncRateLimitedCallback;
39
- exports.useAsyncRateLimiter = require_useAsyncRateLimiter.useAsyncRateLimiter;
40
- exports.useAsyncThrottledCallback = require_useAsyncThrottledCallback.useAsyncThrottledCallback;
41
- exports.useAsyncThrottler = require_useAsyncThrottler.useAsyncThrottler;
42
- exports.useBatchedCallback = require_useBatchedCallback.useBatchedCallback;
43
- exports.useBatcher = require_useBatcher.useBatcher;
44
- exports.useDebouncedCallback = require_useDebouncedCallback.useDebouncedCallback;
45
- exports.useDebouncedState = require_useDebouncedState.useDebouncedState;
46
- exports.useDebouncedValue = require_useDebouncedValue.useDebouncedValue;
47
- exports.useDebouncer = require_useDebouncer.useDebouncer;
48
- exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
49
- exports.usePacerContext = require_PacerProvider.usePacerContext;
50
- exports.useQueuedState = require_useQueuedState.useQueuedState;
51
- exports.useQueuedValue = require_useQueuedValue.useQueuedValue;
52
- exports.useQueuer = require_useQueuer.useQueuer;
53
- exports.useRateLimitedCallback = require_useRateLimitedCallback.useRateLimitedCallback;
54
- exports.useRateLimitedState = require_useRateLimitedState.useRateLimitedState;
55
- exports.useRateLimitedValue = require_useRateLimitedValue.useRateLimitedValue;
56
- exports.useRateLimiter = require_useRateLimiter.useRateLimiter;
57
- exports.useThrottledCallback = require_useThrottledCallback.useThrottledCallback;
58
- exports.useThrottledState = require_useThrottledState.useThrottledState;
59
- exports.useThrottledValue = require_useThrottledValue.useThrottledValue;
60
- exports.useThrottler = require_useThrottler.useThrottler;
61
- var _tanstack_pacer = require("@tanstack/pacer");
62
- Object.keys(_tanstack_pacer).forEach(function (k) {
63
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
64
- enumerable: true,
65
- get: function () { return _tanstack_pacer[k]; }
66
- });
67
- });
package/dist/index.d.cts DELETED
@@ -1,30 +0,0 @@
1
- import { PreactAsyncBatcher, PreactAsyncBatcherOptions, useAsyncBatcher } from "./async-batcher/useAsyncBatcher.cjs";
2
- import { useAsyncBatchedCallback } from "./async-batcher/useAsyncBatchedCallback.cjs";
3
- import { PreactAsyncDebouncer, PreactAsyncDebouncerOptions, useAsyncDebouncer } from "./async-debouncer/useAsyncDebouncer.cjs";
4
- import { useAsyncDebouncedCallback } from "./async-debouncer/useAsyncDebouncedCallback.cjs";
5
- import { PreactAsyncQueuer, PreactAsyncQueuerOptions, useAsyncQueuer } from "./async-queuer/useAsyncQueuer.cjs";
6
- import { useAsyncQueuedState } from "./async-queuer/useAsyncQueuedState.cjs";
7
- import { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter } from "./async-rate-limiter/useAsyncRateLimiter.cjs";
8
- import { useAsyncRateLimitedCallback } from "./async-rate-limiter/useAsyncRateLimitedCallback.cjs";
9
- import { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottler } from "./async-throttler/useAsyncThrottler.cjs";
10
- import { useAsyncThrottledCallback } from "./async-throttler/useAsyncThrottledCallback.cjs";
11
- import { PreactBatcher, PreactBatcherOptions, useBatcher } from "./batcher/useBatcher.cjs";
12
- import { useBatchedCallback } from "./batcher/useBatchedCallback.cjs";
13
- import { PreactDebouncer, PreactDebouncerOptions, useDebouncer } from "./debouncer/useDebouncer.cjs";
14
- import { useDebouncedCallback } from "./debouncer/useDebouncedCallback.cjs";
15
- import { useDebouncedState } from "./debouncer/useDebouncedState.cjs";
16
- import { useDebouncedValue } from "./debouncer/useDebouncedValue.cjs";
17
- import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.cjs";
18
- import { PreactQueuer, PreactQueuerOptions, useQueuer } from "./queuer/useQueuer.cjs";
19
- import { useQueuedState } from "./queuer/useQueuedState.cjs";
20
- import { useQueuedValue } from "./queuer/useQueuedValue.cjs";
21
- import { PreactRateLimiter, PreactRateLimiterOptions, useRateLimiter } from "./rate-limiter/useRateLimiter.cjs";
22
- import { useRateLimitedCallback } from "./rate-limiter/useRateLimitedCallback.cjs";
23
- import { useRateLimitedState } from "./rate-limiter/useRateLimitedState.cjs";
24
- import { useRateLimitedValue } from "./rate-limiter/useRateLimitedValue.cjs";
25
- import { PreactThrottler, PreactThrottlerOptions, useThrottler } from "./throttler/useThrottler.cjs";
26
- import { useThrottledCallback } from "./throttler/useThrottledCallback.cjs";
27
- import { useThrottledState } from "./throttler/useThrottledState.cjs";
28
- import { useThrottledValue } from "./throttler/useThrottledValue.cjs";
29
- export * from "@tanstack/pacer";
30
- export { PacerProvider, PacerProviderOptions, PacerProviderProps, PreactAsyncBatcher, PreactAsyncBatcherOptions, PreactAsyncDebouncer, PreactAsyncDebouncerOptions, PreactAsyncQueuer, PreactAsyncQueuerOptions, PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, PreactAsyncThrottler, PreactAsyncThrottlerOptions, PreactBatcher, PreactBatcherOptions, PreactDebouncer, PreactDebouncerOptions, PreactQueuer, PreactQueuerOptions, PreactRateLimiter, PreactRateLimiterOptions, PreactThrottler, PreactThrottlerOptions, useAsyncBatchedCallback, useAsyncBatcher, useAsyncDebouncedCallback, useAsyncDebouncer, useAsyncQueuedState, useAsyncQueuer, useAsyncRateLimitedCallback, useAsyncRateLimiter, useAsyncThrottledCallback, useAsyncThrottler, useBatchedCallback, useBatcher, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer, useDefaultPacerOptions, usePacerContext, useQueuedState, useQueuedValue, useQueuer, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };
@@ -1,26 +0,0 @@
1
- let preact_hooks = require("preact/hooks");
2
- let preact = require("preact");
3
- let preact_jsx_runtime = require("preact/jsx-runtime");
4
-
5
- //#region src/provider/PacerProvider.tsx
6
- const PacerContext = (0, preact.createContext)(null);
7
- const DEFAULT_OPTIONS = {};
8
- function PacerProvider({ children, defaultOptions = DEFAULT_OPTIONS }) {
9
- const contextValue = (0, preact_hooks.useMemo)(() => ({ defaultOptions }), [defaultOptions]);
10
- return /* @__PURE__ */ (0, preact_jsx_runtime.jsx)(PacerContext.Provider, {
11
- value: contextValue,
12
- children
13
- });
14
- }
15
- function usePacerContext() {
16
- return (0, preact_hooks.useContext)(PacerContext);
17
- }
18
- function useDefaultPacerOptions() {
19
- return (0, preact_hooks.useContext)(PacerContext)?.defaultOptions ?? {};
20
- }
21
-
22
- //#endregion
23
- exports.PacerProvider = PacerProvider;
24
- exports.useDefaultPacerOptions = useDefaultPacerOptions;
25
- exports.usePacerContext = usePacerContext;
26
- //# sourceMappingURL=PacerProvider.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PacerProvider.cjs","names":["createContext","useMemo","useContext"],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { useContext, useMemo } from 'preact/hooks'\nimport { createContext } from 'preact'\nimport type { ComponentChildren } from 'preact'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: ComponentChildren\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider({\n children,\n defaultOptions = DEFAULT_OPTIONS,\n}: PacerProviderProps) {\n const contextValue: PacerContextValue = useMemo(\n () => ({\n defaultOptions,\n }),\n [defaultOptions],\n )\n\n return (\n <PacerContext.Provider value={contextValue}>\n {children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAmCA,MAAM,mBAAeA,sBAAwC,IAAI;AAOjE,MAAM,kBAAwC,CAAC;AAE/C,SAAgB,cAAc,EAC5B,UACA,iBAAiB,mBACI;CACrB,MAAM,mBAAkCC,6BAC/B,EACL,eACF,IACA,CAAC,cAAc,CACjB;CAEA,OACE,4CAAC,aAAa,UAAd;EAAuB,OAAO;EAC3B;CACoB;AAE3B;AAEA,SAAgB,kBAAkB;CAChC,WAAOC,yBAAW,YAAY;AAChC;AAEA,SAAgB,yBAAyB;CAEvC,WADgBA,yBAAW,YACd,CAAC,EAAE,kBAAkB,CAAC;AACrC"}
@@ -1,28 +0,0 @@
1
- import { ComponentChildren } from "preact";
2
- import { AnyAsyncFunction, AnyFunction, AsyncBatcherOptions, AsyncDebouncerOptions, AsyncQueuerOptions, AsyncRateLimiterOptions, AsyncThrottlerOptions, BatcherOptions, DebouncerOptions, QueuerOptions, RateLimiterOptions, ThrottlerOptions } from "@tanstack/pacer";
3
- //#region src/provider/PacerProvider.d.ts
4
- interface PacerProviderOptions {
5
- asyncBatcher?: Partial<AsyncBatcherOptions<any>>;
6
- asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>;
7
- asyncQueuer?: Partial<AsyncQueuerOptions<any>>;
8
- asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>;
9
- asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>;
10
- batcher?: Partial<BatcherOptions<any>>;
11
- debouncer?: Partial<DebouncerOptions<AnyFunction>>;
12
- queuer?: Partial<QueuerOptions<any>>;
13
- rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>;
14
- throttler?: Partial<ThrottlerOptions<AnyFunction>>;
15
- }
16
- interface PacerContextValue {
17
- defaultOptions: PacerProviderOptions;
18
- }
19
- interface PacerProviderProps {
20
- children: ComponentChildren;
21
- defaultOptions?: PacerProviderOptions;
22
- }
23
- declare function PacerProvider({ children, defaultOptions }: PacerProviderProps): import("preact").JSX.Element;
24
- declare function usePacerContext(): PacerContextValue | null;
25
- declare function useDefaultPacerOptions(): PacerProviderOptions;
26
- //#endregion
27
- export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
28
- //# sourceMappingURL=PacerProvider.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PacerProvider.js","names":[],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { useContext, useMemo } from 'preact/hooks'\nimport { createContext } from 'preact'\nimport type { ComponentChildren } from 'preact'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: ComponentChildren\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider({\n children,\n defaultOptions = DEFAULT_OPTIONS,\n}: PacerProviderProps) {\n const contextValue: PacerContextValue = useMemo(\n () => ({\n defaultOptions,\n }),\n [defaultOptions],\n )\n\n return (\n <PacerContext.Provider value={contextValue}>\n {children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;;AAmCA,MAAM,eAAe,cAAwC,IAAI;AAOjE,MAAM,kBAAwC,CAAC;AAE/C,SAAgB,cAAc,EAC5B,UACA,iBAAiB,mBACI;CACrB,MAAM,eAAkC,eAC/B,EACL,eACF,IACA,CAAC,cAAc,CACjB;CAEA,OACE,oBAAC,aAAa,UAAd;EAAuB,OAAO;EAC3B;CACoB;AAE3B;AAEA,SAAgB,kBAAkB;CAChC,OAAO,WAAW,YAAY;AAChC;AAEA,SAAgB,yBAAyB;CAEvC,OADgB,WAAW,YACd,CAAC,EAAE,kBAAkB,CAAC;AACrC"}
@@ -1,6 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_PacerProvider = require('./PacerProvider.cjs');
3
-
4
- exports.PacerProvider = require_PacerProvider.PacerProvider;
5
- exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
6
- exports.usePacerContext = require_PacerProvider.usePacerContext;
@@ -1,2 +0,0 @@
1
- import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./PacerProvider.cjs";
2
- export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
@@ -1,15 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_useQueuer = require('./useQueuer.cjs');
3
- const require_useQueuedState = require('./useQueuedState.cjs');
4
- const require_useQueuedValue = require('./useQueuedValue.cjs');
5
-
6
- exports.useQueuedState = require_useQueuedState.useQueuedState;
7
- exports.useQueuedValue = require_useQueuedValue.useQueuedValue;
8
- exports.useQueuer = require_useQueuer.useQueuer;
9
- var _tanstack_pacer_queuer = require("@tanstack/pacer/queuer");
10
- Object.keys(_tanstack_pacer_queuer).forEach(function (k) {
11
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
12
- enumerable: true,
13
- get: function () { return _tanstack_pacer_queuer[k]; }
14
- });
15
- });
@@ -1,5 +0,0 @@
1
- import { PreactQueuer, PreactQueuerOptions, useQueuer } from "./useQueuer.cjs";
2
- import { useQueuedState } from "./useQueuedState.cjs";
3
- import { useQueuedValue } from "./useQueuedValue.cjs";
4
- export * from "@tanstack/pacer/queuer";
5
- export { PreactQueuer, PreactQueuerOptions, useQueuedState, useQueuedValue, useQueuer };
@@ -1,129 +0,0 @@
1
- const require_useQueuer = require('./useQueuer.cjs');
2
-
3
- //#region src/queuer/useQueuedState.ts
4
- /**
5
- * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.
6
- * This hook provides both the current queue state and queue control methods.
7
- *
8
- * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
9
- * All queue operations are reflected in the state array returned by the hook.
10
- *
11
- * The queue can be started and stopped to automatically process items at a specified interval,
12
- * making it useful as a scheduler. When started, it will process one item per tick, with an
13
- * optional wait time between ticks.
14
- *
15
- * The hook returns a tuple containing:
16
- * - The current queue state as an array
17
- * - The queue instance with methods for queue manipulation
18
- *
19
- * ## State Management and Selector
20
- *
21
- * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
22
- * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
23
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
24
- *
25
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
26
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
27
- * full control over when your component updates. Only when you provide a selector will the
28
- * component re-render when the selected state values change.
29
- *
30
- * Available queuer state properties:
31
- * - `executionCount`: Number of items that have been processed by the queuer
32
- * - `expirationCount`: Number of items that have been removed due to expiration
33
- * - `isEmpty`: Whether the queuer has no items to process
34
- * - `isFull`: Whether the queuer has reached its maximum capacity
35
- * - `isIdle`: Whether the queuer is not currently processing any items
36
- * - `isRunning`: Whether the queuer is active and will process items automatically
37
- * - `items`: Array of items currently waiting to be processed
38
- * - `itemTimestamps`: Timestamps when items were added for expiration tracking
39
- * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
40
- * - `rejectionCount`: Number of items that have been rejected from being added
41
- * - `size`: Number of items currently in the queue
42
- * - `status`: Current processing status ('idle' | 'running' | 'stopped')
43
- *
44
- * @example
45
- * ```tsx
46
- * // Default behavior - no reactive state subscriptions
47
- * const [items, addItem, queue] = useQueuedState(
48
- * (item) => console.log('Processing:', item),
49
- * {
50
- * initialItems: ['item1', 'item2'],
51
- * started: true,
52
- * wait: 1000,
53
- * getPriority: (item) => item.priority
54
- * }
55
- * );
56
- *
57
- * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
58
- * const [items, addItem, queue] = useQueuedState(
59
- * (item) => console.log('Processing:', item),
60
- * { started: true, wait: 1000 },
61
- * (state) => ({
62
- * items: state.items,
63
- * size: state.size,
64
- * isEmpty: state.isEmpty
65
- * })
66
- * );
67
- *
68
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
69
- * const [items, addItem, queue] = useQueuedState(
70
- * (item) => console.log('Processing:', item),
71
- * { started: true, wait: 1000 },
72
- * (state) => ({
73
- * isRunning: state.isRunning,
74
- * isIdle: state.isIdle,
75
- * status: state.status,
76
- * pendingTick: state.pendingTick
77
- * })
78
- * );
79
- *
80
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
81
- * const [items, addItem, queue] = useQueuedState(
82
- * (item) => console.log('Processing:', item),
83
- * { started: true, wait: 1000 },
84
- * (state) => ({
85
- * executionCount: state.executionCount,
86
- * expirationCount: state.expirationCount,
87
- * rejectionCount: state.rejectionCount
88
- * })
89
- * );
90
- *
91
- * // Add items to queue
92
- * const handleAdd = (item) => {
93
- * addItem(item);
94
- * };
95
- *
96
- * // Start automatic processing
97
- * const startProcessing = () => {
98
- * queue.start();
99
- * };
100
- *
101
- * // Stop automatic processing
102
- * const stopProcessing = () => {
103
- * queue.stop();
104
- * };
105
- *
106
- * // Manual processing still available
107
- * const handleProcess = () => {
108
- * const nextItem = queue.getNextItem();
109
- * if (nextItem) {
110
- * processItem(nextItem);
111
- * }
112
- * };
113
- *
114
- * // Access the selected queuer state (will be empty object {} unless selector provided)
115
- * const { size, isRunning, executionCount } = queue.state;
116
- * ```
117
- */
118
- function useQueuedState(fn, options = {}, selector) {
119
- const queue = require_useQueuer.useQueuer(fn, options, selector);
120
- return [
121
- queue.state.items,
122
- queue.addItem,
123
- queue
124
- ];
125
- }
126
-
127
- //#endregion
128
- exports.useQueuedState = useQueuedState;
129
- //# sourceMappingURL=useQueuedState.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useQueuedState.cjs","names":["useQueuer"],"sources":["../../src/queuer/useQueuedState.ts"],"sourcesContent":["import { useQueuer } from './useQueuer'\nimport type { PreactQueuer, PreactQueuerOptions } from './useQueuer'\nimport type { Queuer, QueuerState } from '@tanstack/pacer/queuer'\n\n/**\n * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.\n * This hook provides both the current queue state and queue control methods.\n *\n * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.\n * All queue operations are reflected in the state array returned by the hook.\n *\n * The queue can be started and stopped to automatically process items at a specified interval,\n * making it useful as a scheduler. When started, it will process one item per tick, with an\n * optional wait time between ticks.\n *\n * The hook returns a tuple containing:\n * - The current queue state as an array\n * - The queue instance with methods for queue manipulation\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying queuer instance.\n * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available queuer state properties:\n * - `executionCount`: Number of items that have been processed by the queuer\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [items, addItem, queue] = useQueuedState(\n * (item) => console.log('Processing:', item),\n * {\n * initialItems: ['item1', 'item2'],\n * started: true,\n * wait: 1000,\n * getPriority: (item) => item.priority\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [items, addItem, queue] = useQueuedState(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * items: state.items,\n * size: state.size,\n * isEmpty: state.isEmpty\n * })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const [items, addItem, queue] = useQueuedState(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * isRunning: state.isRunning,\n * isIdle: state.isIdle,\n * status: state.status,\n * pendingTick: state.pendingTick\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [items, addItem, queue] = useQueuedState(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * executionCount: state.executionCount,\n * expirationCount: state.expirationCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Add items to queue\n * const handleAdd = (item) => {\n * addItem(item);\n * };\n *\n * // Start automatic processing\n * const startProcessing = () => {\n * queue.start();\n * };\n *\n * // Stop automatic processing\n * const stopProcessing = () => {\n * queue.stop();\n * };\n *\n * // Manual processing still available\n * const handleProcess = () => {\n * const nextItem = queue.getNextItem();\n * if (nextItem) {\n * processItem(nextItem);\n * }\n * };\n *\n * // Access the selected queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queue.state;\n * ```\n */\nexport function useQueuedState<\n TValue,\n TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<\n QueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (item: TValue) => void,\n options: PreactQueuerOptions<TValue, TSelected> = {},\n selector?: (state: QueuerState<TValue>) => TSelected,\n): [Array<TValue>, Queuer<TValue>['addItem'], PreactQueuer<TValue, TSelected>] {\n const queue = useQueuer(fn, options, selector)\n\n return [queue.state.items, queue.addItem, queue]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsHA,SAAgB,eAOd,IACA,UAAkD,CAAC,GACnD,UAC6E;CAC7E,MAAM,QAAQA,4BAAU,IAAI,SAAS,QAAQ;CAE7C,OAAO;EAAC,MAAM,MAAM;EAAO,MAAM;EAAS;CAAK;AACjD"}
@@ -1,121 +0,0 @@
1
- import { PreactQueuer, PreactQueuerOptions } from "./useQueuer.cjs";
2
- import { Queuer, QueuerState } from "@tanstack/pacer/queuer";
3
- //#region src/queuer/useQueuedState.d.ts
4
- /**
5
- * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.
6
- * This hook provides both the current queue state and queue control methods.
7
- *
8
- * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
9
- * All queue operations are reflected in the state array returned by the hook.
10
- *
11
- * The queue can be started and stopped to automatically process items at a specified interval,
12
- * making it useful as a scheduler. When started, it will process one item per tick, with an
13
- * optional wait time between ticks.
14
- *
15
- * The hook returns a tuple containing:
16
- * - The current queue state as an array
17
- * - The queue instance with methods for queue manipulation
18
- *
19
- * ## State Management and Selector
20
- *
21
- * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
22
- * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
23
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
24
- *
25
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
26
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
27
- * full control over when your component updates. Only when you provide a selector will the
28
- * component re-render when the selected state values change.
29
- *
30
- * Available queuer state properties:
31
- * - `executionCount`: Number of items that have been processed by the queuer
32
- * - `expirationCount`: Number of items that have been removed due to expiration
33
- * - `isEmpty`: Whether the queuer has no items to process
34
- * - `isFull`: Whether the queuer has reached its maximum capacity
35
- * - `isIdle`: Whether the queuer is not currently processing any items
36
- * - `isRunning`: Whether the queuer is active and will process items automatically
37
- * - `items`: Array of items currently waiting to be processed
38
- * - `itemTimestamps`: Timestamps when items were added for expiration tracking
39
- * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
40
- * - `rejectionCount`: Number of items that have been rejected from being added
41
- * - `size`: Number of items currently in the queue
42
- * - `status`: Current processing status ('idle' | 'running' | 'stopped')
43
- *
44
- * @example
45
- * ```tsx
46
- * // Default behavior - no reactive state subscriptions
47
- * const [items, addItem, queue] = useQueuedState(
48
- * (item) => console.log('Processing:', item),
49
- * {
50
- * initialItems: ['item1', 'item2'],
51
- * started: true,
52
- * wait: 1000,
53
- * getPriority: (item) => item.priority
54
- * }
55
- * );
56
- *
57
- * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
58
- * const [items, addItem, queue] = useQueuedState(
59
- * (item) => console.log('Processing:', item),
60
- * { started: true, wait: 1000 },
61
- * (state) => ({
62
- * items: state.items,
63
- * size: state.size,
64
- * isEmpty: state.isEmpty
65
- * })
66
- * );
67
- *
68
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
69
- * const [items, addItem, queue] = useQueuedState(
70
- * (item) => console.log('Processing:', item),
71
- * { started: true, wait: 1000 },
72
- * (state) => ({
73
- * isRunning: state.isRunning,
74
- * isIdle: state.isIdle,
75
- * status: state.status,
76
- * pendingTick: state.pendingTick
77
- * })
78
- * );
79
- *
80
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
81
- * const [items, addItem, queue] = useQueuedState(
82
- * (item) => console.log('Processing:', item),
83
- * { started: true, wait: 1000 },
84
- * (state) => ({
85
- * executionCount: state.executionCount,
86
- * expirationCount: state.expirationCount,
87
- * rejectionCount: state.rejectionCount
88
- * })
89
- * );
90
- *
91
- * // Add items to queue
92
- * const handleAdd = (item) => {
93
- * addItem(item);
94
- * };
95
- *
96
- * // Start automatic processing
97
- * const startProcessing = () => {
98
- * queue.start();
99
- * };
100
- *
101
- * // Stop automatic processing
102
- * const stopProcessing = () => {
103
- * queue.stop();
104
- * };
105
- *
106
- * // Manual processing still available
107
- * const handleProcess = () => {
108
- * const nextItem = queue.getNextItem();
109
- * if (nextItem) {
110
- * processItem(nextItem);
111
- * }
112
- * };
113
- *
114
- * // Access the selected queuer state (will be empty object {} unless selector provided)
115
- * const { size, isRunning, executionCount } = queue.state;
116
- * ```
117
- */
118
- declare function useQueuedState<TValue, TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<QueuerState<TValue>, 'items'>>(fn: (item: TValue) => void, options?: PreactQueuerOptions<TValue, TSelected>, selector?: (state: QueuerState<TValue>) => TSelected): [Array<TValue>, Queuer<TValue>['addItem'], PreactQueuer<TValue, TSelected>];
119
- //#endregion
120
- export { useQueuedState };
121
- //# sourceMappingURL=useQueuedState.d.cts.map