@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
package/README.md ADDED
@@ -0,0 +1,165 @@
1
+ <div align="center">
2
+ <img src="./media/header_pacer.png" >
3
+ </div>
4
+
5
+ <br />
6
+
7
+ <div align="center">
8
+ <a href="https://www.npmjs.com/package/@tanstack/pacer" target="\_parent">
9
+ <img alt="" src="https://img.shields.io/npm/dm/@tanstack/pacer.svg" alt="npm downloads" />
10
+ </a>
11
+ - <a href="https://github.com/TanStack/pacer" target="\_parent">
12
+ <img alt="" src="https://img.shields.io/github/stars/TanStack/pacer.svg?style=social&label=Star" alt="GitHub stars" />
13
+ </a>
14
+ <a href="https://bundlephobia.com/result?p=@tanstack/react-pacer@latest" target="\_parent">
15
+ <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-pacer@latest" alt="Bundle size" />
16
+ </a>
17
+ </div>
18
+
19
+ <div align="center">
20
+ <a href="#badge">
21
+ <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
22
+ </a>
23
+ <a href="#badge">
24
+ <img src="https://img.shields.io/github/v/release/tanstack/pacer" alt="Release"/>
25
+ </a>
26
+ <a href="https://twitter.com/tan_stack">
27
+ <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
28
+ </a>
29
+ </div>
30
+
31
+ <div align="center">
32
+
33
+ ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
34
+ </div>
35
+
36
+ # TanStack Pacer
37
+
38
+ A lightweight timing and scheduling library for debouncing, throttling, rate limiting, queuing, and batching.
39
+
40
+ > [!NOTE]
41
+ > TanStack Pacer is currently mostly a client-side only library, but it is being designed to be able to potentially be used on the server-side as well.
42
+
43
+ - **Debouncing**
44
+ - Delay execution until after a period of inactivity for when you only care about the last execution in a sequence.
45
+ - Synchronous or Asynchronous Debounce utilities with promise support and error handling
46
+ - Control of leading, trailing, and enabled options
47
+ - **Throttling**
48
+ - Smoothly limit the rate at which a function can fire
49
+ - Synchronous or Asynchronous Throttle utilities with promise support and error handling
50
+ - Control of leading, trailing, and enabled options.
51
+ - **Rate Limiting**
52
+ - Limit the rate at which a function can fire over a period of time
53
+ - Synchronous or Asynchronous Rate Limiting utilities with promise support and error handling
54
+ - Fixed or Sliding Window variations of Rate Limiting
55
+ - **Queuing**
56
+ - Queue functions to be executed in a specific order
57
+ - Choose from FIFO, LIFO, and Priority queue implementations
58
+ - Control processing speed with configurable wait times or concurrency limits
59
+ - Manage queue execution with start/stop capabilities
60
+ - Expire items from the queue after a configurable duration
61
+ - **Batching**
62
+ - Chunk up multiple operations into larger batches to reduce total back-and-forth operations
63
+ - Batch by time period, batch size, whichever comes first, or a custom condition to trigger batch executions
64
+ - **Async or Sync Variations**
65
+ - Choose between synchronous and asynchronous versions of each utility
66
+ - Optional error, success, and settled handling for async variations
67
+ - Retry and Abort support for async variations
68
+ - **State Management**
69
+ - Uses TanStack Store under the hood for state management with fine-grained reactivity
70
+ - Easily integrate with your own state management library of choice
71
+ - Persist state to local or session storage for some utilities like rate limiting and queuing
72
+ - **Convenient Hooks**
73
+ - Reduce boilerplate code with pre-built hooks like `useDebouncedCallback`, `useThrottledValue`, and `useQueuedState`, and more.
74
+ - Multiple layers of abstraction to choose from depending on your use case.
75
+ - Works with each framework's default state management solutions, or with whatever custom state management library that you prefer.
76
+ - **Type Safety**
77
+ - Full type safety with TypeScript that makes sure that your functions will always be called with the correct arguments
78
+ - Generics for flexible and reusable utilities
79
+ - **Framework Adapters**
80
+ - React, Solid, and more
81
+ - **Tree Shaking**
82
+ - We, of course, get tree-shaking right for your applications by default, but we also provide extra deep imports for each utility, making it easier to embed these utilities into your libraries without increasing the bundle-phobia reports of your library.
83
+
84
+ ### <a href="https://tanstack.com/pacer">Read the docs →</b></a>
85
+
86
+ <br />
87
+
88
+ > [!NOTE]
89
+ > You may know **TanStack Pacer** by our adapter names, too!
90
+ >
91
+ > - [**React Pacer**](https://tanstack.com/pacer/latest/docs/framework/react/react-pacer)
92
+ > - [**Preact Pacer**](https://tanstack.com/pacer/latest/docs/framework/preact/preact-pacer)
93
+ > - [**Solid Pacer**](https://tanstack.com/pacer/latest/docs/framework/solid/solid-pacer)
94
+ > - [**Angular Pacer**](https://tanstack.com/pacer/latest/docs/framework/angular/angular-pacer)
95
+ > - Svelte Pacer - needs a contributor!
96
+ > - Vue Pacer - needs a contributor!
97
+
98
+ ## Get Involved
99
+
100
+ - We welcome issues and pull requests!
101
+ - Participate in [GitHub discussions](https://github.com/TanStack/pacer/discussions)
102
+ - Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
103
+ - See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
104
+
105
+ ## Partners
106
+
107
+ <table align="center">
108
+ <tr>
109
+ <td>
110
+ <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
111
+ <picture>
112
+ <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
113
+ <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
114
+ <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
115
+ </picture>
116
+ </a>
117
+ </td>
118
+ <td>
119
+ <a href="https://www.cloudflare.com?utm_source=tanstack">
120
+ <picture>
121
+ <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
122
+ <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
123
+ <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
124
+ </picture>
125
+ </a>
126
+ </td>
127
+ <td>
128
+ <a href="https://www.unkey.com/?utm_source=tanstack">
129
+ <picture>
130
+ <source media="(prefers-color-scheme: dark)" srcset="./media/unkey_dark.svg" height="60" />
131
+ <source media="(prefers-color-scheme: light)" srcset="./media/unkey_logo.svg" height="60" />
132
+ <img src="./media/unkey_logo.svg" height="60" alt="Unkey"/>
133
+ </picture>
134
+ </a>
135
+ </td>
136
+ </tr>
137
+ </table>
138
+
139
+ <div align="center">
140
+ <img src="./media/partner_logo.svg" alt="Pacer & you?" height="65">
141
+ <p>
142
+ We're looking for TanStack Pacer Partners to join our mission! Partner with us to push the boundaries of TanStack Pacer and build amazing things together.
143
+ </p>
144
+ <a href="mailto:partners@tanstack.com?subject=TanStack Pacer Partnership"><b>LET'S CHAT</b></a>
145
+ </div>
146
+
147
+ </div>
148
+
149
+ ## Explore the TanStack Ecosystem
150
+
151
+ - <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
152
+ - <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
153
+ - <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
154
+ - <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
155
+ - <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
156
+ - <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
157
+ - <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
158
+ - <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
159
+ - <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
160
+ - <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
161
+ - <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
162
+
163
+ … and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
164
+
165
+ <!-- USE THE FORCE LUKE -->
@@ -0,0 +1,13 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+ const require_injectAsyncBatcher = require('./injectAsyncBatcher.cjs');
3
+ const require_injectAsyncBatchedCallback = require('./injectAsyncBatchedCallback.cjs');
4
+
5
+ exports.injectAsyncBatchedCallback = require_injectAsyncBatchedCallback.injectAsyncBatchedCallback;
6
+ exports.injectAsyncBatcher = require_injectAsyncBatcher.injectAsyncBatcher;
7
+ var _tanstack_pacer_async_batcher = require("@tanstack/pacer/async-batcher");
8
+ Object.keys(_tanstack_pacer_async_batcher).forEach(function (k) {
9
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
10
+ enumerable: true,
11
+ get: function () { return _tanstack_pacer_async_batcher[k]; }
12
+ });
13
+ });
@@ -0,0 +1,4 @@
1
+ import { injectAsyncBatchedCallback } from "./injectAsyncBatchedCallback.cjs";
2
+ import { AngularAsyncBatcher, injectAsyncBatcher } from "./injectAsyncBatcher.cjs";
3
+ export * from "@tanstack/pacer/async-batcher";
4
+ export { AngularAsyncBatcher, injectAsyncBatchedCallback, injectAsyncBatcher };
@@ -0,0 +1,4 @@
1
+ import { injectAsyncBatchedCallback } from "./injectAsyncBatchedCallback.js";
2
+ import { AngularAsyncBatcher, injectAsyncBatcher } from "./injectAsyncBatcher.js";
3
+ export * from "@tanstack/pacer/async-batcher";
4
+ export { AngularAsyncBatcher, injectAsyncBatchedCallback, injectAsyncBatcher };
@@ -0,0 +1,6 @@
1
+ import { injectAsyncBatcher } from "./injectAsyncBatcher.js";
2
+ import { injectAsyncBatchedCallback } from "./injectAsyncBatchedCallback.js";
3
+
4
+ export * from "@tanstack/pacer/async-batcher"
5
+
6
+ export { injectAsyncBatchedCallback, injectAsyncBatcher };
@@ -0,0 +1,49 @@
1
+ const require_injectAsyncBatcher = require('./injectAsyncBatcher.cjs');
2
+
3
+ //#region src/async-batcher/injectAsyncBatchedCallback.ts
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
+ function injectAsyncBatchedCallback(fn, options) {
43
+ const batcher = require_injectAsyncBatcher.injectAsyncBatcher(fn, options);
44
+ return (item) => batcher.addItem(item);
45
+ }
46
+
47
+ //#endregion
48
+ exports.injectAsyncBatchedCallback = injectAsyncBatchedCallback;
49
+ //# sourceMappingURL=injectAsyncBatchedCallback.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncBatchedCallback.cjs","names":["injectAsyncBatcher"],"sources":["../../src/async-batcher/injectAsyncBatchedCallback.ts"],"sourcesContent":["import { injectAsyncBatcher } from './injectAsyncBatcher'\nimport type { AsyncBatcherOptions } from '@tanstack/pacer/async-batcher'\n\n/**\n * An Angular function that creates an async batched version of a callback function.\n * This function is essentially a wrapper around `injectAsyncBatcher` that provides\n * a simplified API for basic async batching needs.\n *\n * The batched function will collect items and process them in batches asynchronously based on\n * the configured conditions (maxSize, wait time, etc.).\n *\n * This function provides a simpler API compared to `injectAsyncBatcher`, making it ideal for basic\n * async batching needs. However, it does not expose the underlying AsyncBatcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual flushing\n * - Access to batch state\n * - Error handling callbacks\n * - Retry support\n *\n * Consider using the `injectAsyncBatcher` function instead.\n *\n * @example\n * ```ts\n * // Batch async API calls\n * const batchApiCall = injectAsyncBatchedCallback(\n * async (items: Array<Data>) => {\n * const response = await fetch('/api/batch', {\n * method: 'POST',\n * body: JSON.stringify(items)\n * });\n * return response.json();\n * },\n * { maxSize: 10, wait: 1000 }\n * );\n *\n * // Items will be batched and sent together\n * await batchApiCall(data1);\n * await batchApiCall(data2);\n * ```\n */\nexport function injectAsyncBatchedCallback<TValue>(\n fn: (items: Array<TValue>) => Promise<any>,\n options: AsyncBatcherOptions<TValue>,\n): (item: TValue) => Promise<void> {\n const batcher = injectAsyncBatcher(fn, options)\n return (item: TValue) => batcher.addItem(item)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,2BACd,IACA,SACiC;CACjC,MAAM,UAAUA,8CAAmB,IAAI,QAAQ;AAC/C,SAAQ,SAAiB,QAAQ,QAAQ,KAAK"}
@@ -0,0 +1,45 @@
1
+ import { AsyncBatcherOptions } from "@tanstack/pacer/async-batcher";
2
+
3
+ //#region src/async-batcher/injectAsyncBatchedCallback.d.ts
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
+ declare function injectAsyncBatchedCallback<TValue>(fn: (items: Array<TValue>) => Promise<any>, options: AsyncBatcherOptions<TValue>): (item: TValue) => Promise<void>;
43
+ //#endregion
44
+ export { injectAsyncBatchedCallback };
45
+ //# sourceMappingURL=injectAsyncBatchedCallback.d.cts.map
@@ -0,0 +1,45 @@
1
+ import { AsyncBatcherOptions } from "@tanstack/pacer/async-batcher";
2
+
3
+ //#region src/async-batcher/injectAsyncBatchedCallback.d.ts
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
+ declare function injectAsyncBatchedCallback<TValue>(fn: (items: Array<TValue>) => Promise<any>, options: AsyncBatcherOptions<TValue>): (item: TValue) => Promise<void>;
43
+ //#endregion
44
+ export { injectAsyncBatchedCallback };
45
+ //# sourceMappingURL=injectAsyncBatchedCallback.d.ts.map
@@ -0,0 +1,49 @@
1
+ import { injectAsyncBatcher } from "./injectAsyncBatcher.js";
2
+
3
+ //#region src/async-batcher/injectAsyncBatchedCallback.ts
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
+ function injectAsyncBatchedCallback(fn, options) {
43
+ const batcher = injectAsyncBatcher(fn, options);
44
+ return (item) => batcher.addItem(item);
45
+ }
46
+
47
+ //#endregion
48
+ export { injectAsyncBatchedCallback };
49
+ //# sourceMappingURL=injectAsyncBatchedCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncBatchedCallback.js","names":[],"sources":["../../src/async-batcher/injectAsyncBatchedCallback.ts"],"sourcesContent":["import { injectAsyncBatcher } from './injectAsyncBatcher'\nimport type { AsyncBatcherOptions } from '@tanstack/pacer/async-batcher'\n\n/**\n * An Angular function that creates an async batched version of a callback function.\n * This function is essentially a wrapper around `injectAsyncBatcher` that provides\n * a simplified API for basic async batching needs.\n *\n * The batched function will collect items and process them in batches asynchronously based on\n * the configured conditions (maxSize, wait time, etc.).\n *\n * This function provides a simpler API compared to `injectAsyncBatcher`, making it ideal for basic\n * async batching needs. However, it does not expose the underlying AsyncBatcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual flushing\n * - Access to batch state\n * - Error handling callbacks\n * - Retry support\n *\n * Consider using the `injectAsyncBatcher` function instead.\n *\n * @example\n * ```ts\n * // Batch async API calls\n * const batchApiCall = injectAsyncBatchedCallback(\n * async (items: Array<Data>) => {\n * const response = await fetch('/api/batch', {\n * method: 'POST',\n * body: JSON.stringify(items)\n * });\n * return response.json();\n * },\n * { maxSize: 10, wait: 1000 }\n * );\n *\n * // Items will be batched and sent together\n * await batchApiCall(data1);\n * await batchApiCall(data2);\n * ```\n */\nexport function injectAsyncBatchedCallback<TValue>(\n fn: (items: Array<TValue>) => Promise<any>,\n options: AsyncBatcherOptions<TValue>,\n): (item: TValue) => Promise<void> {\n const batcher = injectAsyncBatcher(fn, options)\n return (item: TValue) => batcher.addItem(item)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,2BACd,IACA,SACiC;CACjC,MAAM,UAAU,mBAAmB,IAAI,QAAQ;AAC/C,SAAQ,SAAiB,QAAQ,QAAQ,KAAK"}
@@ -0,0 +1,61 @@
1
+ const require_pacer_context = require('../provider/pacer-context.cjs');
2
+ let _tanstack_angular_store = require("@tanstack/angular-store");
3
+ let _tanstack_pacer_async_batcher = require("@tanstack/pacer/async-batcher");
4
+
5
+ //#region src/async-batcher/injectAsyncBatcher.ts
6
+ /**
7
+ * An Angular function that creates and manages an AsyncBatcher instance.
8
+ *
9
+ * This is a lower-level function that provides direct access to the AsyncBatcher's functionality.
10
+ * This allows you to integrate it with any state management solution you prefer.
11
+ *
12
+ * The AsyncBatcher collects items and processes them in batches asynchronously with support for
13
+ * promise-based processing, error handling, retry capabilities, and abort support.
14
+ *
15
+ * ## State Management and Selector
16
+ *
17
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
18
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
19
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
20
+ *
21
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
22
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
23
+ * full control over when your component tracks state changes.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Default behavior - no reactive state subscriptions
28
+ * const batcher = injectAsyncBatcher(
29
+ * async (items: Array<Data>) => {
30
+ * const response = await fetch('/api/batch', {
31
+ * method: 'POST',
32
+ * body: JSON.stringify(items)
33
+ * });
34
+ * return response.json();
35
+ * },
36
+ * { maxSize: 10, wait: 2000 }
37
+ * );
38
+ *
39
+ * // Add items
40
+ * batcher.addItem(data1);
41
+ * batcher.addItem(data2);
42
+ *
43
+ * // Access the selected state
44
+ * const { items, isExecuting } = batcher.state();
45
+ * ```
46
+ */
47
+ function injectAsyncBatcher(fn, options = {}, selector = () => ({})) {
48
+ const batcher = new _tanstack_pacer_async_batcher.AsyncBatcher(fn, {
49
+ ...require_pacer_context.injectPacerOptions().asyncBatcher,
50
+ ...options
51
+ });
52
+ const state = (0, _tanstack_angular_store.injectStore)(batcher.store, selector);
53
+ return {
54
+ ...batcher,
55
+ state
56
+ };
57
+ }
58
+
59
+ //#endregion
60
+ exports.injectAsyncBatcher = injectAsyncBatcher;
61
+ //# sourceMappingURL=injectAsyncBatcher.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncBatcher.cjs","names":["AsyncBatcher","injectPacerOptions"],"sources":["../../src/async-batcher/injectAsyncBatcher.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { AsyncBatcher } from '@tanstack/pacer/async-batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type {\n AsyncBatcherOptions,\n AsyncBatcherState,\n} from '@tanstack/pacer/async-batcher'\n\nexport interface AngularAsyncBatcher<TValue, TSelected = {}> extends Omit<\n AsyncBatcher<TValue>,\n 'store'\n> {\n /**\n * Reactive state signal that will be updated when the async batcher state changes\n *\n * Use this instead of `batcher.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `batcher.state` instead of `batcher.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<AsyncBatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages an AsyncBatcher instance.\n *\n * This is a lower-level function that provides direct access to the AsyncBatcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The AsyncBatcher collects items and processes them in batches asynchronously with support for\n * promise-based processing, error handling, retry capabilities, and abort support.\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 * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectAsyncBatcher(\n * async (items: Array<Data>) => {\n * const response = await fetch('/api/batch', {\n * method: 'POST',\n * body: JSON.stringify(items)\n * });\n * return response.json();\n * },\n * { maxSize: 10, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem(data1);\n * batcher.addItem(data2);\n *\n * // Access the selected state\n * const { items, isExecuting } = batcher.state();\n * ```\n */\nexport function injectAsyncBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => Promise<any>,\n options: AsyncBatcherOptions<TValue> = {},\n selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): AngularAsyncBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().asyncBatcher,\n ...options,\n } as AsyncBatcherOptions<TValue>\n\n const batcher = new AsyncBatcher<TValue>(fn, mergedOptions)\n const state = injectStore(batcher.store, selector)\n\n return {\n ...batcher,\n state,\n } as AngularAsyncBatcher<TValue, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,SAAgB,mBACd,IACA,UAAuC,EAAE,EACzC,kBACG,EAAE,GACmC;CAMxC,MAAM,UAAU,IAAIA,2CAAqB,IALnB;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAE0D;CAC3D,MAAM,iDAAoB,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
@@ -0,0 +1,63 @@
1
+ import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
2
+ import { Signal } from "@angular/core";
3
+ import { Store } from "@tanstack/store";
4
+
5
+ //#region src/async-batcher/injectAsyncBatcher.d.ts
6
+ interface AngularAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
7
+ /**
8
+ * Reactive state signal that will be updated when the async batcher state changes
9
+ *
10
+ * Use this instead of `batcher.store.state`
11
+ */
12
+ readonly state: Signal<Readonly<TSelected>>;
13
+ /**
14
+ * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
15
+ * The state on the store object is not reactive in Angular signals.
16
+ */
17
+ readonly store: Store<Readonly<AsyncBatcherState<TValue>>>;
18
+ }
19
+ /**
20
+ * An Angular function that creates and manages an AsyncBatcher instance.
21
+ *
22
+ * This is a lower-level function that provides direct access to the AsyncBatcher's functionality.
23
+ * This allows you to integrate it with any state management solution you prefer.
24
+ *
25
+ * The AsyncBatcher collects items and processes them in batches asynchronously with support for
26
+ * promise-based processing, error handling, retry capabilities, and abort support.
27
+ *
28
+ * ## State Management and Selector
29
+ *
30
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
31
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
32
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
33
+ *
34
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
35
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
36
+ * full control over when your component tracks state changes.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * // Default behavior - no reactive state subscriptions
41
+ * const batcher = injectAsyncBatcher(
42
+ * async (items: Array<Data>) => {
43
+ * const response = await fetch('/api/batch', {
44
+ * method: 'POST',
45
+ * body: JSON.stringify(items)
46
+ * });
47
+ * return response.json();
48
+ * },
49
+ * { maxSize: 10, wait: 2000 }
50
+ * );
51
+ *
52
+ * // Add items
53
+ * batcher.addItem(data1);
54
+ * batcher.addItem(data2);
55
+ *
56
+ * // Access the selected state
57
+ * const { items, isExecuting } = batcher.state();
58
+ * ```
59
+ */
60
+ declare function injectAsyncBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => Promise<any>, options?: AsyncBatcherOptions<TValue>, selector?: (state: AsyncBatcherState<TValue>) => TSelected): AngularAsyncBatcher<TValue, TSelected>;
61
+ //#endregion
62
+ export { AngularAsyncBatcher, injectAsyncBatcher };
63
+ //# sourceMappingURL=injectAsyncBatcher.d.cts.map
@@ -0,0 +1,63 @@
1
+ import { Signal } from "@angular/core";
2
+ import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
3
+ import { Store } from "@tanstack/store";
4
+
5
+ //#region src/async-batcher/injectAsyncBatcher.d.ts
6
+ interface AngularAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
7
+ /**
8
+ * Reactive state signal that will be updated when the async batcher state changes
9
+ *
10
+ * Use this instead of `batcher.store.state`
11
+ */
12
+ readonly state: Signal<Readonly<TSelected>>;
13
+ /**
14
+ * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
15
+ * The state on the store object is not reactive in Angular signals.
16
+ */
17
+ readonly store: Store<Readonly<AsyncBatcherState<TValue>>>;
18
+ }
19
+ /**
20
+ * An Angular function that creates and manages an AsyncBatcher instance.
21
+ *
22
+ * This is a lower-level function that provides direct access to the AsyncBatcher's functionality.
23
+ * This allows you to integrate it with any state management solution you prefer.
24
+ *
25
+ * The AsyncBatcher collects items and processes them in batches asynchronously with support for
26
+ * promise-based processing, error handling, retry capabilities, and abort support.
27
+ *
28
+ * ## State Management and Selector
29
+ *
30
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
31
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
32
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
33
+ *
34
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
35
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
36
+ * full control over when your component tracks state changes.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * // Default behavior - no reactive state subscriptions
41
+ * const batcher = injectAsyncBatcher(
42
+ * async (items: Array<Data>) => {
43
+ * const response = await fetch('/api/batch', {
44
+ * method: 'POST',
45
+ * body: JSON.stringify(items)
46
+ * });
47
+ * return response.json();
48
+ * },
49
+ * { maxSize: 10, wait: 2000 }
50
+ * );
51
+ *
52
+ * // Add items
53
+ * batcher.addItem(data1);
54
+ * batcher.addItem(data2);
55
+ *
56
+ * // Access the selected state
57
+ * const { items, isExecuting } = batcher.state();
58
+ * ```
59
+ */
60
+ declare function injectAsyncBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => Promise<any>, options?: AsyncBatcherOptions<TValue>, selector?: (state: AsyncBatcherState<TValue>) => TSelected): AngularAsyncBatcher<TValue, TSelected>;
61
+ //#endregion
62
+ export { AngularAsyncBatcher, injectAsyncBatcher };
63
+ //# sourceMappingURL=injectAsyncBatcher.d.ts.map