@tanstack/angular-pacer 0.20.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 (280) hide show
  1. package/README.md +165 -0
  2. package/dist/async-batcher/index.cjs +13 -0
  3. package/dist/async-batcher/index.d.cts +4 -0
  4. package/dist/async-batcher/index.d.ts +4 -0
  5. package/dist/async-batcher/index.js +6 -0
  6. package/dist/async-batcher/injectAsyncBatchedCallback.cjs +49 -0
  7. package/dist/async-batcher/injectAsyncBatchedCallback.cjs.map +1 -0
  8. package/dist/async-batcher/injectAsyncBatchedCallback.d.cts +45 -0
  9. package/dist/async-batcher/injectAsyncBatchedCallback.d.ts +45 -0
  10. package/dist/async-batcher/injectAsyncBatchedCallback.js +49 -0
  11. package/dist/async-batcher/injectAsyncBatchedCallback.js.map +1 -0
  12. package/dist/async-batcher/injectAsyncBatcher.cjs +61 -0
  13. package/dist/async-batcher/injectAsyncBatcher.cjs.map +1 -0
  14. package/dist/async-batcher/injectAsyncBatcher.d.cts +63 -0
  15. package/dist/async-batcher/injectAsyncBatcher.d.ts +63 -0
  16. package/dist/async-batcher/injectAsyncBatcher.js +61 -0
  17. package/dist/async-batcher/injectAsyncBatcher.js.map +1 -0
  18. package/dist/async-debouncer/index.cjs +13 -0
  19. package/dist/async-debouncer/index.d.cts +4 -0
  20. package/dist/async-debouncer/index.d.ts +4 -0
  21. package/dist/async-debouncer/index.js +6 -0
  22. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs +49 -0
  23. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs.map +1 -0
  24. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.cts +43 -0
  25. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.ts +43 -0
  26. package/dist/async-debouncer/injectAsyncDebouncedCallback.js +49 -0
  27. package/dist/async-debouncer/injectAsyncDebouncedCallback.js.map +1 -0
  28. package/dist/async-debouncer/injectAsyncDebouncer.cjs +83 -0
  29. package/dist/async-debouncer/injectAsyncDebouncer.cjs.map +1 -0
  30. package/dist/async-debouncer/injectAsyncDebouncer.d.cts +86 -0
  31. package/dist/async-debouncer/injectAsyncDebouncer.d.ts +86 -0
  32. package/dist/async-debouncer/injectAsyncDebouncer.js +83 -0
  33. package/dist/async-debouncer/injectAsyncDebouncer.js.map +1 -0
  34. package/dist/async-queuer/index.cjs +13 -0
  35. package/dist/async-queuer/index.d.cts +4 -0
  36. package/dist/async-queuer/index.d.ts +4 -0
  37. package/dist/async-queuer/index.js +6 -0
  38. package/dist/async-queuer/injectAsyncQueuedSignal.cjs +53 -0
  39. package/dist/async-queuer/injectAsyncQueuedSignal.cjs.map +1 -0
  40. package/dist/async-queuer/injectAsyncQueuedSignal.d.cts +55 -0
  41. package/dist/async-queuer/injectAsyncQueuedSignal.d.ts +55 -0
  42. package/dist/async-queuer/injectAsyncQueuedSignal.js +53 -0
  43. package/dist/async-queuer/injectAsyncQueuedSignal.js.map +1 -0
  44. package/dist/async-queuer/injectAsyncQueuer.cjs +61 -0
  45. package/dist/async-queuer/injectAsyncQueuer.cjs.map +1 -0
  46. package/dist/async-queuer/injectAsyncQueuer.d.cts +63 -0
  47. package/dist/async-queuer/injectAsyncQueuer.d.ts +63 -0
  48. package/dist/async-queuer/injectAsyncQueuer.js +61 -0
  49. package/dist/async-queuer/injectAsyncQueuer.js.map +1 -0
  50. package/dist/async-rate-limiter/index.cjs +13 -0
  51. package/dist/async-rate-limiter/index.d.cts +4 -0
  52. package/dist/async-rate-limiter/index.d.ts +4 -0
  53. package/dist/async-rate-limiter/index.js +6 -0
  54. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs +52 -0
  55. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs.map +1 -0
  56. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.cts +46 -0
  57. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.ts +46 -0
  58. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js +52 -0
  59. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js.map +1 -0
  60. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs +57 -0
  61. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs.map +1 -0
  62. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.cts +60 -0
  63. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.ts +60 -0
  64. package/dist/async-rate-limiter/injectAsyncRateLimiter.js +57 -0
  65. package/dist/async-rate-limiter/injectAsyncRateLimiter.js.map +1 -0
  66. package/dist/async-retryer/index.cjs +9 -0
  67. package/dist/async-retryer/index.d.cts +1 -0
  68. package/dist/async-retryer/index.d.ts +1 -0
  69. package/dist/async-retryer/index.js +3 -0
  70. package/dist/async-throttler/index.cjs +13 -0
  71. package/dist/async-throttler/index.d.cts +4 -0
  72. package/dist/async-throttler/index.d.ts +4 -0
  73. package/dist/async-throttler/index.js +6 -0
  74. package/dist/async-throttler/injectAsyncThrottledCallback.cjs +50 -0
  75. package/dist/async-throttler/injectAsyncThrottledCallback.cjs.map +1 -0
  76. package/dist/async-throttler/injectAsyncThrottledCallback.d.cts +44 -0
  77. package/dist/async-throttler/injectAsyncThrottledCallback.d.ts +44 -0
  78. package/dist/async-throttler/injectAsyncThrottledCallback.js +50 -0
  79. package/dist/async-throttler/injectAsyncThrottledCallback.js.map +1 -0
  80. package/dist/async-throttler/injectAsyncThrottler.cjs +62 -0
  81. package/dist/async-throttler/injectAsyncThrottler.cjs.map +1 -0
  82. package/dist/async-throttler/injectAsyncThrottler.d.cts +65 -0
  83. package/dist/async-throttler/injectAsyncThrottler.d.ts +65 -0
  84. package/dist/async-throttler/injectAsyncThrottler.js +62 -0
  85. package/dist/async-throttler/injectAsyncThrottler.js.map +1 -0
  86. package/dist/batcher/index.cjs +13 -0
  87. package/dist/batcher/index.d.cts +4 -0
  88. package/dist/batcher/index.d.ts +4 -0
  89. package/dist/batcher/index.js +6 -0
  90. package/dist/batcher/injectBatchedCallback.cjs +47 -0
  91. package/dist/batcher/injectBatchedCallback.cjs.map +1 -0
  92. package/dist/batcher/injectBatchedCallback.d.cts +43 -0
  93. package/dist/batcher/injectBatchedCallback.d.ts +43 -0
  94. package/dist/batcher/injectBatchedCallback.js +47 -0
  95. package/dist/batcher/injectBatchedCallback.js.map +1 -0
  96. package/dist/batcher/injectBatcher.cjs +56 -0
  97. package/dist/batcher/injectBatcher.cjs.map +1 -0
  98. package/dist/batcher/injectBatcher.d.cts +58 -0
  99. package/dist/batcher/injectBatcher.d.ts +58 -0
  100. package/dist/batcher/injectBatcher.js +56 -0
  101. package/dist/batcher/injectBatcher.js.map +1 -0
  102. package/dist/debouncer/index.cjs +17 -0
  103. package/dist/debouncer/index.d.cts +6 -0
  104. package/dist/debouncer/index.d.ts +6 -0
  105. package/dist/debouncer/index.js +8 -0
  106. package/dist/debouncer/injectDebouncedCallback.cjs +46 -0
  107. package/dist/debouncer/injectDebouncedCallback.cjs.map +1 -0
  108. package/dist/debouncer/injectDebouncedCallback.d.cts +43 -0
  109. package/dist/debouncer/injectDebouncedCallback.d.ts +43 -0
  110. package/dist/debouncer/injectDebouncedCallback.js +46 -0
  111. package/dist/debouncer/injectDebouncedCallback.js.map +1 -0
  112. package/dist/debouncer/injectDebouncedSignal.cjs +68 -0
  113. package/dist/debouncer/injectDebouncedSignal.cjs.map +1 -0
  114. package/dist/debouncer/injectDebouncedSignal.d.cts +65 -0
  115. package/dist/debouncer/injectDebouncedSignal.d.ts +65 -0
  116. package/dist/debouncer/injectDebouncedSignal.js +68 -0
  117. package/dist/debouncer/injectDebouncedSignal.js.map +1 -0
  118. package/dist/debouncer/injectDebouncedValue.cjs +17 -0
  119. package/dist/debouncer/injectDebouncedValue.cjs.map +1 -0
  120. package/dist/debouncer/injectDebouncedValue.d.cts +76 -0
  121. package/dist/debouncer/injectDebouncedValue.d.ts +76 -0
  122. package/dist/debouncer/injectDebouncedValue.js +17 -0
  123. package/dist/debouncer/injectDebouncedValue.js.map +1 -0
  124. package/dist/debouncer/injectDebouncer.cjs +76 -0
  125. package/dist/debouncer/injectDebouncer.cjs.map +1 -0
  126. package/dist/debouncer/injectDebouncer.d.cts +79 -0
  127. package/dist/debouncer/injectDebouncer.d.ts +79 -0
  128. package/dist/debouncer/injectDebouncer.js +76 -0
  129. package/dist/debouncer/injectDebouncer.js.map +1 -0
  130. package/dist/index.cjs +65 -0
  131. package/dist/index.d.cts +30 -0
  132. package/dist/index.d.ts +30 -0
  133. package/dist/index.js +32 -0
  134. package/dist/provider/index.cjs +7 -0
  135. package/dist/provider/index.d.cts +3 -0
  136. package/dist/provider/index.d.ts +3 -0
  137. package/dist/provider/index.js +4 -0
  138. package/dist/provider/pacer-context.cjs +20 -0
  139. package/dist/provider/pacer-context.cjs.map +1 -0
  140. package/dist/provider/pacer-context.d.cts +21 -0
  141. package/dist/provider/pacer-context.d.ts +21 -0
  142. package/dist/provider/pacer-context.js +19 -0
  143. package/dist/provider/pacer-context.js.map +1 -0
  144. package/dist/provider/pacer-provider.cjs +41 -0
  145. package/dist/provider/pacer-provider.cjs.map +1 -0
  146. package/dist/provider/pacer-provider.d.cts +36 -0
  147. package/dist/provider/pacer-provider.d.ts +36 -0
  148. package/dist/provider/pacer-provider.js +41 -0
  149. package/dist/provider/pacer-provider.js.map +1 -0
  150. package/dist/queuer/index.cjs +15 -0
  151. package/dist/queuer/index.d.cts +5 -0
  152. package/dist/queuer/index.d.ts +5 -0
  153. package/dist/queuer/index.js +7 -0
  154. package/dist/queuer/injectQueuedSignal.cjs +47 -0
  155. package/dist/queuer/injectQueuedSignal.cjs.map +1 -0
  156. package/dist/queuer/injectQueuedSignal.d.cts +49 -0
  157. package/dist/queuer/injectQueuedSignal.d.ts +49 -0
  158. package/dist/queuer/injectQueuedSignal.js +47 -0
  159. package/dist/queuer/injectQueuedSignal.js.map +1 -0
  160. package/dist/queuer/injectQueuedValue.cjs +23 -0
  161. package/dist/queuer/injectQueuedValue.cjs.map +1 -0
  162. package/dist/queuer/injectQueuedValue.d.cts +34 -0
  163. package/dist/queuer/injectQueuedValue.d.ts +34 -0
  164. package/dist/queuer/injectQueuedValue.js +23 -0
  165. package/dist/queuer/injectQueuedValue.js.map +1 -0
  166. package/dist/queuer/injectQueuer.cjs +61 -0
  167. package/dist/queuer/injectQueuer.cjs.map +1 -0
  168. package/dist/queuer/injectQueuer.d.cts +63 -0
  169. package/dist/queuer/injectQueuer.d.ts +63 -0
  170. package/dist/queuer/injectQueuer.js +61 -0
  171. package/dist/queuer/injectQueuer.js.map +1 -0
  172. package/dist/rate-limiter/index.cjs +17 -0
  173. package/dist/rate-limiter/index.d.cts +6 -0
  174. package/dist/rate-limiter/index.d.ts +6 -0
  175. package/dist/rate-limiter/index.js +8 -0
  176. package/dist/rate-limiter/injectRateLimitedCallback.cjs +45 -0
  177. package/dist/rate-limiter/injectRateLimitedCallback.cjs.map +1 -0
  178. package/dist/rate-limiter/injectRateLimitedCallback.d.cts +42 -0
  179. package/dist/rate-limiter/injectRateLimitedCallback.d.ts +42 -0
  180. package/dist/rate-limiter/injectRateLimitedCallback.js +45 -0
  181. package/dist/rate-limiter/injectRateLimitedCallback.js.map +1 -0
  182. package/dist/rate-limiter/injectRateLimitedSignal.cjs +62 -0
  183. package/dist/rate-limiter/injectRateLimitedSignal.cjs.map +1 -0
  184. package/dist/rate-limiter/injectRateLimitedSignal.d.cts +59 -0
  185. package/dist/rate-limiter/injectRateLimitedSignal.d.ts +59 -0
  186. package/dist/rate-limiter/injectRateLimitedSignal.js +62 -0
  187. package/dist/rate-limiter/injectRateLimitedSignal.js.map +1 -0
  188. package/dist/rate-limiter/injectRateLimitedValue.cjs +17 -0
  189. package/dist/rate-limiter/injectRateLimitedValue.cjs.map +1 -0
  190. package/dist/rate-limiter/injectRateLimitedValue.d.cts +49 -0
  191. package/dist/rate-limiter/injectRateLimitedValue.d.ts +49 -0
  192. package/dist/rate-limiter/injectRateLimitedValue.js +17 -0
  193. package/dist/rate-limiter/injectRateLimitedValue.js.map +1 -0
  194. package/dist/rate-limiter/injectRateLimiter.cjs +90 -0
  195. package/dist/rate-limiter/injectRateLimiter.cjs.map +1 -0
  196. package/dist/rate-limiter/injectRateLimiter.d.cts +93 -0
  197. package/dist/rate-limiter/injectRateLimiter.d.ts +93 -0
  198. package/dist/rate-limiter/injectRateLimiter.js +90 -0
  199. package/dist/rate-limiter/injectRateLimiter.js.map +1 -0
  200. package/dist/throttler/index.cjs +17 -0
  201. package/dist/throttler/index.d.cts +6 -0
  202. package/dist/throttler/index.d.ts +6 -0
  203. package/dist/throttler/index.js +8 -0
  204. package/dist/throttler/injectThrottledCallback.cjs +45 -0
  205. package/dist/throttler/injectThrottledCallback.cjs.map +1 -0
  206. package/dist/throttler/injectThrottledCallback.d.cts +42 -0
  207. package/dist/throttler/injectThrottledCallback.d.ts +42 -0
  208. package/dist/throttler/injectThrottledCallback.js +45 -0
  209. package/dist/throttler/injectThrottledCallback.js.map +1 -0
  210. package/dist/throttler/injectThrottledSignal.cjs +69 -0
  211. package/dist/throttler/injectThrottledSignal.cjs.map +1 -0
  212. package/dist/throttler/injectThrottledSignal.d.cts +66 -0
  213. package/dist/throttler/injectThrottledSignal.d.ts +66 -0
  214. package/dist/throttler/injectThrottledSignal.js +69 -0
  215. package/dist/throttler/injectThrottledSignal.js.map +1 -0
  216. package/dist/throttler/injectThrottledValue.cjs +17 -0
  217. package/dist/throttler/injectThrottledValue.cjs.map +1 -0
  218. package/dist/throttler/injectThrottledValue.d.cts +74 -0
  219. package/dist/throttler/injectThrottledValue.d.ts +74 -0
  220. package/dist/throttler/injectThrottledValue.js +17 -0
  221. package/dist/throttler/injectThrottledValue.js.map +1 -0
  222. package/dist/throttler/injectThrottler.cjs +76 -0
  223. package/dist/throttler/injectThrottler.cjs.map +1 -0
  224. package/dist/throttler/injectThrottler.d.cts +79 -0
  225. package/dist/throttler/injectThrottler.d.ts +79 -0
  226. package/dist/throttler/injectThrottler.js +76 -0
  227. package/dist/throttler/injectThrottler.js.map +1 -0
  228. package/dist/types/index.cjs +9 -0
  229. package/dist/types/index.d.cts +1 -0
  230. package/dist/types/index.d.ts +1 -0
  231. package/dist/types/index.js +3 -0
  232. package/dist/utils/index.cjs +9 -0
  233. package/dist/utils/index.d.cts +1 -0
  234. package/dist/utils/index.d.ts +1 -0
  235. package/dist/utils/index.js +3 -0
  236. package/package.json +121 -0
  237. package/src/async-batcher/index.ts +4 -0
  238. package/src/async-batcher/injectAsyncBatchedCallback.ts +48 -0
  239. package/src/async-batcher/injectAsyncBatcher.ts +87 -0
  240. package/src/async-debouncer/index.ts +4 -0
  241. package/src/async-debouncer/injectAsyncDebouncedCallback.ts +50 -0
  242. package/src/async-debouncer/injectAsyncDebouncer.ts +113 -0
  243. package/src/async-queuer/index.ts +4 -0
  244. package/src/async-queuer/injectAsyncQueuedSignal.ts +82 -0
  245. package/src/async-queuer/injectAsyncQueuer.ts +87 -0
  246. package/src/async-rate-limiter/index.ts +4 -0
  247. package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts +52 -0
  248. package/src/async-rate-limiter/injectAsyncRateLimiter.ts +87 -0
  249. package/src/async-retryer/index.ts +1 -0
  250. package/src/async-throttler/index.ts +4 -0
  251. package/src/async-throttler/injectAsyncThrottledCallback.ts +50 -0
  252. package/src/async-throttler/injectAsyncThrottler.ts +92 -0
  253. package/src/batcher/index.ts +4 -0
  254. package/src/batcher/injectBatchedCallback.ts +46 -0
  255. package/src/batcher/injectBatcher.ts +79 -0
  256. package/src/debouncer/index.ts +6 -0
  257. package/src/debouncer/injectDebouncedCallback.ts +46 -0
  258. package/src/debouncer/injectDebouncedSignal.ts +101 -0
  259. package/src/debouncer/injectDebouncedValue.ts +126 -0
  260. package/src/debouncer/injectDebouncer.ts +102 -0
  261. package/src/index.ts +40 -0
  262. package/src/provider/index.ts +2 -0
  263. package/src/provider/pacer-context.ts +46 -0
  264. package/src/provider/pacer-provider.ts +38 -0
  265. package/src/queuer/index.ts +5 -0
  266. package/src/queuer/injectQueuedSignal.ts +70 -0
  267. package/src/queuer/injectQueuedValue.ts +101 -0
  268. package/src/queuer/injectQueuer.ts +83 -0
  269. package/src/rate-limiter/index.ts +6 -0
  270. package/src/rate-limiter/injectRateLimitedCallback.ts +45 -0
  271. package/src/rate-limiter/injectRateLimitedSignal.ts +95 -0
  272. package/src/rate-limiter/injectRateLimitedValue.ts +99 -0
  273. package/src/rate-limiter/injectRateLimiter.ts +116 -0
  274. package/src/throttler/index.ts +6 -0
  275. package/src/throttler/injectThrottledCallback.ts +45 -0
  276. package/src/throttler/injectThrottledSignal.ts +102 -0
  277. package/src/throttler/injectThrottledValue.ts +124 -0
  278. package/src/throttler/injectThrottler.ts +102 -0
  279. package/src/types/index.ts +1 -0
  280. package/src/utils/index.ts +1 -0
