@tanstack/angular-pacer 0.24.0 → 0.25.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 (250) hide show
  1. package/README.md +4 -4
  2. package/dist/async-batcher/injectAsyncBatchedCallback.d.ts +2 -4
  3. package/dist/async-batcher/injectAsyncBatchedCallback.js +1 -2
  4. package/dist/async-batcher/injectAsyncBatcher.d.ts +4 -6
  5. package/dist/async-batcher/injectAsyncBatcher.js +1 -2
  6. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.ts +2 -4
  7. package/dist/async-debouncer/injectAsyncDebouncedCallback.js +1 -2
  8. package/dist/async-debouncer/injectAsyncDebouncer.d.ts +4 -6
  9. package/dist/async-debouncer/injectAsyncDebouncer.js +1 -2
  10. package/dist/async-queuer/injectAsyncQueuedSignal.d.ts +3 -5
  11. package/dist/async-queuer/injectAsyncQueuedSignal.js +1 -2
  12. package/dist/async-queuer/injectAsyncQueuer.d.ts +4 -6
  13. package/dist/async-queuer/injectAsyncQueuer.js +1 -2
  14. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.ts +2 -4
  15. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js +1 -2
  16. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.ts +4 -6
  17. package/dist/async-rate-limiter/injectAsyncRateLimiter.js +1 -2
  18. package/dist/async-throttler/injectAsyncThrottledCallback.d.ts +2 -4
  19. package/dist/async-throttler/injectAsyncThrottledCallback.js +1 -2
  20. package/dist/async-throttler/injectAsyncThrottler.d.ts +4 -6
  21. package/dist/async-throttler/injectAsyncThrottler.js +1 -2
  22. package/dist/batcher/injectBatchedCallback.d.ts +2 -4
  23. package/dist/batcher/injectBatchedCallback.js +1 -2
  24. package/dist/batcher/injectBatcher.d.ts +4 -6
  25. package/dist/batcher/injectBatcher.js +1 -2
  26. package/dist/debouncer/injectDebouncedCallback.d.ts +2 -4
  27. package/dist/debouncer/injectDebouncedCallback.js +1 -2
  28. package/dist/debouncer/injectDebouncedSignal.d.ts +3 -5
  29. package/dist/debouncer/injectDebouncedSignal.js +1 -2
  30. package/dist/debouncer/injectDebouncedValue.d.ts +3 -5
  31. package/dist/debouncer/injectDebouncedValue.js +1 -2
  32. package/dist/debouncer/injectDebouncer.d.ts +4 -6
  33. package/dist/debouncer/injectDebouncer.js +1 -2
  34. package/dist/provider/pacer-context.d.ts +4 -6
  35. package/dist/provider/pacer-context.js +1 -2
  36. package/dist/provider/pacer-provider.d.ts +2 -4
  37. package/dist/provider/pacer-provider.js +1 -2
  38. package/dist/queuer/injectQueuedSignal.d.ts +3 -5
  39. package/dist/queuer/injectQueuedSignal.js +1 -2
  40. package/dist/queuer/injectQueuedValue.d.ts +3 -5
  41. package/dist/queuer/injectQueuedValue.js +1 -2
  42. package/dist/queuer/injectQueuer.d.ts +4 -6
  43. package/dist/queuer/injectQueuer.js +1 -2
  44. package/dist/rate-limiter/injectRateLimitedCallback.d.ts +2 -4
  45. package/dist/rate-limiter/injectRateLimitedCallback.js +1 -2
  46. package/dist/rate-limiter/injectRateLimitedSignal.d.ts +3 -5
  47. package/dist/rate-limiter/injectRateLimitedSignal.js +1 -2
  48. package/dist/rate-limiter/injectRateLimitedValue.d.ts +3 -5
  49. package/dist/rate-limiter/injectRateLimitedValue.js +1 -2
  50. package/dist/rate-limiter/injectRateLimiter.d.ts +4 -6
  51. package/dist/rate-limiter/injectRateLimiter.js +1 -2
  52. package/dist/throttler/injectThrottledCallback.d.ts +2 -4
  53. package/dist/throttler/injectThrottledCallback.js +1 -2
  54. package/dist/throttler/injectThrottledSignal.d.ts +3 -7
  55. package/dist/throttler/injectThrottledSignal.js +1 -4
  56. package/dist/throttler/injectThrottledValue.d.ts +3 -7
  57. package/dist/throttler/injectThrottledValue.js +1 -2
  58. package/dist/throttler/injectThrottler.d.ts +4 -8
  59. package/dist/throttler/injectThrottler.js +1 -4
  60. package/package.json +24 -71
  61. package/dist/async-batcher/index.cjs +0 -13
  62. package/dist/async-batcher/index.d.cts +0 -4
  63. package/dist/async-batcher/injectAsyncBatchedCallback.cjs +0 -49
  64. package/dist/async-batcher/injectAsyncBatchedCallback.cjs.map +0 -1
  65. package/dist/async-batcher/injectAsyncBatchedCallback.d.cts +0 -44
  66. package/dist/async-batcher/injectAsyncBatchedCallback.js.map +0 -1
  67. package/dist/async-batcher/injectAsyncBatcher.cjs +0 -85
  68. package/dist/async-batcher/injectAsyncBatcher.cjs.map +0 -1
  69. package/dist/async-batcher/injectAsyncBatcher.d.cts +0 -84
  70. package/dist/async-batcher/injectAsyncBatcher.js.map +0 -1
  71. package/dist/async-debouncer/index.cjs +0 -13
  72. package/dist/async-debouncer/index.d.cts +0 -4
  73. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs +0 -49
  74. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs.map +0 -1
  75. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.cts +0 -42
  76. package/dist/async-debouncer/injectAsyncDebouncedCallback.js.map +0 -1
  77. package/dist/async-debouncer/injectAsyncDebouncer.cjs +0 -107
  78. package/dist/async-debouncer/injectAsyncDebouncer.cjs.map +0 -1
  79. package/dist/async-debouncer/injectAsyncDebouncer.d.cts +0 -107
  80. package/dist/async-debouncer/injectAsyncDebouncer.js.map +0 -1
  81. package/dist/async-queuer/index.cjs +0 -13
  82. package/dist/async-queuer/index.d.cts +0 -4
  83. package/dist/async-queuer/injectAsyncQueuedSignal.cjs +0 -53
  84. package/dist/async-queuer/injectAsyncQueuedSignal.cjs.map +0 -1
  85. package/dist/async-queuer/injectAsyncQueuedSignal.d.cts +0 -49
  86. package/dist/async-queuer/injectAsyncQueuedSignal.js.map +0 -1
  87. package/dist/async-queuer/injectAsyncQueuer.cjs +0 -85
  88. package/dist/async-queuer/injectAsyncQueuer.cjs.map +0 -1
  89. package/dist/async-queuer/injectAsyncQueuer.d.cts +0 -84
  90. package/dist/async-queuer/injectAsyncQueuer.js.map +0 -1
  91. package/dist/async-rate-limiter/index.cjs +0 -13
  92. package/dist/async-rate-limiter/index.d.cts +0 -4
  93. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs +0 -52
  94. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs.map +0 -1
  95. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.cts +0 -45
  96. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js.map +0 -1
  97. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs +0 -69
  98. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs.map +0 -1
  99. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.cts +0 -71
  100. package/dist/async-rate-limiter/injectAsyncRateLimiter.js.map +0 -1
  101. package/dist/async-retryer/index.cjs +0 -8
  102. package/dist/async-retryer/index.d.cts +0 -1
  103. package/dist/async-throttler/index.cjs +0 -13
  104. package/dist/async-throttler/index.d.cts +0 -4
  105. package/dist/async-throttler/injectAsyncThrottledCallback.cjs +0 -50
  106. package/dist/async-throttler/injectAsyncThrottledCallback.cjs.map +0 -1
  107. package/dist/async-throttler/injectAsyncThrottledCallback.d.cts +0 -43
  108. package/dist/async-throttler/injectAsyncThrottledCallback.js.map +0 -1
  109. package/dist/async-throttler/injectAsyncThrottler.cjs +0 -86
  110. package/dist/async-throttler/injectAsyncThrottler.cjs.map +0 -1
  111. package/dist/async-throttler/injectAsyncThrottler.d.cts +0 -86
  112. package/dist/async-throttler/injectAsyncThrottler.js.map +0 -1
  113. package/dist/batcher/index.cjs +0 -13
  114. package/dist/batcher/index.d.cts +0 -4
  115. package/dist/batcher/injectBatchedCallback.cjs +0 -47
  116. package/dist/batcher/injectBatchedCallback.cjs.map +0 -1
  117. package/dist/batcher/injectBatchedCallback.d.cts +0 -42
  118. package/dist/batcher/injectBatchedCallback.js.map +0 -1
  119. package/dist/batcher/injectBatcher.cjs +0 -75
  120. package/dist/batcher/injectBatcher.cjs.map +0 -1
  121. package/dist/batcher/injectBatcher.d.cts +0 -76
  122. package/dist/batcher/injectBatcher.js.map +0 -1
  123. package/dist/debouncer/index.cjs +0 -17
  124. package/dist/debouncer/index.d.cts +0 -6
  125. package/dist/debouncer/injectDebouncedCallback.cjs +0 -46
  126. package/dist/debouncer/injectDebouncedCallback.cjs.map +0 -1
  127. package/dist/debouncer/injectDebouncedCallback.d.cts +0 -42
  128. package/dist/debouncer/injectDebouncedCallback.js.map +0 -1
  129. package/dist/debouncer/injectDebouncedSignal.cjs +0 -68
  130. package/dist/debouncer/injectDebouncedSignal.cjs.map +0 -1
  131. package/dist/debouncer/injectDebouncedSignal.d.cts +0 -59
  132. package/dist/debouncer/injectDebouncedSignal.js.map +0 -1
  133. package/dist/debouncer/injectDebouncedValue.cjs +0 -17
  134. package/dist/debouncer/injectDebouncedValue.cjs.map +0 -1
  135. package/dist/debouncer/injectDebouncedValue.d.cts +0 -75
  136. package/dist/debouncer/injectDebouncedValue.js.map +0 -1
  137. package/dist/debouncer/injectDebouncer.cjs +0 -95
  138. package/dist/debouncer/injectDebouncer.cjs.map +0 -1
  139. package/dist/debouncer/injectDebouncer.d.cts +0 -97
  140. package/dist/debouncer/injectDebouncer.js.map +0 -1
  141. package/dist/index.cjs +0 -65
  142. package/dist/index.d.cts +0 -30
  143. package/dist/provider/index.cjs +0 -7
  144. package/dist/provider/index.d.cts +0 -3
  145. package/dist/provider/pacer-context.cjs +0 -20
  146. package/dist/provider/pacer-context.cjs.map +0 -1
  147. package/dist/provider/pacer-context.d.cts +0 -20
  148. package/dist/provider/pacer-context.js.map +0 -1
  149. package/dist/provider/pacer-provider.cjs +0 -41
  150. package/dist/provider/pacer-provider.cjs.map +0 -1
  151. package/dist/provider/pacer-provider.d.cts +0 -35
  152. package/dist/provider/pacer-provider.js.map +0 -1
  153. package/dist/queuer/index.cjs +0 -15
  154. package/dist/queuer/index.d.cts +0 -5
  155. package/dist/queuer/injectQueuedSignal.cjs +0 -47
  156. package/dist/queuer/injectQueuedSignal.cjs.map +0 -1
  157. package/dist/queuer/injectQueuedSignal.d.cts +0 -43
  158. package/dist/queuer/injectQueuedSignal.js.map +0 -1
  159. package/dist/queuer/injectQueuedValue.cjs +0 -23
  160. package/dist/queuer/injectQueuedValue.cjs.map +0 -1
  161. package/dist/queuer/injectQueuedValue.d.cts +0 -33
  162. package/dist/queuer/injectQueuedValue.js.map +0 -1
  163. package/dist/queuer/injectQueuer.cjs +0 -80
  164. package/dist/queuer/injectQueuer.cjs.map +0 -1
  165. package/dist/queuer/injectQueuer.d.cts +0 -81
  166. package/dist/queuer/injectQueuer.js.map +0 -1
  167. package/dist/rate-limiter/index.cjs +0 -17
  168. package/dist/rate-limiter/index.d.cts +0 -6
  169. package/dist/rate-limiter/injectRateLimitedCallback.cjs +0 -45
  170. package/dist/rate-limiter/injectRateLimitedCallback.cjs.map +0 -1
  171. package/dist/rate-limiter/injectRateLimitedCallback.d.cts +0 -41
  172. package/dist/rate-limiter/injectRateLimitedCallback.js.map +0 -1
  173. package/dist/rate-limiter/injectRateLimitedSignal.cjs +0 -62
  174. package/dist/rate-limiter/injectRateLimitedSignal.cjs.map +0 -1
  175. package/dist/rate-limiter/injectRateLimitedSignal.d.cts +0 -53
  176. package/dist/rate-limiter/injectRateLimitedSignal.js.map +0 -1
  177. package/dist/rate-limiter/injectRateLimitedValue.cjs +0 -17
  178. package/dist/rate-limiter/injectRateLimitedValue.cjs.map +0 -1
  179. package/dist/rate-limiter/injectRateLimitedValue.d.cts +0 -48
  180. package/dist/rate-limiter/injectRateLimitedValue.js.map +0 -1
  181. package/dist/rate-limiter/injectRateLimiter.cjs +0 -100
  182. package/dist/rate-limiter/injectRateLimiter.cjs.map +0 -1
  183. package/dist/rate-limiter/injectRateLimiter.d.cts +0 -102
  184. package/dist/rate-limiter/injectRateLimiter.js.map +0 -1
  185. package/dist/throttler/index.cjs +0 -17
  186. package/dist/throttler/index.d.cts +0 -6
  187. package/dist/throttler/injectThrottledCallback.cjs +0 -45
  188. package/dist/throttler/injectThrottledCallback.cjs.map +0 -1
  189. package/dist/throttler/injectThrottledCallback.d.cts +0 -41
  190. package/dist/throttler/injectThrottledCallback.js.map +0 -1
  191. package/dist/throttler/injectThrottledSignal.cjs +0 -69
  192. package/dist/throttler/injectThrottledSignal.cjs.map +0 -1
  193. package/dist/throttler/injectThrottledSignal.d.cts +0 -60
  194. package/dist/throttler/injectThrottledSignal.js.map +0 -1
  195. package/dist/throttler/injectThrottledValue.cjs +0 -17
  196. package/dist/throttler/injectThrottledValue.cjs.map +0 -1
  197. package/dist/throttler/injectThrottledValue.d.cts +0 -73
  198. package/dist/throttler/injectThrottledValue.js.map +0 -1
  199. package/dist/throttler/injectThrottler.cjs +0 -95
  200. package/dist/throttler/injectThrottler.cjs.map +0 -1
  201. package/dist/throttler/injectThrottler.d.cts +0 -97
  202. package/dist/throttler/injectThrottler.js.map +0 -1
  203. package/dist/types/index.cjs +0 -8
  204. package/dist/types/index.d.cts +0 -1
  205. package/dist/utils/index.cjs +0 -8
  206. package/dist/utils/index.d.cts +0 -1
  207. package/src/async-batcher/index.ts +0 -4
  208. package/src/async-batcher/injectAsyncBatchedCallback.ts +0 -48
  209. package/src/async-batcher/injectAsyncBatcher.ts +0 -126
  210. package/src/async-debouncer/index.ts +0 -4
  211. package/src/async-debouncer/injectAsyncDebouncedCallback.ts +0 -50
  212. package/src/async-debouncer/injectAsyncDebouncer.ts +0 -152
  213. package/src/async-queuer/index.ts +0 -4
  214. package/src/async-queuer/injectAsyncQueuedSignal.ts +0 -74
  215. package/src/async-queuer/injectAsyncQueuer.ts +0 -126
  216. package/src/async-rate-limiter/index.ts +0 -4
  217. package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts +0 -52
  218. package/src/async-rate-limiter/injectAsyncRateLimiter.ts +0 -115
  219. package/src/async-retryer/index.ts +0 -1
  220. package/src/async-throttler/index.ts +0 -4
  221. package/src/async-throttler/injectAsyncThrottledCallback.ts +0 -50
  222. package/src/async-throttler/injectAsyncThrottler.ts +0 -131
  223. package/src/batcher/index.ts +0 -4
  224. package/src/batcher/injectBatchedCallback.ts +0 -46
  225. package/src/batcher/injectBatcher.ts +0 -114
  226. package/src/debouncer/index.ts +0 -6
  227. package/src/debouncer/injectDebouncedCallback.ts +0 -46
  228. package/src/debouncer/injectDebouncedSignal.ts +0 -94
  229. package/src/debouncer/injectDebouncedValue.ts +0 -125
  230. package/src/debouncer/injectDebouncer.ts +0 -137
  231. package/src/index.ts +0 -40
  232. package/src/provider/index.ts +0 -2
  233. package/src/provider/pacer-context.ts +0 -46
  234. package/src/provider/pacer-provider.ts +0 -38
  235. package/src/queuer/index.ts +0 -5
  236. package/src/queuer/injectQueuedSignal.ts +0 -65
  237. package/src/queuer/injectQueuedValue.ts +0 -99
  238. package/src/queuer/injectQueuer.ts +0 -118
  239. package/src/rate-limiter/index.ts +0 -6
  240. package/src/rate-limiter/injectRateLimitedCallback.ts +0 -45
  241. package/src/rate-limiter/injectRateLimitedSignal.ts +0 -88
  242. package/src/rate-limiter/injectRateLimitedValue.ts +0 -98
  243. package/src/rate-limiter/injectRateLimiter.ts +0 -140
  244. package/src/throttler/index.ts +0 -6
  245. package/src/throttler/injectThrottledCallback.ts +0 -45
  246. package/src/throttler/injectThrottledSignal.ts +0 -95
  247. package/src/throttler/injectThrottledValue.ts +0 -123
  248. package/src/throttler/injectThrottler.ts +0 -137
  249. package/src/types/index.ts +0 -1
  250. package/src/utils/index.ts +0 -1
