@tanstack/preact-pacer 0.22.1 → 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 (243) hide show
  1. package/README.md +17 -2
  2. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -5
  3. package/dist/async-batcher/useAsyncBatchedCallback.js +1 -2
  4. package/dist/async-batcher/useAsyncBatcher.d.ts +4 -8
  5. package/dist/async-batcher/useAsyncBatcher.js +1 -3
  6. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +6 -7
  7. package/dist/async-debouncer/useAsyncDebouncedCallback.js +5 -4
  8. package/dist/async-debouncer/useAsyncDebouncer.d.ts +4 -7
  9. package/dist/async-debouncer/useAsyncDebouncer.js +1 -2
  10. package/dist/async-queuer/useAsyncQueuedState.d.ts +4 -7
  11. package/dist/async-queuer/useAsyncQueuedState.js +3 -4
  12. package/dist/async-queuer/useAsyncQueuer.d.ts +6 -9
  13. package/dist/async-queuer/useAsyncQueuer.js +3 -4
  14. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -5
  15. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +1 -2
  16. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +4 -7
  17. package/dist/async-rate-limiter/useAsyncRateLimiter.js +1 -2
  18. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +7 -9
  19. package/dist/async-throttler/useAsyncThrottledCallback.js +6 -6
  20. package/dist/async-throttler/useAsyncThrottler.d.ts +4 -7
  21. package/dist/async-throttler/useAsyncThrottler.js +1 -2
  22. package/dist/batcher/useBatchedCallback.d.ts +2 -5
  23. package/dist/batcher/useBatchedCallback.js +1 -2
  24. package/dist/batcher/useBatcher.d.ts +6 -11
  25. package/dist/batcher/useBatcher.js +3 -6
  26. package/dist/debouncer/useDebouncedCallback.d.ts +2 -5
  27. package/dist/debouncer/useDebouncedCallback.js +1 -2
  28. package/dist/debouncer/useDebouncedState.d.ts +2 -5
  29. package/dist/debouncer/useDebouncedState.js +1 -2
  30. package/dist/debouncer/useDebouncedValue.d.ts +2 -5
  31. package/dist/debouncer/useDebouncedValue.js +1 -2
  32. package/dist/debouncer/useDebouncer.d.ts +4 -7
  33. package/dist/debouncer/useDebouncer.js +1 -2
  34. package/dist/provider/PacerProvider.d.ts +6 -13
  35. package/dist/provider/PacerProvider.js +1 -2
  36. package/dist/queuer/useQueuedState.d.ts +2 -5
  37. package/dist/queuer/useQueuedState.js +1 -2
  38. package/dist/queuer/useQueuedValue.d.ts +2 -5
  39. package/dist/queuer/useQueuedValue.js +1 -2
  40. package/dist/queuer/useQueuer.d.ts +4 -7
  41. package/dist/queuer/useQueuer.js +1 -2
  42. package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -5
  43. package/dist/rate-limiter/useRateLimitedCallback.js +1 -2
  44. package/dist/rate-limiter/useRateLimitedState.d.ts +2 -5
  45. package/dist/rate-limiter/useRateLimitedState.js +1 -2
  46. package/dist/rate-limiter/useRateLimitedValue.d.ts +2 -5
  47. package/dist/rate-limiter/useRateLimitedValue.js +1 -2
  48. package/dist/rate-limiter/useRateLimiter.d.ts +4 -7
  49. package/dist/rate-limiter/useRateLimiter.js +1 -2
  50. package/dist/throttler/useThrottledCallback.d.ts +2 -5
  51. package/dist/throttler/useThrottledCallback.js +1 -2
  52. package/dist/throttler/useThrottledState.d.ts +2 -5
  53. package/dist/throttler/useThrottledState.js +1 -2
  54. package/dist/throttler/useThrottledValue.d.ts +2 -5
  55. package/dist/throttler/useThrottledValue.js +1 -2
  56. package/dist/throttler/useThrottler.d.ts +4 -7
  57. package/dist/throttler/useThrottler.js +1 -2
  58. package/package.json +24 -72
  59. package/dist/async-batcher/index.cjs +0 -13
  60. package/dist/async-batcher/index.d.cts +0 -4
  61. package/dist/async-batcher/useAsyncBatchedCallback.cjs +0 -51
  62. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +0 -1
  63. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +0 -44
  64. package/dist/async-batcher/useAsyncBatchedCallback.js.map +0 -1
  65. package/dist/async-batcher/useAsyncBatcher.cjs +0 -217
  66. package/dist/async-batcher/useAsyncBatcher.cjs.map +0 -1
  67. package/dist/async-batcher/useAsyncBatcher.d.cts +0 -224
  68. package/dist/async-batcher/useAsyncBatcher.js.map +0 -1
  69. package/dist/async-debouncer/index.cjs +0 -13
  70. package/dist/async-debouncer/index.d.cts +0 -4
  71. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs +0 -50
  72. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +0 -1
  73. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +0 -46
  74. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +0 -1
  75. package/dist/async-debouncer/useAsyncDebouncer.cjs +0 -195
  76. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +0 -1
  77. package/dist/async-debouncer/useAsyncDebouncer.d.cts +0 -203
  78. package/dist/async-debouncer/useAsyncDebouncer.js.map +0 -1
  79. package/dist/async-queuer/index.cjs +0 -13
  80. package/dist/async-queuer/index.d.cts +0 -4
  81. package/dist/async-queuer/useAsyncQueuedState.cjs +0 -154
  82. package/dist/async-queuer/useAsyncQueuedState.cjs.map +0 -1
  83. package/dist/async-queuer/useAsyncQueuedState.d.cts +0 -151
  84. package/dist/async-queuer/useAsyncQueuedState.js.map +0 -1
  85. package/dist/async-queuer/useAsyncQueuer.cjs +0 -217
  86. package/dist/async-queuer/useAsyncQueuer.cjs.map +0 -1
  87. package/dist/async-queuer/useAsyncQueuer.d.cts +0 -224
  88. package/dist/async-queuer/useAsyncQueuer.js.map +0 -1
  89. package/dist/async-rate-limiter/index.cjs +0 -13
  90. package/dist/async-rate-limiter/index.d.cts +0 -4
  91. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs +0 -65
  92. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +0 -1
  93. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +0 -61
  94. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +0 -1
  95. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +0 -209
  96. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +0 -1
  97. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +0 -220
  98. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +0 -1
  99. package/dist/async-retryer/index.cjs +0 -9
  100. package/dist/async-retryer/index.d.cts +0 -1
  101. package/dist/async-throttler/index.cjs +0 -13
  102. package/dist/async-throttler/index.d.cts +0 -4
  103. package/dist/async-throttler/useAsyncThrottledCallback.cjs +0 -48
  104. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +0 -1
  105. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +0 -44
  106. package/dist/async-throttler/useAsyncThrottledCallback.js.map +0 -1
  107. package/dist/async-throttler/useAsyncThrottler.cjs +0 -206
  108. package/dist/async-throttler/useAsyncThrottler.cjs.map +0 -1
  109. package/dist/async-throttler/useAsyncThrottler.d.cts +0 -214
  110. package/dist/async-throttler/useAsyncThrottler.js.map +0 -1
  111. package/dist/batcher/index.cjs +0 -13
  112. package/dist/batcher/index.d.cts +0 -4
  113. package/dist/batcher/useBatchedCallback.cjs +0 -47
  114. package/dist/batcher/useBatchedCallback.cjs.map +0 -1
  115. package/dist/batcher/useBatchedCallback.d.cts +0 -42
  116. package/dist/batcher/useBatchedCallback.js.map +0 -1
  117. package/dist/batcher/useBatcher.cjs +0 -165
  118. package/dist/batcher/useBatcher.cjs.map +0 -1
  119. package/dist/batcher/useBatcher.d.cts +0 -175
  120. package/dist/batcher/useBatcher.js.map +0 -1
  121. package/dist/debouncer/index.cjs +0 -17
  122. package/dist/debouncer/index.d.cts +0 -6
  123. package/dist/debouncer/useDebouncedCallback.cjs +0 -48
  124. package/dist/debouncer/useDebouncedCallback.cjs.map +0 -1
  125. package/dist/debouncer/useDebouncedCallback.d.cts +0 -44
  126. package/dist/debouncer/useDebouncedCallback.js.map +0 -1
  127. package/dist/debouncer/useDebouncedState.cjs +0 -89
  128. package/dist/debouncer/useDebouncedState.cjs.map +0 -1
  129. package/dist/debouncer/useDebouncedState.d.cts +0 -81
  130. package/dist/debouncer/useDebouncedState.js.map +0 -1
  131. package/dist/debouncer/useDebouncedValue.cjs +0 -96
  132. package/dist/debouncer/useDebouncedValue.cjs.map +0 -1
  133. package/dist/debouncer/useDebouncedValue.d.cts +0 -90
  134. package/dist/debouncer/useDebouncedValue.js.map +0 -1
  135. package/dist/debouncer/useDebouncer.cjs +0 -141
  136. package/dist/debouncer/useDebouncer.cjs.map +0 -1
  137. package/dist/debouncer/useDebouncer.d.cts +0 -152
  138. package/dist/debouncer/useDebouncer.js.map +0 -1
  139. package/dist/index.cjs +0 -67
  140. package/dist/index.d.cts +0 -30
  141. package/dist/provider/PacerProvider.cjs +0 -26
  142. package/dist/provider/PacerProvider.cjs.map +0 -1
  143. package/dist/provider/PacerProvider.d.cts +0 -33
  144. package/dist/provider/PacerProvider.js.map +0 -1
  145. package/dist/provider/index.cjs +0 -6
  146. package/dist/provider/index.d.cts +0 -2
  147. package/dist/queuer/index.cjs +0 -15
  148. package/dist/queuer/index.d.cts +0 -5
  149. package/dist/queuer/useQueuedState.cjs +0 -129
  150. package/dist/queuer/useQueuedState.cjs.map +0 -1
  151. package/dist/queuer/useQueuedState.d.cts +0 -122
  152. package/dist/queuer/useQueuedState.js.map +0 -1
  153. package/dist/queuer/useQueuedValue.cjs +0 -115
  154. package/dist/queuer/useQueuedValue.cjs.map +0 -1
  155. package/dist/queuer/useQueuedValue.d.cts +0 -105
  156. package/dist/queuer/useQueuedValue.js.map +0 -1
  157. package/dist/queuer/useQueuer.cjs +0 -176
  158. package/dist/queuer/useQueuer.cjs.map +0 -1
  159. package/dist/queuer/useQueuer.d.cts +0 -186
  160. package/dist/queuer/useQueuer.js.map +0 -1
  161. package/dist/rate-limiter/index.cjs +0 -17
  162. package/dist/rate-limiter/index.d.cts +0 -6
  163. package/dist/rate-limiter/useRateLimitedCallback.cjs +0 -65
  164. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +0 -1
  165. package/dist/rate-limiter/useRateLimitedCallback.d.cts +0 -61
  166. package/dist/rate-limiter/useRateLimitedCallback.js.map +0 -1
  167. package/dist/rate-limiter/useRateLimitedState.cjs +0 -115
  168. package/dist/rate-limiter/useRateLimitedState.cjs.map +0 -1
  169. package/dist/rate-limiter/useRateLimitedState.d.cts +0 -107
  170. package/dist/rate-limiter/useRateLimitedState.js.map +0 -1
  171. package/dist/rate-limiter/useRateLimitedValue.cjs +0 -102
  172. package/dist/rate-limiter/useRateLimitedValue.cjs.map +0 -1
  173. package/dist/rate-limiter/useRateLimitedValue.d.cts +0 -96
  174. package/dist/rate-limiter/useRateLimitedValue.js.map +0 -1
  175. package/dist/rate-limiter/useRateLimiter.cjs +0 -167
  176. package/dist/rate-limiter/useRateLimiter.cjs.map +0 -1
  177. package/dist/rate-limiter/useRateLimiter.d.cts +0 -179
  178. package/dist/rate-limiter/useRateLimiter.js.map +0 -1
  179. package/dist/throttler/index.cjs +0 -17
  180. package/dist/throttler/index.d.cts +0 -6
  181. package/dist/throttler/useThrottledCallback.cjs +0 -49
  182. package/dist/throttler/useThrottledCallback.cjs.map +0 -1
  183. package/dist/throttler/useThrottledCallback.d.cts +0 -45
  184. package/dist/throttler/useThrottledCallback.js.map +0 -1
  185. package/dist/throttler/useThrottledState.cjs +0 -100
  186. package/dist/throttler/useThrottledState.cjs.map +0 -1
  187. package/dist/throttler/useThrottledState.d.cts +0 -92
  188. package/dist/throttler/useThrottledState.js.map +0 -1
  189. package/dist/throttler/useThrottledValue.cjs +0 -91
  190. package/dist/throttler/useThrottledValue.cjs.map +0 -1
  191. package/dist/throttler/useThrottledValue.d.cts +0 -85
  192. package/dist/throttler/useThrottledValue.js.map +0 -1
  193. package/dist/throttler/useThrottler.cjs +0 -146
  194. package/dist/throttler/useThrottler.cjs.map +0 -1
  195. package/dist/throttler/useThrottler.d.cts +0 -157
  196. package/dist/throttler/useThrottler.js.map +0 -1
  197. package/dist/types/index.cjs +0 -9
  198. package/dist/types/index.d.cts +0 -1
  199. package/dist/utils/index.cjs +0 -9
  200. package/dist/utils/index.d.cts +0 -1
  201. package/src/async-batcher/index.ts +0 -4
  202. package/src/async-batcher/useAsyncBatchedCallback.ts +0 -53
  203. package/src/async-batcher/useAsyncBatcher.ts +0 -293
  204. package/src/async-debouncer/index.ts +0 -5
  205. package/src/async-debouncer/useAsyncDebouncedCallback.ts +0 -54
  206. package/src/async-debouncer/useAsyncDebouncer.ts +0 -274
  207. package/src/async-queuer/index.ts +0 -4
  208. package/src/async-queuer/useAsyncQueuedState.ts +0 -165
  209. package/src/async-queuer/useAsyncQueuer.ts +0 -293
  210. package/src/async-rate-limiter/index.ts +0 -5
  211. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +0 -69
  212. package/src/async-rate-limiter/useAsyncRateLimiter.ts +0 -294
  213. package/src/async-retryer/index.ts +0 -2
  214. package/src/async-throttler/index.ts +0 -5
  215. package/src/async-throttler/useAsyncThrottledCallback.ts +0 -52
  216. package/src/async-throttler/useAsyncThrottler.ts +0 -285
  217. package/src/batcher/index.ts +0 -4
  218. package/src/batcher/useBatchedCallback.ts +0 -46
  219. package/src/batcher/useBatcher.ts +0 -241
  220. package/src/debouncer/index.ts +0 -7
  221. package/src/debouncer/useDebouncedCallback.ts +0 -51
  222. package/src/debouncer/useDebouncedState.ts +0 -106
  223. package/src/debouncer/useDebouncedValue.ts +0 -109
  224. package/src/debouncer/useDebouncer.ts +0 -219
  225. package/src/index.ts +0 -56
  226. package/src/provider/PacerProvider.tsx +0 -70
  227. package/src/provider/index.ts +0 -1
  228. package/src/queuer/index.ts +0 -5
  229. package/src/queuer/useQueuedState.ts +0 -133
  230. package/src/queuer/useQueuedValue.ts +0 -129
  231. package/src/queuer/useQueuer.ts +0 -251
  232. package/src/rate-limiter/index.ts +0 -6
  233. package/src/rate-limiter/useRateLimitedCallback.ts +0 -68
  234. package/src/rate-limiter/useRateLimitedState.ts +0 -124
  235. package/src/rate-limiter/useRateLimitedValue.ts +0 -110
  236. package/src/rate-limiter/useRateLimiter.ts +0 -244
  237. package/src/throttler/index.ts +0 -7
  238. package/src/throttler/useThrottledCallback.ts +0 -52
  239. package/src/throttler/useThrottledState.ts +0 -118
  240. package/src/throttler/useThrottledValue.ts +0 -104
  241. package/src/throttler/useThrottler.ts +0 -224
  242. package/src/types/index.ts +0 -1
  243. package/src/utils/index.ts +0 -1