@@ -0,0 +1,69 @@
1
+ const require_injectThrottler = require('./injectThrottler.cjs');
2
+ let _angular_core = require("@angular/core");
3
+
4
+ //#region src/throttler/injectThrottledSignal.ts
5
+ /**
6
+ * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
7
+ * This function provides both the current throttled value and methods to update it.
8
+ *
9
+ * The state value is updated at most once within the specified wait time.
10
+ * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
11
+ * or mouse movements.
12
+ *
13
+ * The function returns a callable object:
14
+ * - `throttled()`: Get the current throttled value
15
+ * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
16
+ * - `throttled.throttler`: The throttler instance with additional control methods and state signals
17
+ *
18
+ * ## State Management and Selector
19
+ *
20
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
21
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
22
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
23
+ *
24
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
25
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
26
+ * full control over when your component tracks state changes.
27
+ *
28
+ * Available throttler state properties:
29
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
30
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
31
+ * - `executionCount`: Number of function executions that have been completed
32
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
33
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
34
+ * - `lastExecutionTime`: Timestamp of the last execution
35
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
36
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
41
+ *
42
+ * // Get value
43
+ * console.log(throttledScrollY())
44
+ *
45
+ * // Set/update value (throttled)
46
+ * throttledScrollY.set(window.scrollY)
47
+ *
48
+ * // Access throttler
49
+ * console.log(throttledScrollY.throttler.state().isPending)
50
+ * ```
51
+ */
52
+ function injectThrottledSignal(value, initialOptions, selector) {
53
+ const throttledValue = (0, _angular_core.signal)(value);
54
+ const throttler = require_injectThrottler.injectThrottler((newValue) => {
55
+ if (typeof newValue === "function") throttledValue.update(newValue);
56
+ else throttledValue.set(newValue);
57
+ }, initialOptions, selector);
58
+ const set = (newValue) => {
59
+ throttler.maybeExecute(newValue);
60
+ };
61
+ return Object.assign(() => throttledValue(), {
62
+ set,
63
+ throttler
64
+ });
65
+ }
66
+
67
+ //#endregion
68
+ exports.injectThrottledSignal = injectThrottledSignal;
69
+ //# sourceMappingURL=injectThrottledSignal.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectThrottledSignal.cjs","names":["injectThrottler"],"sources":["../../src/throttler/injectThrottledSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectThrottler } from './injectThrottler'\nimport type { AngularThrottler } from './injectThrottler'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport type ThrottledSignal<TValue, TSelected = {}> = ((\n ...args: []\n) => TValue) & {\n /**\n * Set or update the throttled value. This calls `throttler.maybeExecute(...)`.\n */\n readonly set: Setter<TValue>\n /**\n * The throttler instance with additional control methods and state signals.\n */\n readonly throttler: AngularThrottler<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.\n * This function provides both the current throttled value and methods to update it.\n *\n * The state value is updated at most once within the specified wait time.\n * This is useful for handling frequent state updates that should be rate-limited, like scroll positions\n * or mouse movements.\n *\n * The function returns a callable object:\n * - `throttled()`: Get the current throttled value\n * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)\n * - `throttled.throttler`: The throttler instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions 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 updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })\n *\n * // Get value\n * console.log(throttledScrollY())\n *\n * // Set/update value (throttled)\n * throttledScrollY.set(window.scrollY)\n *\n * // Access throttler\n * console.log(throttledScrollY.throttler.state().isPending)\n * ```\n */\nexport function injectThrottledSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n const throttledValue = signal<TValue>(value)\n\n const throttler = injectThrottler(\n (newValue: TValue | ((prev: TValue) => TValue)) => {\n if (typeof newValue === 'function') {\n throttledValue.update(newValue as (prev: TValue) => TValue)\n } else {\n throttledValue.set(newValue)\n }\n },\n initialOptions,\n selector,\n )\n\n const set: Setter<TValue> = (\n newValue: TValue | ((prev: TValue) => TValue),\n ) => {\n throttler.maybeExecute(newValue)\n }\n\n const throttled = Object.assign(() => throttledValue(), {\n set,\n throttler,\n }) as ThrottledSignal<TValue, TSelected>\n\n return throttled\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,2CAAgC,MAAM;CAE5C,MAAM,YAAYA,yCACf,aAAkD;AACjD,MAAI,OAAO,aAAa,WACtB,gBAAe,OAAO,SAAqC;MAE3D,gBAAe,IAAI,SAAS;IAGhC,gBACA,SACD;CAED,MAAM,OACJ,aACG;AACH,YAAU,aAAa,SAAS;;AAQlC,QALkB,OAAO,aAAa,gBAAgB,EAAE;EACtD;EACA;EACD,CAAC"}
@@ -0,0 +1,66 @@
1
+ import { AngularThrottler } from "./injectThrottler.cjs";
2
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
3
+
4
+ //#region src/throttler/injectThrottledSignal.d.ts
5
+ type Setter<T> = (value: T | ((prev: T) => T)) => void;
6
+ type ThrottledSignal<TValue, TSelected = {}> = ((...args: []) => TValue) & {
7
+ /**
8
+ * Set or update the throttled value. This calls `throttler.maybeExecute(...)`.
9
+ */
10
+ readonly set: Setter<TValue>;
11
+ /**
12
+ * The throttler instance with additional control methods and state signals.
13
+ */
14
+ readonly throttler: AngularThrottler<Setter<TValue>, TSelected>;
15
+ };
16
+ /**
17
+ * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
18
+ * This function provides both the current throttled value and methods to update it.
19
+ *
20
+ * The state value is updated at most once within the specified wait time.
21
+ * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
22
+ * or mouse movements.
23
+ *
24
+ * The function returns a callable object:
25
+ * - `throttled()`: Get the current throttled value
26
+ * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
27
+ * - `throttled.throttler`: The throttler instance with additional control methods and state signals
28
+ *
29
+ * ## State Management and Selector
30
+ *
31
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
32
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
33
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
34
+ *
35
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
36
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
37
+ * full control over when your component tracks state changes.
38
+ *
39
+ * Available throttler state properties:
40
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
41
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
42
+ * - `executionCount`: Number of function executions that have been completed
43
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
44
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
45
+ * - `lastExecutionTime`: Timestamp of the last execution
46
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
47
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
52
+ *
53
+ * // Get value
54
+ * console.log(throttledScrollY())
55
+ *
56
+ * // Set/update value (throttled)
57
+ * throttledScrollY.set(window.scrollY)
58
+ *
59
+ * // Access throttler
60
+ * console.log(throttledScrollY.throttler.state().isPending)
61
+ * ```
62
+ */
63
+ declare function injectThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
64
+ //#endregion
65
+ export { ThrottledSignal, injectThrottledSignal };
66
+ //# sourceMappingURL=injectThrottledSignal.d.cts.map
@@ -0,0 +1,66 @@
1
+ import { AngularThrottler } from "./injectThrottler.js";
2
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
3
+
4
+ //#region src/throttler/injectThrottledSignal.d.ts
5
+ type Setter<T> = (value: T | ((prev: T) => T)) => void;
6
+ type ThrottledSignal<TValue, TSelected = {}> = ((...args: []) => TValue) & {
7
+ /**
8
+ * Set or update the throttled value. This calls `throttler.maybeExecute(...)`.
9
+ */
10
+ readonly set: Setter<TValue>;
11
+ /**
12
+ * The throttler instance with additional control methods and state signals.
13
+ */
14
+ readonly throttler: AngularThrottler<Setter<TValue>, TSelected>;
15
+ };
16
+ /**
17
+ * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
18
+ * This function provides both the current throttled value and methods to update it.
19
+ *
20
+ * The state value is updated at most once within the specified wait time.
21
+ * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
22
+ * or mouse movements.
23
+ *
24
+ * The function returns a callable object:
25
+ * - `throttled()`: Get the current throttled value
26
+ * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
27
+ * - `throttled.throttler`: The throttler instance with additional control methods and state signals
28
+ *
29
+ * ## State Management and Selector
30
+ *
31
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
32
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
33
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
34
+ *
35
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
36
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
37
+ * full control over when your component tracks state changes.
38
+ *
39
+ * Available throttler state properties:
40
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
41
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
42
+ * - `executionCount`: Number of function executions that have been completed
43
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
44
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
45
+ * - `lastExecutionTime`: Timestamp of the last execution
46
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
47
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
52
+ *
53
+ * // Get value
54
+ * console.log(throttledScrollY())
55
+ *
56
+ * // Set/update value (throttled)
57
+ * throttledScrollY.set(window.scrollY)
58
+ *
59
+ * // Access throttler
60
+ * console.log(throttledScrollY.throttler.state().isPending)
61
+ * ```
62
+ */
63
+ declare function injectThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
64
+ //#endregion
65
+ export { ThrottledSignal, injectThrottledSignal };
66
+ //# sourceMappingURL=injectThrottledSignal.d.ts.map
@@ -0,0 +1,69 @@
1
+ import { injectThrottler } from "./injectThrottler.js";
2
+ import { signal } from "@angular/core";
3
+
4
+ //#region src/throttler/injectThrottledSignal.ts
5
+ /**
6
+ * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
7
+ * This function provides both the current throttled value and methods to update it.
8
+ *
9
+ * The state value is updated at most once within the specified wait time.
10
+ * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
11
+ * or mouse movements.
12
+ *
13
+ * The function returns a callable object:
14
+ * - `throttled()`: Get the current throttled value
15
+ * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
16
+ * - `throttled.throttler`: The throttler instance with additional control methods and state signals
17
+ *
18
+ * ## State Management and Selector
19
+ *
20
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
21
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
22
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
23
+ *
24
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
25
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
26
+ * full control over when your component tracks state changes.
27
+ *
28
+ * Available throttler state properties:
29
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
30
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
31
+ * - `executionCount`: Number of function executions that have been completed
32
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
33
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
34
+ * - `lastExecutionTime`: Timestamp of the last execution
35
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
36
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
41
+ *
42
+ * // Get value
43
+ * console.log(throttledScrollY())
44
+ *
45
+ * // Set/update value (throttled)
46
+ * throttledScrollY.set(window.scrollY)
47
+ *
48
+ * // Access throttler
49
+ * console.log(throttledScrollY.throttler.state().isPending)
50
+ * ```
51
+ */
52
+ function injectThrottledSignal(value, initialOptions, selector) {
53
+ const throttledValue = signal(value);
54
+ const throttler = injectThrottler((newValue) => {
55
+ if (typeof newValue === "function") throttledValue.update(newValue);
56
+ else throttledValue.set(newValue);
57
+ }, initialOptions, selector);
58
+ const set = (newValue) => {
59
+ throttler.maybeExecute(newValue);
60
+ };
61
+ return Object.assign(() => throttledValue(), {
62
+ set,
63
+ throttler
64
+ });
65
+ }
66
+
67
+ //#endregion
68
+ export { injectThrottledSignal };
69
+ //# sourceMappingURL=injectThrottledSignal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectThrottledSignal.js","names":[],"sources":["../../src/throttler/injectThrottledSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectThrottler } from './injectThrottler'\nimport type { AngularThrottler } from './injectThrottler'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport type ThrottledSignal<TValue, TSelected = {}> = ((\n ...args: []\n) => TValue) & {\n /**\n * Set or update the throttled value. This calls `throttler.maybeExecute(...)`.\n */\n readonly set: Setter<TValue>\n /**\n * The throttler instance with additional control methods and state signals.\n */\n readonly throttler: AngularThrottler<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.\n * This function provides both the current throttled value and methods to update it.\n *\n * The state value is updated at most once within the specified wait time.\n * This is useful for handling frequent state updates that should be rate-limited, like scroll positions\n * or mouse movements.\n *\n * The function returns a callable object:\n * - `throttled()`: Get the current throttled value\n * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)\n * - `throttled.throttler`: The throttler instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions 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 updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })\n *\n * // Get value\n * console.log(throttledScrollY())\n *\n * // Set/update value (throttled)\n * throttledScrollY.set(window.scrollY)\n *\n * // Access throttler\n * console.log(throttledScrollY.throttler.state().isPending)\n * ```\n */\nexport function injectThrottledSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n const throttledValue = signal<TValue>(value)\n\n const throttler = injectThrottler(\n (newValue: TValue | ((prev: TValue) => TValue)) => {\n if (typeof newValue === 'function') {\n throttledValue.update(newValue as (prev: TValue) => TValue)\n } else {\n throttledValue.set(newValue)\n }\n },\n initialOptions,\n selector,\n )\n\n const set: Setter<TValue> = (\n newValue: TValue | ((prev: TValue) => TValue),\n ) => {\n throttler.maybeExecute(newValue)\n }\n\n const throttled = Object.assign(() => throttledValue(), {\n set,\n throttler,\n }) as ThrottledSignal<TValue, TSelected>\n\n return throttled\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,iBAAiB,OAAe,MAAM;CAE5C,MAAM,YAAY,iBACf,aAAkD;AACjD,MAAI,OAAO,aAAa,WACtB,gBAAe,OAAO,SAAqC;MAE3D,gBAAe,IAAI,SAAS;IAGhC,gBACA,SACD;CAED,MAAM,OACJ,aACG;AACH,YAAU,aAAa,SAAS;;AAQlC,QALkB,OAAO,aAAa,gBAAgB,EAAE;EACtD;EACA;EACD,CAAC"}
@@ -0,0 +1,17 @@
1
+ const require_injectThrottledSignal = require('./injectThrottledSignal.cjs');
2
+ let _angular_core = require("@angular/core");
3
+
4
+ //#region src/throttler/injectThrottledValue.ts
5
+ function injectThrottledValue(value, initialValueOrOptions, initialOptionsOrSelector, maybeSelector) {
6
+ const hasInitialValue = initialOptionsOrSelector !== void 0 && !(typeof initialOptionsOrSelector === "function") || maybeSelector !== void 0;
7
+ const throttledValue = require_injectThrottledSignal.injectThrottledSignal(hasInitialValue ? initialValueOrOptions : void 0, hasInitialValue ? initialOptionsOrSelector : initialValueOrOptions, hasInitialValue ? maybeSelector : initialOptionsOrSelector);
8
+ (0, _angular_core.effect)(() => {
9
+ const latest = value();
10
+ throttledValue.set(latest);
11
+ });
12
+ return throttledValue;
13
+ }
14
+
15
+ //#endregion
16
+ exports.injectThrottledValue = injectThrottledValue;
17
+ //# sourceMappingURL=injectThrottledValue.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectThrottledValue.cjs","names":["injectThrottledSignal"],"sources":["../../src/throttler/injectThrottledValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectThrottledSignal } from './injectThrottledSignal'\nimport type { ThrottledSignal } from './injectThrottledSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a throttled value that updates at most once within a specified time window.\n * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal\n * and updates the throttled value accordingly.\n *\n * The throttled value will update at most once within the specified wait time, regardless of\n * how frequently the input value changes.\n *\n * This is useful for deriving throttled values from signals that change frequently,\n * like scroll positions or mouse coordinates, where you want to limit how often downstream effects\n * or calculations occur.\n *\n * The function returns a throttled signal object containing:\n * - A Signal that provides the current throttled value\n * - The throttler instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions 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 updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const scrollY = signal(0)\n * const throttledScrollY = injectThrottledValue(scrollY, {\n * wait: 100, // Update at most once per 100ms\n * })\n *\n * // Opt-in to reactive updates when pending state changes\n * const throttledScrollYWithState = injectThrottledValue(\n * scrollY,\n * { wait: 100 },\n * (state) => ({ isPending: state.isPending }),\n * )\n *\n * // Read the throttled signal value\n * effect(() => {\n * updateUI(throttledScrollY())\n * })\n *\n * // Access throttler state via the returned object's state() signal\n * console.log('Is pending:', throttledScrollYWithState.state().isPending)\n *\n * // Control the throttler\n * throttledScrollY.cancel() // Cancel any pending updates\n * ```\n */\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValue: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValueOrOptions: TValue | ThrottlerOptions<Setter<TValue>>,\n initialOptionsOrSelector?:\n | ThrottlerOptions<Setter<TValue>>\n | ((state: ThrottlerState<Setter<TValue>>) => TSelected),\n maybeSelector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n const hasInitialValue =\n (initialOptionsOrSelector !== undefined && !hasSelector) ||\n maybeSelector !== undefined\n\n const initialValue = hasInitialValue\n ? (initialValueOrOptions as TValue)\n : (undefined as unknown as TValue)\n const initialOptions = hasInitialValue\n ? (initialOptionsOrSelector as ThrottlerOptions<Setter<TValue>>)\n : (initialValueOrOptions as ThrottlerOptions<Setter<TValue>>)\n const selector = hasInitialValue\n ? maybeSelector\n : (initialOptionsOrSelector as\n | ((state: ThrottlerState<Setter<TValue>>) => TSelected)\n | undefined)\n\n const throttledValue = injectThrottledSignal(\n initialValue,\n initialOptions,\n selector,\n )\n\n effect(() => {\n const latest = value()\n throttledValue.set(latest)\n })\n\n return throttledValue\n}\n"],"mappings":";;;;AAqFA,SAAgB,qBACd,OACA,uBACA,0BAGA,eACoC;CAGpC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,iBAAiBA,oDAZF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;AAED,iCAAa;EACX,MAAM,SAAS,OAAO;AACtB,iBAAe,IAAI,OAAO;GAC1B;AAEF,QAAO"}
@@ -0,0 +1,74 @@
1
+ import { ThrottledSignal } from "./injectThrottledSignal.cjs";
2
+ import { Signal } from "@angular/core";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/injectThrottledValue.d.ts
6
+ type Setter<T> = (value: T | ((prev: T) => T)) => void;
7
+ /**
8
+ * An Angular function that creates a throttled value that updates at most once within a specified time window.
9
+ * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal
10
+ * and updates the throttled value accordingly.
11
+ *
12
+ * The throttled value will update at most once within the specified wait time, regardless of
13
+ * how frequently the input value changes.
14
+ *
15
+ * This is useful for deriving throttled values from signals that change frequently,
16
+ * like scroll positions or mouse coordinates, where you want to limit how often downstream effects
17
+ * or calculations occur.
18
+ *
19
+ * The function returns a throttled signal object containing:
20
+ * - A Signal that provides the current throttled value
21
+ * - The throttler instance with control methods
22
+ *
23
+ * ## State Management and Selector
24
+ *
25
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
26
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
27
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
28
+ *
29
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
30
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
31
+ * full control over when your component tracks state changes.
32
+ *
33
+ * Available throttler state properties:
34
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
35
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
36
+ * - `executionCount`: Number of function executions that have been completed
37
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
38
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
39
+ * - `lastExecutionTime`: Timestamp of the last execution
40
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
41
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Default behavior - no reactive state subscriptions
46
+ * const scrollY = signal(0)
47
+ * const throttledScrollY = injectThrottledValue(scrollY, {
48
+ * wait: 100, // Update at most once per 100ms
49
+ * })
50
+ *
51
+ * // Opt-in to reactive updates when pending state changes
52
+ * const throttledScrollYWithState = injectThrottledValue(
53
+ * scrollY,
54
+ * { wait: 100 },
55
+ * (state) => ({ isPending: state.isPending }),
56
+ * )
57
+ *
58
+ * // Read the throttled signal value
59
+ * effect(() => {
60
+ * updateUI(throttledScrollY())
61
+ * })
62
+ *
63
+ * // Access throttler state via the returned object's state() signal
64
+ * console.log('Is pending:', throttledScrollYWithState.state().isPending)
65
+ *
66
+ * // Control the throttler
67
+ * throttledScrollY.cancel() // Cancel any pending updates
68
+ * ```
69
+ */
70
+ declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
71
+ declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialValue: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
72
+ //#endregion
73
+ export { injectThrottledValue };
74
+ //# sourceMappingURL=injectThrottledValue.d.cts.map
@@ -0,0 +1,74 @@
1
+ import { ThrottledSignal } from "./injectThrottledSignal.js";
2
+ import { Signal } from "@angular/core";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/injectThrottledValue.d.ts
6
+ type Setter<T> = (value: T | ((prev: T) => T)) => void;
7
+ /**
8
+ * An Angular function that creates a throttled value that updates at most once within a specified time window.
9
+ * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal
10
+ * and updates the throttled value accordingly.
11
+ *
12
+ * The throttled value will update at most once within the specified wait time, regardless of
13
+ * how frequently the input value changes.
14
+ *
15
+ * This is useful for deriving throttled values from signals that change frequently,
16
+ * like scroll positions or mouse coordinates, where you want to limit how often downstream effects
17
+ * or calculations occur.
18
+ *
19
+ * The function returns a throttled signal object containing:
20
+ * - A Signal that provides the current throttled value
21
+ * - The throttler instance with control methods
22
+ *
23
+ * ## State Management and Selector
24
+ *
25
+ * The function uses TanStack Store for reactive state management via the underlying throttler instance.
26
+ * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
27
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
28
+ *
29
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
30
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
31
+ * full control over when your component tracks state changes.
32
+ *
33
+ * Available throttler state properties:
34
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
35
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
36
+ * - `executionCount`: Number of function executions that have been completed
37
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
38
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
39
+ * - `lastExecutionTime`: Timestamp of the last execution
40
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
41
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Default behavior - no reactive state subscriptions
46
+ * const scrollY = signal(0)
47
+ * const throttledScrollY = injectThrottledValue(scrollY, {
48
+ * wait: 100, // Update at most once per 100ms
49
+ * })
50
+ *
51
+ * // Opt-in to reactive updates when pending state changes
52
+ * const throttledScrollYWithState = injectThrottledValue(
53
+ * scrollY,
54
+ * { wait: 100 },
55
+ * (state) => ({ isPending: state.isPending }),
56
+ * )
57
+ *
58
+ * // Read the throttled signal value
59
+ * effect(() => {
60
+ * updateUI(throttledScrollY())
61
+ * })
62
+ *
63
+ * // Access throttler state via the returned object's state() signal
64
+ * console.log('Is pending:', throttledScrollYWithState.state().isPending)
65
+ *
66
+ * // Control the throttler
67
+ * throttledScrollY.cancel() // Cancel any pending updates
68
+ * ```
69
+ */
70
+ declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
71
+ declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialValue: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
72
+ //#endregion
73
+ export { injectThrottledValue };
74
+ //# sourceMappingURL=injectThrottledValue.d.ts.map
@@ -0,0 +1,17 @@
1
+ import { injectThrottledSignal } from "./injectThrottledSignal.js";
2
+ import { effect } from "@angular/core";
3
+
4
+ //#region src/throttler/injectThrottledValue.ts
5
+ function injectThrottledValue(value, initialValueOrOptions, initialOptionsOrSelector, maybeSelector) {
6
+ const hasInitialValue = initialOptionsOrSelector !== void 0 && !(typeof initialOptionsOrSelector === "function") || maybeSelector !== void 0;
7
+ const throttledValue = injectThrottledSignal(hasInitialValue ? initialValueOrOptions : void 0, hasInitialValue ? initialOptionsOrSelector : initialValueOrOptions, hasInitialValue ? maybeSelector : initialOptionsOrSelector);
8
+ effect(() => {
9
+ const latest = value();
10
+ throttledValue.set(latest);
11
+ });
12
+ return throttledValue;
13
+ }
14
+
15
+ //#endregion
16
+ export { injectThrottledValue };
17
+ //# sourceMappingURL=injectThrottledValue.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectThrottledValue.js","names":[],"sources":["../../src/throttler/injectThrottledValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectThrottledSignal } from './injectThrottledSignal'\nimport type { ThrottledSignal } from './injectThrottledSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a throttled value that updates at most once within a specified time window.\n * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal\n * and updates the throttled value accordingly.\n *\n * The throttled value will update at most once within the specified wait time, regardless of\n * how frequently the input value changes.\n *\n * This is useful for deriving throttled values from signals that change frequently,\n * like scroll positions or mouse coordinates, where you want to limit how often downstream effects\n * or calculations occur.\n *\n * The function returns a throttled signal object containing:\n * - A Signal that provides the current throttled value\n * - The throttler instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions 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 updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const scrollY = signal(0)\n * const throttledScrollY = injectThrottledValue(scrollY, {\n * wait: 100, // Update at most once per 100ms\n * })\n *\n * // Opt-in to reactive updates when pending state changes\n * const throttledScrollYWithState = injectThrottledValue(\n * scrollY,\n * { wait: 100 },\n * (state) => ({ isPending: state.isPending }),\n * )\n *\n * // Read the throttled signal value\n * effect(() => {\n * updateUI(throttledScrollY())\n * })\n *\n * // Access throttler state via the returned object's state() signal\n * console.log('Is pending:', throttledScrollYWithState.state().isPending)\n *\n * // Control the throttler\n * throttledScrollY.cancel() // Cancel any pending updates\n * ```\n */\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValue: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValueOrOptions: TValue | ThrottlerOptions<Setter<TValue>>,\n initialOptionsOrSelector?:\n | ThrottlerOptions<Setter<TValue>>\n | ((state: ThrottlerState<Setter<TValue>>) => TSelected),\n maybeSelector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n const hasInitialValue =\n (initialOptionsOrSelector !== undefined && !hasSelector) ||\n maybeSelector !== undefined\n\n const initialValue = hasInitialValue\n ? (initialValueOrOptions as TValue)\n : (undefined as unknown as TValue)\n const initialOptions = hasInitialValue\n ? (initialOptionsOrSelector as ThrottlerOptions<Setter<TValue>>)\n : (initialValueOrOptions as ThrottlerOptions<Setter<TValue>>)\n const selector = hasInitialValue\n ? maybeSelector\n : (initialOptionsOrSelector as\n | ((state: ThrottlerState<Setter<TValue>>) => TSelected)\n | undefined)\n\n const throttledValue = injectThrottledSignal(\n initialValue,\n initialOptions,\n selector,\n )\n\n effect(() => {\n const latest = value()\n throttledValue.set(latest)\n })\n\n return throttledValue\n}\n"],"mappings":";;;;AAqFA,SAAgB,qBACd,OACA,uBACA,0BAGA,eACoC;CAGpC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,iBAAiB,sBAZF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;AAED,cAAa;EACX,MAAM,SAAS,OAAO;AACtB,iBAAe,IAAI,OAAO;GAC1B;AAEF,QAAO"}
@@ -0,0 +1,76 @@
1
+ const require_pacer_context = require('../provider/pacer-context.cjs');
2
+ let _tanstack_angular_store = require("@tanstack/angular-store");
3
+ let _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
4
+
5
+ //#region src/throttler/injectThrottler.ts
6
+ /**
7
+ * An Angular function that creates and manages a Throttler instance.
8
+ *
9
+ * This is a lower-level function that provides direct access to the Throttler's functionality.
10
+ * This allows you to integrate it with any state management solution you prefer.
11
+ *
12
+ * This function provides throttling functionality to limit how often a function can be called,
13
+ * ensuring it executes at most once within a specified time window.
14
+ *
15
+ * The throttler will execute the function immediately (if leading is enabled) and then
16
+ * prevent further executions until the wait period has elapsed.
17
+ *
18
+ * ## State Management and Selector
19
+ *
20
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
21
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
22
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
23
+ *
24
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
25
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
26
+ * full control over when your component tracks state changes.
27
+ *
28
+ * Available state properties:
29
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
30
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
31
+ * - `executionCount`: Number of function executions that have been completed
32
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
33
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
34
+ * - `lastExecutionTime`: Timestamp of the last execution
35
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
36
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * // Default behavior - no reactive state subscriptions
41
+ * const throttler = injectThrottler(
42
+ * (scrollY: number) => updateScrollPosition(scrollY),
43
+ * { wait: 100 }
44
+ * );
45
+ *
46
+ * // Opt-in to track isPending changes (optimized for loading states)
47
+ * const throttler = injectThrottler(
48
+ * (scrollY: number) => updateScrollPosition(scrollY),
49
+ * { wait: 100 },
50
+ * (state) => ({ isPending: state.isPending })
51
+ * );
52
+ *
53
+ * // In an event handler
54
+ * window.addEventListener('scroll', () => {
55
+ * throttler.maybeExecute(window.scrollY);
56
+ * });
57
+ *
58
+ * // Access the selected state (will be empty object {} unless selector provided)
59
+ * const { isPending } = throttler.state();
60
+ * ```
61
+ */
62
+ function injectThrottler(fn, options, selector = () => ({})) {
63
+ const throttler = new _tanstack_pacer_throttler.Throttler(fn, {
64
+ ...require_pacer_context.injectPacerOptions().throttler,
65
+ ...options
66
+ });
67
+ const state = (0, _tanstack_angular_store.injectStore)(throttler.store, selector);
68
+ return {
69
+ ...throttler,
70
+ state
71
+ };
72
+ }
73
+
74
+ //#endregion
75
+ exports.injectThrottler = injectThrottler;
76
+ //# sourceMappingURL=injectThrottler.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectThrottler.cjs","names":["Throttler","injectPacerOptions"],"sources":["../../src/throttler/injectThrottler.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface AngularThrottler<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n /**\n * Reactive state signal that will be updated when the throttler state changes\n *\n * Use this instead of `throttler.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n * The state on the store object is not reactive in Angular signals.\n */\n readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages a Throttler instance.\n *\n * This is a lower-level function that provides direct access to the Throttler's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides throttling functionality to limit how often a function can be called,\n * ensuring it executes at most once within a specified time window.\n *\n * The throttler will execute the function immediately (if leading is enabled) and then\n * prevent further executions until the wait period has elapsed.\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates 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 updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const throttler = injectThrottler(\n * (scrollY: number) => updateScrollPosition(scrollY),\n * { wait: 100 }\n * );\n *\n * // Opt-in to track isPending changes (optimized for loading states)\n * const throttler = injectThrottler(\n * (scrollY: number) => updateScrollPosition(scrollY),\n * { wait: 100 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // In an event handler\n * window.addEventListener('scroll', () => {\n * throttler.maybeExecute(window.scrollY);\n * });\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = throttler.state();\n * ```\n */\nexport function injectThrottler<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: ThrottlerOptions<TFn>,\n selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().throttler,\n ...options,\n } as ThrottlerOptions<TFn>\n\n const throttler = new Throttler<TFn>(fn, mergedOptions)\n const state = injectStore(throttler.store, selector)\n\n return {\n ...throttler,\n state,\n } as AngularThrottler<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC7B;CAMlC,MAAM,YAAY,IAAIA,oCAAe,IALf;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAEsD;CACvD,MAAM,iDAAoB,UAAU,OAAO,SAAS;AAEpD,QAAO;EACL,GAAG;EACH;EACD"}