@@ -1 +0,0 @@
1
- {"version":3,"file":"injectThrottledCallback.js","names":[],"sources":["../../src/throttler/injectThrottledCallback.ts"],"sourcesContent":["import { injectThrottler } from './injectThrottler'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a throttled version of a callback function.\n * This function is essentially a wrapper around `injectThrottler` that provides\n * a simplified API for basic throttling needs.\n *\n * The throttled function will execute at most once within the specified wait time.\n * If called multiple times within the wait period, only the first call (if leading is enabled)\n * or the last call (if trailing is enabled) will execute.\n *\n * This function provides a simpler API compared to `injectThrottler`, making it ideal for basic\n * throttling needs. However, it does not expose the underlying Throttler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectThrottler` function instead.\n *\n * @example\n * ```ts\n * // Throttle a scroll handler\n * const handleScroll = injectThrottledCallback((scrollY: number) => {\n * updateScrollPosition(scrollY);\n * }, {\n * wait: 100 // Execute at most once per 100ms\n * });\n *\n * // Use in an event listener\n * window.addEventListener('scroll', () => {\n * handleScroll(window.scrollY);\n * });\n * ```\n */\nexport function injectThrottledCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: ThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n const throttler = injectThrottler(fn, options)\n return (...args: Parameters<TFn>) => throttler.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,wBACd,IACA,SACoC;CACpC,MAAM,YAAY,gBAAgB,IAAI,OAAO;CAC7C,QAAQ,GAAG,SAA0B,UAAU,aAAa,GAAG,IAAI;AACrE"}
@@ -1,69 +0,0 @@
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
@@ -1 +0,0 @@
1
- {"version":3,"file":"injectThrottledSignal.cjs","names":["signal","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 interface ThrottledSignal<TValue, TSelected = {}> {\n (): TValue\n set: Setter<TValue>\n 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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,qBAAiBA,sBAAe,KAAK;CAE3C,MAAM,YAAYC,yCACf,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,eAAe,OAAO,QAAoC;OAE1D,eAAe,IAAI,QAAQ;CAE/B,GACA,gBACA,QACF;CAEA,MAAM,OACJ,aACG;EACH,UAAU,aAAa,QAAQ;CACjC;CAOA,OALkB,OAAO,aAAa,eAAe,GAAG;EACtD;EACA;CACF,CAEe;AACjB"}
@@ -1,60 +0,0 @@
1
- import { AngularThrottler } from "./injectThrottler.cjs";
2
- import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
3
- //#region src/throttler/injectThrottledSignal.d.ts
4
- type Setter<T> = (value: T | ((prev: T) => T)) => void;
5
- interface ThrottledSignal<TValue, TSelected = {}> {
6
- (): TValue;
7
- set: Setter<TValue>;
8
- throttler: AngularThrottler<Setter<TValue>, TSelected>;
9
- }
10
- /**
11
- * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
12
- * This function provides both the current throttled value and methods to update it.
13
- *
14
- * The state value is updated at most once within the specified wait time.
15
- * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
16
- * or mouse movements.
17
- *
18
- * The function returns a callable object:
19
- * - `throttled()`: Get the current throttled value
20
- * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
21
- * - `throttled.throttler`: The throttler instance with additional control methods and state signals
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
- * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
46
- *
47
- * // Get value
48
- * console.log(throttledScrollY())
49
- *
50
- * // Set/update value (throttled)
51
- * throttledScrollY.set(window.scrollY)
52
- *
53
- * // Access throttler
54
- * console.log(throttledScrollY.throttler.state().isPending)
55
- * ```
56
- */
57
- declare function injectThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
58
- //#endregion
59
- export { ThrottledSignal, injectThrottledSignal };
60
- //# sourceMappingURL=injectThrottledSignal.d.cts.map
@@ -1 +0,0 @@
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 interface ThrottledSignal<TValue, TSelected = {}> {\n (): TValue\n set: Setter<TValue>\n 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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,iBAAiB,OAAe,KAAK;CAE3C,MAAM,YAAY,iBACf,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,eAAe,OAAO,QAAoC;OAE1D,eAAe,IAAI,QAAQ;CAE/B,GACA,gBACA,QACF;CAEA,MAAM,OACJ,aACG;EACH,UAAU,aAAa,QAAQ;CACjC;CAOA,OALkB,OAAO,aAAa,eAAe,GAAG;EACtD;EACA;CACF,CAEe;AACjB"}
@@ -1,17 +0,0 @@
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
@@ -1 +0,0 @@
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) | 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;CAapB,MAAM,iBAAiBA,oDAXF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,wBAOL;CAEA,gCAAa;EACX,MAAM,SAAS,MAAM;EACrB,eAAe,IAAI,MAAM;CAC3B,CAAC;CAED,OAAO;AACT"}
@@ -1,73 +0,0 @@
1
- import { ThrottledSignal } from "./injectThrottledSignal.cjs";
2
- import { Signal } from "@angular/core";
3
- import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
- //#region src/throttler/injectThrottledValue.d.ts
5
- type Setter<T> = (value: T | ((prev: T) => T)) => void;
6
- /**
7
- * An Angular function that creates a throttled value that updates at most once within a specified time window.
8
- * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal
9
- * and updates the throttled value accordingly.
10
- *
11
- * The throttled value will update at most once within the specified wait time, regardless of
12
- * how frequently the input value changes.
13
- *
14
- * This is useful for deriving throttled values from signals that change frequently,
15
- * like scroll positions or mouse coordinates, where you want to limit how often downstream effects
16
- * or calculations occur.
17
- *
18
- * The function returns a throttled signal object containing:
19
- * - A Signal that provides the current throttled value
20
- * - The throttler instance with control methods
21
- *
22
- * ## State Management and Selector
23
- *
24
- * The function uses TanStack Store for reactive state management via the underlying throttler instance.
25
- * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
26
- * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
27
- *
28
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
29
- * tracking by providing a selector function. This prevents unnecessary updates and gives you
30
- * full control over when your component tracks state changes.
31
- *
32
- * Available throttler state properties:
33
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
34
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
35
- * - `executionCount`: Number of function executions that have been completed
36
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
37
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
38
- * - `lastExecutionTime`: Timestamp of the last execution
39
- * - `nextExecutionTime`: Timestamp of the next allowed execution
40
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
41
- *
42
- * @example
43
- * ```ts
44
- * // Default behavior - no reactive state subscriptions
45
- * const scrollY = signal(0)
46
- * const throttledScrollY = injectThrottledValue(scrollY, {
47
- * wait: 100, // Update at most once per 100ms
48
- * })
49
- *
50
- * // Opt-in to reactive updates when pending state changes
51
- * const throttledScrollYWithState = injectThrottledValue(
52
- * scrollY,
53
- * { wait: 100 },
54
- * (state) => ({ isPending: state.isPending }),
55
- * )
56
- *
57
- * // Read the throttled signal value
58
- * effect(() => {
59
- * updateUI(throttledScrollY())
60
- * })
61
- *
62
- * // Access throttler state via the returned object's state() signal
63
- * console.log('Is pending:', throttledScrollYWithState.state().isPending)
64
- *
65
- * // Control the throttler
66
- * throttledScrollY.cancel() // Cancel any pending updates
67
- * ```
68
- */
69
- declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
70
- declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialValue: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
71
- //#endregion
72
- export { injectThrottledValue };
73
- //# sourceMappingURL=injectThrottledValue.d.cts.map
@@ -1 +0,0 @@
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) | 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;CAapB,MAAM,iBAAiB,sBAXF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,wBAOL;CAEA,aAAa;EACX,MAAM,SAAS,MAAM;EACrB,eAAe,IAAI,MAAM;CAC3B,CAAC;CAED,OAAO;AACT"}
@@ -1,95 +0,0 @@
1
- const require_pacer_context = require('../provider/pacer-context.cjs');
2
- let _angular_core = require("@angular/core");
3
- let _tanstack_angular_store = require("@tanstack/angular-store");
4
- let _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
5
-
6
- //#region src/throttler/injectThrottler.ts
7
- /**
8
- * An Angular function that creates and manages a Throttler instance.
9
- *
10
- * This is a lower-level function that provides direct access to the Throttler's functionality.
11
- * This allows you to integrate it with any state management solution you prefer.
12
- *
13
- * This function provides throttling functionality to limit how often a function can be called,
14
- * ensuring it executes at most once within a specified time window.
15
- *
16
- * The throttler will execute the function immediately (if leading is enabled) and then
17
- * prevent further executions until the wait period has elapsed.
18
- *
19
- * ## State Management and Selector
20
- *
21
- * The function uses TanStack Store for state management and wraps it with Angular signals.
22
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
23
- * optimizing performance by preventing unnecessary updates 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 updates and gives you
27
- * full control over when your component tracks state changes.
28
- *
29
- * Available state properties:
30
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
31
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
32
- * - `executionCount`: Number of function executions that have been completed
33
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
34
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
35
- * - `lastExecutionTime`: Timestamp of the last execution
36
- * - `nextExecutionTime`: Timestamp of the next allowed execution
37
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
38
- *
39
- * ## Cleanup on Destroy
40
- *
41
- * By default, the function cancels any pending execution when the component is destroyed.
42
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
43
- *
44
- * ```ts
45
- * const throttler = injectThrottler(fn, {
46
- * wait: 100,
47
- * onUnmount: (t) => t.flush()
48
- * });
49
- * ```
50
- *
51
- * @example
52
- * ```ts
53
- * // Default behavior - no reactive state subscriptions
54
- * const throttler = injectThrottler(
55
- * (scrollY: number) => updateScrollPosition(scrollY),
56
- * { wait: 100 }
57
- * );
58
- *
59
- * // Opt-in to track isPending changes (optimized for loading states)
60
- * const throttler = injectThrottler(
61
- * (scrollY: number) => updateScrollPosition(scrollY),
62
- * { wait: 100 },
63
- * (state) => ({ isPending: state.isPending })
64
- * );
65
- *
66
- * // In an event handler
67
- * window.addEventListener('scroll', () => {
68
- * throttler.maybeExecute(window.scrollY);
69
- * });
70
- *
71
- * // Access the selected state (will be empty object {} unless selector provided)
72
- * const { isPending } = throttler.state();
73
- * ```
74
- */
75
- function injectThrottler(fn, options, selector = () => ({})) {
76
- const mergedOptions = {
77
- ...require_pacer_context.injectPacerOptions().throttler,
78
- ...options
79
- };
80
- const throttler = new _tanstack_pacer_throttler.Throttler(fn, mergedOptions);
81
- const state = (0, _tanstack_angular_store.injectSelector)(throttler.store, selector);
82
- const result = {
83
- ...throttler,
84
- state
85
- };
86
- (0, _angular_core.inject)(_angular_core.DestroyRef, { optional: true })?.onDestroy(() => {
87
- if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
88
- else throttler.cancel();
89
- });
90
- return result;
91
- }
92
-
93
- //#endregion
94
- exports.injectThrottler = injectThrottler;
95
- //# sourceMappingURL=injectThrottler.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"injectThrottler.cjs","names":["injectPacerOptions","Throttler","injectSelector","inject","DestroyRef"],"sources":["../../src/throttler/injectThrottler.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } 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/angular-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface AngularThrottlerOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends ThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component is destroyed. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: AngularThrottler<TFn, TSelected>) => void\n}\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 * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending execution when the component is destroyed.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```ts\n * const throttler = injectThrottler(fn, {\n * wait: 100,\n * onUnmount: (t) => t.flush()\n * });\n * ```\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: AngularThrottlerOptions<TFn, TSelected>,\n selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().throttler,\n ...options,\n } as AngularThrottlerOptions<TFn, TSelected>\n\n const throttler = new Throttler<TFn>(fn, mergedOptions)\n const state = injectSelector(throttler.store, selector)\n\n const result = {\n ...throttler,\n state,\n } as AngularThrottler<TFn, TSelected>\n\n const destroyRef = inject(DestroyRef, { optional: true })\n destroyRef?.onDestroy(() => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(result)\n } else {\n throttler.cancel()\n }\n })\n\n return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GA,SAAgB,gBACd,IACA,SACA,kBAA6D,CAAC,IAC5B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,yCAAmB,CAAC,CAAC;EACxB,GAAG;CACL;CAEA,MAAM,YAAY,IAAIC,oCAAe,IAAI,aAAa;CACtD,MAAM,YAAQC,wCAAe,UAAU,OAAO,QAAQ;CAEtD,MAAM,SAAS;EACb,GAAG;EACH;CACF;CAGA,IADmBC,sBAAOC,0BAAY,EAAE,UAAU,KAAK,CAC9C,CAAC,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,MAAM;OAE9B,UAAU,OAAO;CAErB,CAAC;CAED,OAAO;AACT"}
@@ -1,97 +0,0 @@
1
- import { Signal } from "@angular/core";
2
- import { Store } from "@tanstack/angular-store";
3
- import { AnyFunction } from "@tanstack/pacer/types";
4
- import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
5
- //#region src/throttler/injectThrottler.d.ts
6
- interface AngularThrottlerOptions<TFn extends AnyFunction, TSelected = {}> extends ThrottlerOptions<TFn> {
7
- /**
8
- * Optional callback invoked when the component is destroyed. Receives the throttler instance.
9
- * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.
10
- */
11
- onUnmount?: (throttler: AngularThrottler<TFn, TSelected>) => void;
12
- }
13
- interface AngularThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
14
- /**
15
- * Reactive state signal that will be updated when the throttler state changes
16
- *
17
- * Use this instead of `throttler.store.state`
18
- */
19
- readonly state: Signal<Readonly<TSelected>>;
20
- /**
21
- * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
22
- * The state on the store object is not reactive in Angular signals.
23
- */
24
- readonly store: Store<Readonly<ThrottlerState<TFn>>>;
25
- }
26
- /**
27
- * An Angular function that creates and manages a Throttler instance.
28
- *
29
- * This is a lower-level function that provides direct access to the Throttler's functionality.
30
- * This allows you to integrate it with any state management solution you prefer.
31
- *
32
- * This function provides throttling functionality to limit how often a function can be called,
33
- * ensuring it executes at most once within a specified time window.
34
- *
35
- * The throttler will execute the function immediately (if leading is enabled) and then
36
- * prevent further executions until the wait period has elapsed.
37
- *
38
- * ## State Management and Selector
39
- *
40
- * The function uses TanStack Store for state management and wraps it with Angular signals.
41
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
42
- * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
43
- *
44
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
45
- * tracking by providing a selector function. This prevents unnecessary updates and gives you
46
- * full control over when your component tracks state changes.
47
- *
48
- * Available state properties:
49
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
50
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
51
- * - `executionCount`: Number of function executions that have been completed
52
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
53
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
54
- * - `lastExecutionTime`: Timestamp of the last execution
55
- * - `nextExecutionTime`: Timestamp of the next allowed execution
56
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
57
- *
58
- * ## Cleanup on Destroy
59
- *
60
- * By default, the function cancels any pending execution when the component is destroyed.
61
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
62
- *
63
- * ```ts
64
- * const throttler = injectThrottler(fn, {
65
- * wait: 100,
66
- * onUnmount: (t) => t.flush()
67
- * });
68
- * ```
69
- *
70
- * @example
71
- * ```ts
72
- * // Default behavior - no reactive state subscriptions
73
- * const throttler = injectThrottler(
74
- * (scrollY: number) => updateScrollPosition(scrollY),
75
- * { wait: 100 }
76
- * );
77
- *
78
- * // Opt-in to track isPending changes (optimized for loading states)
79
- * const throttler = injectThrottler(
80
- * (scrollY: number) => updateScrollPosition(scrollY),
81
- * { wait: 100 },
82
- * (state) => ({ isPending: state.isPending })
83
- * );
84
- *
85
- * // In an event handler
86
- * window.addEventListener('scroll', () => {
87
- * throttler.maybeExecute(window.scrollY);
88
- * });
89
- *
90
- * // Access the selected state (will be empty object {} unless selector provided)
91
- * const { isPending } = throttler.state();
92
- * ```
93
- */
94
- declare function injectThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: AngularThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): AngularThrottler<TFn, TSelected>;
95
- //#endregion
96
- export { AngularThrottler, AngularThrottlerOptions, injectThrottler };
97
- //# sourceMappingURL=injectThrottler.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"injectThrottler.js","names":[],"sources":["../../src/throttler/injectThrottler.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } 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/angular-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface AngularThrottlerOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends ThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component is destroyed. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: AngularThrottler<TFn, TSelected>) => void\n}\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 * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending execution when the component is destroyed.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```ts\n * const throttler = injectThrottler(fn, {\n * wait: 100,\n * onUnmount: (t) => t.flush()\n * });\n * ```\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: AngularThrottlerOptions<TFn, TSelected>,\n selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().throttler,\n ...options,\n } as AngularThrottlerOptions<TFn, TSelected>\n\n const throttler = new Throttler<TFn>(fn, mergedOptions)\n const state = injectSelector(throttler.store, selector)\n\n const result = {\n ...throttler,\n state,\n } as AngularThrottler<TFn, TSelected>\n\n const destroyRef = inject(DestroyRef, { optional: true })\n destroyRef?.onDestroy(() => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(result)\n } else {\n throttler.cancel()\n }\n })\n\n return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GA,SAAgB,gBACd,IACA,SACA,kBAA6D,CAAC,IAC5B;CAClC,MAAM,gBAAgB;EACpB,GAAG,mBAAmB,CAAC,CAAC;EACxB,GAAG;CACL;CAEA,MAAM,YAAY,IAAI,UAAe,IAAI,aAAa;CACtD,MAAM,QAAQ,eAAe,UAAU,OAAO,QAAQ;CAEtD,MAAM,SAAS;EACb,GAAG;EACH;CACF;CAGA,AADmB,OAAO,YAAY,EAAE,UAAU,KAAK,CAC9C,CAAC,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,MAAM;OAE9B,UAAU,OAAO;CAErB,CAAC;CAED,OAAO;AACT"}
@@ -1,8 +0,0 @@
1
-
2
- var _tanstack_pacer_types = require("@tanstack/pacer/types");
3
- Object.keys(_tanstack_pacer_types).forEach(function (k) {
4
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
5
- enumerable: true,
6
- get: function () { return _tanstack_pacer_types[k]; }
7
- });
8
- });
@@ -1 +0,0 @@
1
- export * from "@tanstack/pacer/types";
@@ -1,8 +0,0 @@
1
-
2
- var _tanstack_pacer_utils = require("@tanstack/pacer/utils");
3
- Object.keys(_tanstack_pacer_utils).forEach(function (k) {
4
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
5
- enumerable: true,
6
- get: function () { return _tanstack_pacer_utils[k]; }
7
- });
8
- });
@@ -1 +0,0 @@
1
- export * from "@tanstack/pacer/utils";
@@ -1,4 +0,0 @@
1
- export * from '@tanstack/pacer/async-batcher'
2
-
3
- export * from './injectAsyncBatchedCallback'
4
- export * from './injectAsyncBatcher'
@@ -1,48 +0,0 @@
1
- import { injectAsyncBatcher } from './injectAsyncBatcher'
2
- import type { AsyncBatcherOptions } from '@tanstack/pacer/async-batcher'
3
-
4
- /**
5
- * An Angular function that creates an async batched version of a callback function.
6
- * This function is essentially a wrapper around `injectAsyncBatcher` that provides
7
- * a simplified API for basic async batching needs.
8
- *
9
- * The batched function will collect items and process them in batches asynchronously based on
10
- * the configured conditions (maxSize, wait time, etc.).
11
- *
12
- * This function provides a simpler API compared to `injectAsyncBatcher`, making it ideal for basic
13
- * async batching needs. However, it does not expose the underlying AsyncBatcher instance.
14
- *
15
- * For advanced usage requiring features like:
16
- * - Manual flushing
17
- * - Access to batch state
18
- * - Error handling callbacks
19
- * - Retry support
20
- *
21
- * Consider using the `injectAsyncBatcher` function instead.
22
- *
23
- * @example
24
- * ```ts
25
- * // Batch async API calls
26
- * const batchApiCall = injectAsyncBatchedCallback(
27
- * async (items: Array<Data>) => {
28
- * const response = await fetch('/api/batch', {
29
- * method: 'POST',
30
- * body: JSON.stringify(items)
31
- * });
32
- * return response.json();
33
- * },
34
- * { maxSize: 10, wait: 1000 }
35
- * );
36
- *
37
- * // Items will be batched and sent together
38
- * await batchApiCall(data1);
39
- * await batchApiCall(data2);
40
- * ```
41
- */
42
- export function injectAsyncBatchedCallback<TValue>(
43
- fn: (items: Array<TValue>) => Promise<any>,
44
- options: AsyncBatcherOptions<TValue>,
45
- ): (item: TValue) => Promise<void> {
46
- const batcher = injectAsyncBatcher(fn, options)
47
- return (item: TValue) => batcher.addItem(item)
48
- }