@@ -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,EAAE,EACpD,UAC6E;CAC7E,MAAM,QAAQA,4BAAU,IAAI,SAAS,SAAS;CAE9C,OAAO;EAAC,MAAM,MAAM;EAAO,MAAM;EAAS;EAAM"}
@@ -1,122 +0,0 @@
1
- import { PreactQueuer, PreactQueuerOptions } from "./useQueuer.cjs";
2
- import { Queuer, QueuerState } from "@tanstack/pacer/queuer";
3
-
4
- //#region src/queuer/useQueuedState.d.ts
5
- /**
6
- * A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality.
7
- * This hook provides both the current queue state and queue control methods.
8
- *
9
- * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
10
- * All queue operations are reflected in the state array returned by the hook.
11
- *
12
- * The queue can be started and stopped to automatically process items at a specified interval,
13
- * making it useful as a scheduler. When started, it will process one item per tick, with an
14
- * optional wait time between ticks.
15
- *
16
- * The hook returns a tuple containing:
17
- * - The current queue state as an array
18
- * - The queue instance with methods for queue manipulation
19
- *
20
- * ## State Management and Selector
21
- *
22
- * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
23
- * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
24
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
25
- *
26
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
27
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
28
- * full control over when your component updates. Only when you provide a selector will the
29
- * component re-render when the selected state values change.
30
- *
31
- * Available queuer state properties:
32
- * - `executionCount`: Number of items that have been processed by the queuer
33
- * - `expirationCount`: Number of items that have been removed due to expiration
34
- * - `isEmpty`: Whether the queuer has no items to process
35
- * - `isFull`: Whether the queuer has reached its maximum capacity
36
- * - `isIdle`: Whether the queuer is not currently processing any items
37
- * - `isRunning`: Whether the queuer is active and will process items automatically
38
- * - `items`: Array of items currently waiting to be processed
39
- * - `itemTimestamps`: Timestamps when items were added for expiration tracking
40
- * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
41
- * - `rejectionCount`: Number of items that have been rejected from being added
42
- * - `size`: Number of items currently in the queue
43
- * - `status`: Current processing status ('idle' | 'running' | 'stopped')
44
- *
45
- * @example
46
- * ```tsx
47
- * // Default behavior - no reactive state subscriptions
48
- * const [items, addItem, queue] = useQueuedState(
49
- * (item) => console.log('Processing:', item),
50
- * {
51
- * initialItems: ['item1', 'item2'],
52
- * started: true,
53
- * wait: 1000,
54
- * getPriority: (item) => item.priority
55
- * }
56
- * );
57
- *
58
- * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
59
- * const [items, addItem, queue] = useQueuedState(
60
- * (item) => console.log('Processing:', item),
61
- * { started: true, wait: 1000 },
62
- * (state) => ({
63
- * items: state.items,
64
- * size: state.size,
65
- * isEmpty: state.isEmpty
66
- * })
67
- * );
68
- *
69
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
70
- * const [items, addItem, queue] = useQueuedState(
71
- * (item) => console.log('Processing:', item),
72
- * { started: true, wait: 1000 },
73
- * (state) => ({
74
- * isRunning: state.isRunning,
75
- * isIdle: state.isIdle,
76
- * status: state.status,
77
- * pendingTick: state.pendingTick
78
- * })
79
- * );
80
- *
81
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
82
- * const [items, addItem, queue] = useQueuedState(
83
- * (item) => console.log('Processing:', item),
84
- * { started: true, wait: 1000 },
85
- * (state) => ({
86
- * executionCount: state.executionCount,
87
- * expirationCount: state.expirationCount,
88
- * rejectionCount: state.rejectionCount
89
- * })
90
- * );
91
- *
92
- * // Add items to queue
93
- * const handleAdd = (item) => {
94
- * addItem(item);
95
- * };
96
- *
97
- * // Start automatic processing
98
- * const startProcessing = () => {
99
- * queue.start();
100
- * };
101
- *
102
- * // Stop automatic processing
103
- * const stopProcessing = () => {
104
- * queue.stop();
105
- * };
106
- *
107
- * // Manual processing still available
108
- * const handleProcess = () => {
109
- * const nextItem = queue.getNextItem();
110
- * if (nextItem) {
111
- * processItem(nextItem);
112
- * }
113
- * };
114
- *
115
- * // Access the selected queuer state (will be empty object {} unless selector provided)
116
- * const { size, isRunning, executionCount } = queue.state;
117
- * ```
118
- */
119
- 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>];
120
- //#endregion
121
- export { useQueuedState };
122
- //# sourceMappingURL=useQueuedState.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useQueuedState.js","names":[],"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,EAAE,EACpD,UAC6E;CAC7E,MAAM,QAAQ,UAAU,IAAI,SAAS,SAAS;CAE9C,OAAO;EAAC,MAAM,MAAM;EAAO,MAAM;EAAS;EAAM"}
@@ -1,115 +0,0 @@
1
- const require_useQueuedState = require('./useQueuedState.cjs');
2
- let preact_hooks = require("preact/hooks");
3
-
4
- //#region src/queuer/useQueuedValue.ts
5
- /**
6
- * A Preact hook that creates a queued value that processes state changes in order with an optional delay.
7
- * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.
8
- *
9
- * The queued value will process changes in the order they are received, with optional delays between
10
- * processing each change. This is useful for handling state updates that need to be processed
11
- * in a specific order, like animations or sequential UI updates.
12
- *
13
- * The hook returns a tuple containing:
14
- * - The current queued value
15
- * - The queuer instance with control methods
16
- *
17
- * ## State Management and Selector
18
- *
19
- * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
20
- * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
21
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
22
- *
23
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
24
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
25
- * full control over when your component updates. Only when you provide a selector will the
26
- * component re-render when the selected state values change.
27
- *
28
- * Available queuer state properties:
29
- * - `executionCount`: Number of items that have been processed by the queuer
30
- * - `expirationCount`: Number of items that have been removed due to expiration
31
- * - `isEmpty`: Whether the queuer has no items to process
32
- * - `isFull`: Whether the queuer has reached its maximum capacity
33
- * - `isIdle`: Whether the queuer is not currently processing any items
34
- * - `isRunning`: Whether the queuer is active and will process items automatically
35
- * - `items`: Array of items currently waiting to be processed
36
- * - `itemTimestamps`: Timestamps when items were added for expiration tracking
37
- * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
38
- * - `rejectionCount`: Number of items that have been rejected from being added
39
- * - `size`: Number of items currently in the queue
40
- * - `status`: Current processing status ('idle' | 'running' | 'stopped')
41
- *
42
- * @example
43
- * ```tsx
44
- * // Default behavior - no reactive state subscriptions
45
- * const [value, queuer] = useQueuedValue(initialValue, {
46
- * wait: 500, // Wait 500ms between processing each change
47
- * started: true // Start processing immediately
48
- * });
49
- *
50
- * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)
51
- * const [value, queuer] = useQueuedValue(
52
- * initialValue,
53
- * { wait: 500, started: true },
54
- * (state) => ({
55
- * isRunning: state.isRunning,
56
- * isIdle: state.isIdle,
57
- * status: state.status,
58
- * pendingTick: state.pendingTick
59
- * })
60
- * );
61
- *
62
- * // Opt-in to re-render when queue contents change (optimized for displaying queue status)
63
- * const [value, queuer] = useQueuedValue(
64
- * initialValue,
65
- * { wait: 500, started: true },
66
- * (state) => ({
67
- * size: state.size,
68
- * isEmpty: state.isEmpty,
69
- * isFull: state.isFull
70
- * })
71
- * );
72
- *
73
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
74
- * const [value, queuer] = useQueuedValue(
75
- * initialValue,
76
- * { wait: 500, started: true },
77
- * (state) => ({
78
- * executionCount: state.executionCount,
79
- * expirationCount: state.expirationCount,
80
- * rejectionCount: state.rejectionCount
81
- * })
82
- * );
83
- *
84
- * // Add changes to the queue
85
- * const handleChange = (newValue) => {
86
- * queuer.addItem(newValue);
87
- * };
88
- *
89
- * // Control the queue
90
- * const pauseProcessing = () => {
91
- * queuer.stop();
92
- * };
93
- *
94
- * const resumeProcessing = () => {
95
- * queuer.start();
96
- * };
97
- *
98
- * // Access the selected queuer state (will be empty object {} unless selector provided)
99
- * const { size, isRunning, executionCount } = queuer.state;
100
- * ```
101
- */
102
- function useQueuedValue(initialValue, options = {}, selector) {
103
- const [value, setValue] = (0, preact_hooks.useState)(initialValue);
104
- const [, addItem, queuer] = require_useQueuedState.useQueuedState((item) => {
105
- setValue(item);
106
- }, options, selector);
107
- (0, preact_hooks.useEffect)(() => {
108
- addItem(initialValue);
109
- }, [initialValue, addItem]);
110
- return [value, queuer];
111
- }
112
-
113
- //#endregion
114
- exports.useQueuedValue = useQueuedValue;
115
- //# sourceMappingURL=useQueuedValue.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useQueuedValue.cjs","names":["useQueuedState"],"sources":["../../src/queuer/useQueuedValue.ts"],"sourcesContent":["import { useEffect, useState } from 'preact/hooks'\nimport { useQueuedState } from './useQueuedState'\nimport type { PreactQueuer, PreactQueuerOptions } from './useQueuer'\nimport type { QueuerState } from '@tanstack/pacer/queuer'\n\n/**\n * A Preact hook that creates a queued value that processes state changes in order with an optional delay.\n * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.\n *\n * The queued value will process changes in the order they are received, with optional delays between\n * processing each change. This is useful for handling state updates that need to be processed\n * in a specific order, like animations or sequential UI updates.\n *\n * The hook returns a tuple containing:\n * - The current queued value\n * - The queuer instance with control methods\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 [value, queuer] = useQueuedValue(initialValue, {\n * wait: 500, // Wait 500ms between processing each change\n * started: true // Start processing immediately\n * });\n *\n * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\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 queue contents change (optimized for displaying queue status)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\n * (state) => ({\n * size: state.size,\n * isEmpty: state.isEmpty,\n * isFull: state.isFull\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\n * (state) => ({\n * executionCount: state.executionCount,\n * expirationCount: state.expirationCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Add changes to the queue\n * const handleChange = (newValue) => {\n * queuer.addItem(newValue);\n * };\n *\n * // Control the queue\n * const pauseProcessing = () => {\n * queuer.stop();\n * };\n *\n * const resumeProcessing = () => {\n * queuer.start();\n * };\n *\n * // Access the selected queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queuer.state;\n * ```\n */\nexport function useQueuedValue<\n TValue,\n TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<\n QueuerState<TValue>,\n 'items'\n >,\n>(\n initialValue: TValue,\n options: PreactQueuerOptions<TValue, TSelected> = {},\n selector?: (state: QueuerState<TValue>) => TSelected,\n): [TValue, PreactQueuer<TValue, TSelected>] {\n const [value, setValue] = useState<TValue>(initialValue)\n\n const [, addItem, queuer] = useQueuedState(\n (item) => {\n setValue(item)\n },\n options,\n selector,\n )\n\n useEffect(() => {\n addItem(initialValue)\n }, [initialValue, addItem])\n\n return [value, queuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsGA,SAAgB,eAOd,cACA,UAAkD,EAAE,EACpD,UAC2C;CAC3C,MAAM,CAAC,OAAO,uCAA6B,aAAa;CAExD,MAAM,GAAG,SAAS,UAAUA,uCACzB,SAAS;EACR,SAAS,KAAK;IAEhB,SACA,SACD;CAED,kCAAgB;EACd,QAAQ,aAAa;IACpB,CAAC,cAAc,QAAQ,CAAC;CAE3B,OAAO,CAAC,OAAO,OAAO"}
@@ -1,105 +0,0 @@
1
- import { PreactQueuer, PreactQueuerOptions } from "./useQueuer.cjs";
2
- import { QueuerState } from "@tanstack/pacer/queuer";
3
-
4
- //#region src/queuer/useQueuedValue.d.ts
5
- /**
6
- * A Preact hook that creates a queued value that processes state changes in order with an optional delay.
7
- * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.
8
- *
9
- * The queued value will process changes in the order they are received, with optional delays between
10
- * processing each change. This is useful for handling state updates that need to be processed
11
- * in a specific order, like animations or sequential UI updates.
12
- *
13
- * The hook returns a tuple containing:
14
- * - The current queued value
15
- * - The queuer instance with control methods
16
- *
17
- * ## State Management and Selector
18
- *
19
- * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
20
- * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
21
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
22
- *
23
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
24
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
25
- * full control over when your component updates. Only when you provide a selector will the
26
- * component re-render when the selected state values change.
27
- *
28
- * Available queuer state properties:
29
- * - `executionCount`: Number of items that have been processed by the queuer
30
- * - `expirationCount`: Number of items that have been removed due to expiration
31
- * - `isEmpty`: Whether the queuer has no items to process
32
- * - `isFull`: Whether the queuer has reached its maximum capacity
33
- * - `isIdle`: Whether the queuer is not currently processing any items
34
- * - `isRunning`: Whether the queuer is active and will process items automatically
35
- * - `items`: Array of items currently waiting to be processed
36
- * - `itemTimestamps`: Timestamps when items were added for expiration tracking
37
- * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
38
- * - `rejectionCount`: Number of items that have been rejected from being added
39
- * - `size`: Number of items currently in the queue
40
- * - `status`: Current processing status ('idle' | 'running' | 'stopped')
41
- *
42
- * @example
43
- * ```tsx
44
- * // Default behavior - no reactive state subscriptions
45
- * const [value, queuer] = useQueuedValue(initialValue, {
46
- * wait: 500, // Wait 500ms between processing each change
47
- * started: true // Start processing immediately
48
- * });
49
- *
50
- * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)
51
- * const [value, queuer] = useQueuedValue(
52
- * initialValue,
53
- * { wait: 500, started: true },
54
- * (state) => ({
55
- * isRunning: state.isRunning,
56
- * isIdle: state.isIdle,
57
- * status: state.status,
58
- * pendingTick: state.pendingTick
59
- * })
60
- * );
61
- *
62
- * // Opt-in to re-render when queue contents change (optimized for displaying queue status)
63
- * const [value, queuer] = useQueuedValue(
64
- * initialValue,
65
- * { wait: 500, started: true },
66
- * (state) => ({
67
- * size: state.size,
68
- * isEmpty: state.isEmpty,
69
- * isFull: state.isFull
70
- * })
71
- * );
72
- *
73
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
74
- * const [value, queuer] = useQueuedValue(
75
- * initialValue,
76
- * { wait: 500, started: true },
77
- * (state) => ({
78
- * executionCount: state.executionCount,
79
- * expirationCount: state.expirationCount,
80
- * rejectionCount: state.rejectionCount
81
- * })
82
- * );
83
- *
84
- * // Add changes to the queue
85
- * const handleChange = (newValue) => {
86
- * queuer.addItem(newValue);
87
- * };
88
- *
89
- * // Control the queue
90
- * const pauseProcessing = () => {
91
- * queuer.stop();
92
- * };
93
- *
94
- * const resumeProcessing = () => {
95
- * queuer.start();
96
- * };
97
- *
98
- * // Access the selected queuer state (will be empty object {} unless selector provided)
99
- * const { size, isRunning, executionCount } = queuer.state;
100
- * ```
101
- */
102
- declare function useQueuedValue<TValue, TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<QueuerState<TValue>, 'items'>>(initialValue: TValue, options?: PreactQueuerOptions<TValue, TSelected>, selector?: (state: QueuerState<TValue>) => TSelected): [TValue, PreactQueuer<TValue, TSelected>];
103
- //#endregion
104
- export { useQueuedValue };
105
- //# sourceMappingURL=useQueuedValue.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useQueuedValue.js","names":[],"sources":["../../src/queuer/useQueuedValue.ts"],"sourcesContent":["import { useEffect, useState } from 'preact/hooks'\nimport { useQueuedState } from './useQueuedState'\nimport type { PreactQueuer, PreactQueuerOptions } from './useQueuer'\nimport type { QueuerState } from '@tanstack/pacer/queuer'\n\n/**\n * A Preact hook that creates a queued value that processes state changes in order with an optional delay.\n * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.\n *\n * The queued value will process changes in the order they are received, with optional delays between\n * processing each change. This is useful for handling state updates that need to be processed\n * in a specific order, like animations or sequential UI updates.\n *\n * The hook returns a tuple containing:\n * - The current queued value\n * - The queuer instance with control methods\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 [value, queuer] = useQueuedValue(initialValue, {\n * wait: 500, // Wait 500ms between processing each change\n * started: true // Start processing immediately\n * });\n *\n * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\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 queue contents change (optimized for displaying queue status)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\n * (state) => ({\n * size: state.size,\n * isEmpty: state.isEmpty,\n * isFull: state.isFull\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [value, queuer] = useQueuedValue(\n * initialValue,\n * { wait: 500, started: true },\n * (state) => ({\n * executionCount: state.executionCount,\n * expirationCount: state.expirationCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Add changes to the queue\n * const handleChange = (newValue) => {\n * queuer.addItem(newValue);\n * };\n *\n * // Control the queue\n * const pauseProcessing = () => {\n * queuer.stop();\n * };\n *\n * const resumeProcessing = () => {\n * queuer.start();\n * };\n *\n * // Access the selected queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queuer.state;\n * ```\n */\nexport function useQueuedValue<\n TValue,\n TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<\n QueuerState<TValue>,\n 'items'\n >,\n>(\n initialValue: TValue,\n options: PreactQueuerOptions<TValue, TSelected> = {},\n selector?: (state: QueuerState<TValue>) => TSelected,\n): [TValue, PreactQueuer<TValue, TSelected>] {\n const [value, setValue] = useState<TValue>(initialValue)\n\n const [, addItem, queuer] = useQueuedState(\n (item) => {\n setValue(item)\n },\n options,\n selector,\n )\n\n useEffect(() => {\n addItem(initialValue)\n }, [initialValue, addItem])\n\n return [value, queuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsGA,SAAgB,eAOd,cACA,UAAkD,EAAE,EACpD,UAC2C;CAC3C,MAAM,CAAC,OAAO,YAAY,SAAiB,aAAa;CAExD,MAAM,GAAG,SAAS,UAAU,gBACzB,SAAS;EACR,SAAS,KAAK;IAEhB,SACA,SACD;CAED,gBAAgB;EACd,QAAQ,aAAa;IACpB,CAAC,cAAc,QAAQ,CAAC;CAE3B,OAAO,CAAC,OAAO,OAAO"}