@tanstack/angular-pacer 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (280) hide show
  1. package/README.md +165 -0
  2. package/dist/async-batcher/index.cjs +13 -0
  3. package/dist/async-batcher/index.d.cts +4 -0
  4. package/dist/async-batcher/index.d.ts +4 -0
  5. package/dist/async-batcher/index.js +6 -0
  6. package/dist/async-batcher/injectAsyncBatchedCallback.cjs +49 -0
  7. package/dist/async-batcher/injectAsyncBatchedCallback.cjs.map +1 -0
  8. package/dist/async-batcher/injectAsyncBatchedCallback.d.cts +45 -0
  9. package/dist/async-batcher/injectAsyncBatchedCallback.d.ts +45 -0
  10. package/dist/async-batcher/injectAsyncBatchedCallback.js +49 -0
  11. package/dist/async-batcher/injectAsyncBatchedCallback.js.map +1 -0
  12. package/dist/async-batcher/injectAsyncBatcher.cjs +61 -0
  13. package/dist/async-batcher/injectAsyncBatcher.cjs.map +1 -0
  14. package/dist/async-batcher/injectAsyncBatcher.d.cts +63 -0
  15. package/dist/async-batcher/injectAsyncBatcher.d.ts +63 -0
  16. package/dist/async-batcher/injectAsyncBatcher.js +61 -0
  17. package/dist/async-batcher/injectAsyncBatcher.js.map +1 -0
  18. package/dist/async-debouncer/index.cjs +13 -0
  19. package/dist/async-debouncer/index.d.cts +4 -0
  20. package/dist/async-debouncer/index.d.ts +4 -0
  21. package/dist/async-debouncer/index.js +6 -0
  22. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs +49 -0
  23. package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs.map +1 -0
  24. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.cts +43 -0
  25. package/dist/async-debouncer/injectAsyncDebouncedCallback.d.ts +43 -0
  26. package/dist/async-debouncer/injectAsyncDebouncedCallback.js +49 -0
  27. package/dist/async-debouncer/injectAsyncDebouncedCallback.js.map +1 -0
  28. package/dist/async-debouncer/injectAsyncDebouncer.cjs +83 -0
  29. package/dist/async-debouncer/injectAsyncDebouncer.cjs.map +1 -0
  30. package/dist/async-debouncer/injectAsyncDebouncer.d.cts +86 -0
  31. package/dist/async-debouncer/injectAsyncDebouncer.d.ts +86 -0
  32. package/dist/async-debouncer/injectAsyncDebouncer.js +83 -0
  33. package/dist/async-debouncer/injectAsyncDebouncer.js.map +1 -0
  34. package/dist/async-queuer/index.cjs +13 -0
  35. package/dist/async-queuer/index.d.cts +4 -0
  36. package/dist/async-queuer/index.d.ts +4 -0
  37. package/dist/async-queuer/index.js +6 -0
  38. package/dist/async-queuer/injectAsyncQueuedSignal.cjs +53 -0
  39. package/dist/async-queuer/injectAsyncQueuedSignal.cjs.map +1 -0
  40. package/dist/async-queuer/injectAsyncQueuedSignal.d.cts +55 -0
  41. package/dist/async-queuer/injectAsyncQueuedSignal.d.ts +55 -0
  42. package/dist/async-queuer/injectAsyncQueuedSignal.js +53 -0
  43. package/dist/async-queuer/injectAsyncQueuedSignal.js.map +1 -0
  44. package/dist/async-queuer/injectAsyncQueuer.cjs +61 -0
  45. package/dist/async-queuer/injectAsyncQueuer.cjs.map +1 -0
  46. package/dist/async-queuer/injectAsyncQueuer.d.cts +63 -0
  47. package/dist/async-queuer/injectAsyncQueuer.d.ts +63 -0
  48. package/dist/async-queuer/injectAsyncQueuer.js +61 -0
  49. package/dist/async-queuer/injectAsyncQueuer.js.map +1 -0
  50. package/dist/async-rate-limiter/index.cjs +13 -0
  51. package/dist/async-rate-limiter/index.d.cts +4 -0
  52. package/dist/async-rate-limiter/index.d.ts +4 -0
  53. package/dist/async-rate-limiter/index.js +6 -0
  54. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs +52 -0
  55. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs.map +1 -0
  56. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.cts +46 -0
  57. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.ts +46 -0
  58. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js +52 -0
  59. package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js.map +1 -0
  60. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs +57 -0
  61. package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs.map +1 -0
  62. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.cts +60 -0
  63. package/dist/async-rate-limiter/injectAsyncRateLimiter.d.ts +60 -0
  64. package/dist/async-rate-limiter/injectAsyncRateLimiter.js +57 -0
  65. package/dist/async-rate-limiter/injectAsyncRateLimiter.js.map +1 -0
  66. package/dist/async-retryer/index.cjs +9 -0
  67. package/dist/async-retryer/index.d.cts +1 -0
  68. package/dist/async-retryer/index.d.ts +1 -0
  69. package/dist/async-retryer/index.js +3 -0
  70. package/dist/async-throttler/index.cjs +13 -0
  71. package/dist/async-throttler/index.d.cts +4 -0
  72. package/dist/async-throttler/index.d.ts +4 -0
  73. package/dist/async-throttler/index.js +6 -0
  74. package/dist/async-throttler/injectAsyncThrottledCallback.cjs +50 -0
  75. package/dist/async-throttler/injectAsyncThrottledCallback.cjs.map +1 -0
  76. package/dist/async-throttler/injectAsyncThrottledCallback.d.cts +44 -0
  77. package/dist/async-throttler/injectAsyncThrottledCallback.d.ts +44 -0
  78. package/dist/async-throttler/injectAsyncThrottledCallback.js +50 -0
  79. package/dist/async-throttler/injectAsyncThrottledCallback.js.map +1 -0
  80. package/dist/async-throttler/injectAsyncThrottler.cjs +62 -0
  81. package/dist/async-throttler/injectAsyncThrottler.cjs.map +1 -0
  82. package/dist/async-throttler/injectAsyncThrottler.d.cts +65 -0
  83. package/dist/async-throttler/injectAsyncThrottler.d.ts +65 -0
  84. package/dist/async-throttler/injectAsyncThrottler.js +62 -0
  85. package/dist/async-throttler/injectAsyncThrottler.js.map +1 -0
  86. package/dist/batcher/index.cjs +13 -0
  87. package/dist/batcher/index.d.cts +4 -0
  88. package/dist/batcher/index.d.ts +4 -0
  89. package/dist/batcher/index.js +6 -0
  90. package/dist/batcher/injectBatchedCallback.cjs +47 -0
  91. package/dist/batcher/injectBatchedCallback.cjs.map +1 -0
  92. package/dist/batcher/injectBatchedCallback.d.cts +43 -0
  93. package/dist/batcher/injectBatchedCallback.d.ts +43 -0
  94. package/dist/batcher/injectBatchedCallback.js +47 -0
  95. package/dist/batcher/injectBatchedCallback.js.map +1 -0
  96. package/dist/batcher/injectBatcher.cjs +56 -0
  97. package/dist/batcher/injectBatcher.cjs.map +1 -0
  98. package/dist/batcher/injectBatcher.d.cts +58 -0
  99. package/dist/batcher/injectBatcher.d.ts +58 -0
  100. package/dist/batcher/injectBatcher.js +56 -0
  101. package/dist/batcher/injectBatcher.js.map +1 -0
  102. package/dist/debouncer/index.cjs +17 -0
  103. package/dist/debouncer/index.d.cts +6 -0
  104. package/dist/debouncer/index.d.ts +6 -0
  105. package/dist/debouncer/index.js +8 -0
  106. package/dist/debouncer/injectDebouncedCallback.cjs +46 -0
  107. package/dist/debouncer/injectDebouncedCallback.cjs.map +1 -0
  108. package/dist/debouncer/injectDebouncedCallback.d.cts +43 -0
  109. package/dist/debouncer/injectDebouncedCallback.d.ts +43 -0
  110. package/dist/debouncer/injectDebouncedCallback.js +46 -0
  111. package/dist/debouncer/injectDebouncedCallback.js.map +1 -0
  112. package/dist/debouncer/injectDebouncedSignal.cjs +68 -0
  113. package/dist/debouncer/injectDebouncedSignal.cjs.map +1 -0
  114. package/dist/debouncer/injectDebouncedSignal.d.cts +65 -0
  115. package/dist/debouncer/injectDebouncedSignal.d.ts +65 -0
  116. package/dist/debouncer/injectDebouncedSignal.js +68 -0
  117. package/dist/debouncer/injectDebouncedSignal.js.map +1 -0
  118. package/dist/debouncer/injectDebouncedValue.cjs +17 -0
  119. package/dist/debouncer/injectDebouncedValue.cjs.map +1 -0
  120. package/dist/debouncer/injectDebouncedValue.d.cts +76 -0
  121. package/dist/debouncer/injectDebouncedValue.d.ts +76 -0
  122. package/dist/debouncer/injectDebouncedValue.js +17 -0
  123. package/dist/debouncer/injectDebouncedValue.js.map +1 -0
  124. package/dist/debouncer/injectDebouncer.cjs +76 -0
  125. package/dist/debouncer/injectDebouncer.cjs.map +1 -0
  126. package/dist/debouncer/injectDebouncer.d.cts +79 -0
  127. package/dist/debouncer/injectDebouncer.d.ts +79 -0
  128. package/dist/debouncer/injectDebouncer.js +76 -0
  129. package/dist/debouncer/injectDebouncer.js.map +1 -0
  130. package/dist/index.cjs +65 -0
  131. package/dist/index.d.cts +30 -0
  132. package/dist/index.d.ts +30 -0
  133. package/dist/index.js +32 -0
  134. package/dist/provider/index.cjs +7 -0
  135. package/dist/provider/index.d.cts +3 -0
  136. package/dist/provider/index.d.ts +3 -0
  137. package/dist/provider/index.js +4 -0
  138. package/dist/provider/pacer-context.cjs +20 -0
  139. package/dist/provider/pacer-context.cjs.map +1 -0
  140. package/dist/provider/pacer-context.d.cts +21 -0
  141. package/dist/provider/pacer-context.d.ts +21 -0
  142. package/dist/provider/pacer-context.js +19 -0
  143. package/dist/provider/pacer-context.js.map +1 -0
  144. package/dist/provider/pacer-provider.cjs +41 -0
  145. package/dist/provider/pacer-provider.cjs.map +1 -0
  146. package/dist/provider/pacer-provider.d.cts +36 -0
  147. package/dist/provider/pacer-provider.d.ts +36 -0
  148. package/dist/provider/pacer-provider.js +41 -0
  149. package/dist/provider/pacer-provider.js.map +1 -0
  150. package/dist/queuer/index.cjs +15 -0
  151. package/dist/queuer/index.d.cts +5 -0
  152. package/dist/queuer/index.d.ts +5 -0
  153. package/dist/queuer/index.js +7 -0
  154. package/dist/queuer/injectQueuedSignal.cjs +47 -0
  155. package/dist/queuer/injectQueuedSignal.cjs.map +1 -0
  156. package/dist/queuer/injectQueuedSignal.d.cts +49 -0
  157. package/dist/queuer/injectQueuedSignal.d.ts +49 -0
  158. package/dist/queuer/injectQueuedSignal.js +47 -0
  159. package/dist/queuer/injectQueuedSignal.js.map +1 -0
  160. package/dist/queuer/injectQueuedValue.cjs +23 -0
  161. package/dist/queuer/injectQueuedValue.cjs.map +1 -0
  162. package/dist/queuer/injectQueuedValue.d.cts +34 -0
  163. package/dist/queuer/injectQueuedValue.d.ts +34 -0
  164. package/dist/queuer/injectQueuedValue.js +23 -0
  165. package/dist/queuer/injectQueuedValue.js.map +1 -0
  166. package/dist/queuer/injectQueuer.cjs +61 -0
  167. package/dist/queuer/injectQueuer.cjs.map +1 -0
  168. package/dist/queuer/injectQueuer.d.cts +63 -0
  169. package/dist/queuer/injectQueuer.d.ts +63 -0
  170. package/dist/queuer/injectQueuer.js +61 -0
  171. package/dist/queuer/injectQueuer.js.map +1 -0
  172. package/dist/rate-limiter/index.cjs +17 -0
  173. package/dist/rate-limiter/index.d.cts +6 -0
  174. package/dist/rate-limiter/index.d.ts +6 -0
  175. package/dist/rate-limiter/index.js +8 -0
  176. package/dist/rate-limiter/injectRateLimitedCallback.cjs +45 -0
  177. package/dist/rate-limiter/injectRateLimitedCallback.cjs.map +1 -0
  178. package/dist/rate-limiter/injectRateLimitedCallback.d.cts +42 -0
  179. package/dist/rate-limiter/injectRateLimitedCallback.d.ts +42 -0
  180. package/dist/rate-limiter/injectRateLimitedCallback.js +45 -0
  181. package/dist/rate-limiter/injectRateLimitedCallback.js.map +1 -0
  182. package/dist/rate-limiter/injectRateLimitedSignal.cjs +62 -0
  183. package/dist/rate-limiter/injectRateLimitedSignal.cjs.map +1 -0
  184. package/dist/rate-limiter/injectRateLimitedSignal.d.cts +59 -0
  185. package/dist/rate-limiter/injectRateLimitedSignal.d.ts +59 -0
  186. package/dist/rate-limiter/injectRateLimitedSignal.js +62 -0
  187. package/dist/rate-limiter/injectRateLimitedSignal.js.map +1 -0
  188. package/dist/rate-limiter/injectRateLimitedValue.cjs +17 -0
  189. package/dist/rate-limiter/injectRateLimitedValue.cjs.map +1 -0
  190. package/dist/rate-limiter/injectRateLimitedValue.d.cts +49 -0
  191. package/dist/rate-limiter/injectRateLimitedValue.d.ts +49 -0
  192. package/dist/rate-limiter/injectRateLimitedValue.js +17 -0
  193. package/dist/rate-limiter/injectRateLimitedValue.js.map +1 -0
  194. package/dist/rate-limiter/injectRateLimiter.cjs +90 -0
  195. package/dist/rate-limiter/injectRateLimiter.cjs.map +1 -0
  196. package/dist/rate-limiter/injectRateLimiter.d.cts +93 -0
  197. package/dist/rate-limiter/injectRateLimiter.d.ts +93 -0
  198. package/dist/rate-limiter/injectRateLimiter.js +90 -0
  199. package/dist/rate-limiter/injectRateLimiter.js.map +1 -0
  200. package/dist/throttler/index.cjs +17 -0
  201. package/dist/throttler/index.d.cts +6 -0
  202. package/dist/throttler/index.d.ts +6 -0
  203. package/dist/throttler/index.js +8 -0
  204. package/dist/throttler/injectThrottledCallback.cjs +45 -0
  205. package/dist/throttler/injectThrottledCallback.cjs.map +1 -0
  206. package/dist/throttler/injectThrottledCallback.d.cts +42 -0
  207. package/dist/throttler/injectThrottledCallback.d.ts +42 -0
  208. package/dist/throttler/injectThrottledCallback.js +45 -0
  209. package/dist/throttler/injectThrottledCallback.js.map +1 -0
  210. package/dist/throttler/injectThrottledSignal.cjs +69 -0
  211. package/dist/throttler/injectThrottledSignal.cjs.map +1 -0
  212. package/dist/throttler/injectThrottledSignal.d.cts +66 -0
  213. package/dist/throttler/injectThrottledSignal.d.ts +66 -0
  214. package/dist/throttler/injectThrottledSignal.js +69 -0
  215. package/dist/throttler/injectThrottledSignal.js.map +1 -0
  216. package/dist/throttler/injectThrottledValue.cjs +17 -0
  217. package/dist/throttler/injectThrottledValue.cjs.map +1 -0
  218. package/dist/throttler/injectThrottledValue.d.cts +74 -0
  219. package/dist/throttler/injectThrottledValue.d.ts +74 -0
  220. package/dist/throttler/injectThrottledValue.js +17 -0
  221. package/dist/throttler/injectThrottledValue.js.map +1 -0
  222. package/dist/throttler/injectThrottler.cjs +76 -0
  223. package/dist/throttler/injectThrottler.cjs.map +1 -0
  224. package/dist/throttler/injectThrottler.d.cts +79 -0
  225. package/dist/throttler/injectThrottler.d.ts +79 -0
  226. package/dist/throttler/injectThrottler.js +76 -0
  227. package/dist/throttler/injectThrottler.js.map +1 -0
  228. package/dist/types/index.cjs +9 -0
  229. package/dist/types/index.d.cts +1 -0
  230. package/dist/types/index.d.ts +1 -0
  231. package/dist/types/index.js +3 -0
  232. package/dist/utils/index.cjs +9 -0
  233. package/dist/utils/index.d.cts +1 -0
  234. package/dist/utils/index.d.ts +1 -0
  235. package/dist/utils/index.js +3 -0
  236. package/package.json +121 -0
  237. package/src/async-batcher/index.ts +4 -0
  238. package/src/async-batcher/injectAsyncBatchedCallback.ts +48 -0
  239. package/src/async-batcher/injectAsyncBatcher.ts +87 -0
  240. package/src/async-debouncer/index.ts +4 -0
  241. package/src/async-debouncer/injectAsyncDebouncedCallback.ts +50 -0
  242. package/src/async-debouncer/injectAsyncDebouncer.ts +113 -0
  243. package/src/async-queuer/index.ts +4 -0
  244. package/src/async-queuer/injectAsyncQueuedSignal.ts +82 -0
  245. package/src/async-queuer/injectAsyncQueuer.ts +87 -0
  246. package/src/async-rate-limiter/index.ts +4 -0
  247. package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts +52 -0
  248. package/src/async-rate-limiter/injectAsyncRateLimiter.ts +87 -0
  249. package/src/async-retryer/index.ts +1 -0
  250. package/src/async-throttler/index.ts +4 -0
  251. package/src/async-throttler/injectAsyncThrottledCallback.ts +50 -0
  252. package/src/async-throttler/injectAsyncThrottler.ts +92 -0
  253. package/src/batcher/index.ts +4 -0
  254. package/src/batcher/injectBatchedCallback.ts +46 -0
  255. package/src/batcher/injectBatcher.ts +79 -0
  256. package/src/debouncer/index.ts +6 -0
  257. package/src/debouncer/injectDebouncedCallback.ts +46 -0
  258. package/src/debouncer/injectDebouncedSignal.ts +101 -0
  259. package/src/debouncer/injectDebouncedValue.ts +126 -0
  260. package/src/debouncer/injectDebouncer.ts +102 -0
  261. package/src/index.ts +40 -0
  262. package/src/provider/index.ts +2 -0
  263. package/src/provider/pacer-context.ts +46 -0
  264. package/src/provider/pacer-provider.ts +38 -0
  265. package/src/queuer/index.ts +5 -0
  266. package/src/queuer/injectQueuedSignal.ts +70 -0
  267. package/src/queuer/injectQueuedValue.ts +101 -0
  268. package/src/queuer/injectQueuer.ts +83 -0
  269. package/src/rate-limiter/index.ts +6 -0
  270. package/src/rate-limiter/injectRateLimitedCallback.ts +45 -0
  271. package/src/rate-limiter/injectRateLimitedSignal.ts +95 -0
  272. package/src/rate-limiter/injectRateLimitedValue.ts +99 -0
  273. package/src/rate-limiter/injectRateLimiter.ts +116 -0
  274. package/src/throttler/index.ts +6 -0
  275. package/src/throttler/injectThrottledCallback.ts +45 -0
  276. package/src/throttler/injectThrottledSignal.ts +102 -0
  277. package/src/throttler/injectThrottledValue.ts +124 -0
  278. package/src/throttler/injectThrottler.ts +102 -0
  279. package/src/types/index.ts +1 -0
  280. package/src/utils/index.ts +1 -0
@@ -0,0 +1,61 @@
1
+ import { injectPacerOptions } from "../provider/pacer-context.js";
2
+ import { injectStore } from "@tanstack/angular-store";
3
+ import { AsyncBatcher } from "@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 AsyncBatcher(fn, {
49
+ ...injectPacerOptions().asyncBatcher,
50
+ ...options
51
+ });
52
+ const state = injectStore(batcher.store, selector);
53
+ return {
54
+ ...batcher,
55
+ state
56
+ };
57
+ }
58
+
59
+ //#endregion
60
+ export { injectAsyncBatcher };
61
+ //# sourceMappingURL=injectAsyncBatcher.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncBatcher.js","names":[],"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,IAAI,aAAqB,IALnB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ,CAE0D;CAC3D,MAAM,QAAQ,YAAY,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
@@ -0,0 +1,13 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+ const require_injectAsyncDebouncer = require('./injectAsyncDebouncer.cjs');
3
+ const require_injectAsyncDebouncedCallback = require('./injectAsyncDebouncedCallback.cjs');
4
+
5
+ exports.injectAsyncDebouncedCallback = require_injectAsyncDebouncedCallback.injectAsyncDebouncedCallback;
6
+ exports.injectAsyncDebouncer = require_injectAsyncDebouncer.injectAsyncDebouncer;
7
+ var _tanstack_pacer_async_debouncer = require("@tanstack/pacer/async-debouncer");
8
+ Object.keys(_tanstack_pacer_async_debouncer).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_debouncer[k]; }
12
+ });
13
+ });
@@ -0,0 +1,4 @@
1
+ import { injectAsyncDebouncedCallback } from "./injectAsyncDebouncedCallback.cjs";
2
+ import { AngularAsyncDebouncer, injectAsyncDebouncer } from "./injectAsyncDebouncer.cjs";
3
+ export * from "@tanstack/pacer/async-debouncer";
4
+ export { AngularAsyncDebouncer, injectAsyncDebouncedCallback, injectAsyncDebouncer };
@@ -0,0 +1,4 @@
1
+ import { injectAsyncDebouncedCallback } from "./injectAsyncDebouncedCallback.js";
2
+ import { AngularAsyncDebouncer, injectAsyncDebouncer } from "./injectAsyncDebouncer.js";
3
+ export * from "@tanstack/pacer/async-debouncer";
4
+ export { AngularAsyncDebouncer, injectAsyncDebouncedCallback, injectAsyncDebouncer };
@@ -0,0 +1,6 @@
1
+ import { injectAsyncDebouncer } from "./injectAsyncDebouncer.js";
2
+ import { injectAsyncDebouncedCallback } from "./injectAsyncDebouncedCallback.js";
3
+
4
+ export * from "@tanstack/pacer/async-debouncer"
5
+
6
+ export { injectAsyncDebouncedCallback, injectAsyncDebouncer };
@@ -0,0 +1,49 @@
1
+ const require_injectAsyncDebouncer = require('./injectAsyncDebouncer.cjs');
2
+
3
+ //#region src/async-debouncer/injectAsyncDebouncedCallback.ts
4
+ /**
5
+ * An Angular function that creates an async debounced version of a callback function.
6
+ * This function is essentially a wrapper around `injectAsyncDebouncer` that provides
7
+ * a simplified API for basic async debouncing needs.
8
+ *
9
+ * The debounced function will only execute after the specified wait time has elapsed
10
+ * since its last invocation. If called again before the wait time expires, the timer
11
+ * resets and starts waiting again.
12
+ *
13
+ * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic
14
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
15
+ *
16
+ * For advanced usage requiring features like:
17
+ * - Manual cancellation
18
+ * - Access to execution counts
19
+ * - Error handling callbacks
20
+ * - Retry support
21
+ *
22
+ * Consider using the `injectAsyncDebouncer` function instead.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * // Debounce an async search handler
27
+ * const handleSearch = injectAsyncDebouncedCallback(
28
+ * async (query: string) => {
29
+ * const response = await fetch(`/api/search?q=${query}`);
30
+ * return response.json();
31
+ * },
32
+ * { wait: 500 }
33
+ * );
34
+ *
35
+ * // Use in an input
36
+ * const results = await handleSearch(searchQuery);
37
+ * ```
38
+ */
39
+ function injectAsyncDebouncedCallback(fn, options) {
40
+ const debouncer = require_injectAsyncDebouncer.injectAsyncDebouncer(fn, options);
41
+ return async (...args) => {
42
+ const result = await debouncer.maybeExecute(...args);
43
+ return result !== void 0 ? await result : void 0;
44
+ };
45
+ }
46
+
47
+ //#endregion
48
+ exports.injectAsyncDebouncedCallback = injectAsyncDebouncedCallback;
49
+ //# sourceMappingURL=injectAsyncDebouncedCallback.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncDebouncedCallback.cjs","names":["injectAsyncDebouncer"],"sources":["../../src/async-debouncer/injectAsyncDebouncedCallback.ts"],"sourcesContent":["import { injectAsyncDebouncer } from './injectAsyncDebouncer'\nimport type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates an async debounced version of a callback function.\n * This function is essentially a wrapper around `injectAsyncDebouncer` that provides\n * a simplified API for basic async debouncing needs.\n *\n * The debounced function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again.\n *\n * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic\n * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Error handling callbacks\n * - Retry support\n *\n * Consider using the `injectAsyncDebouncer` function instead.\n *\n * @example\n * ```ts\n * // Debounce an async search handler\n * const handleSearch = injectAsyncDebouncedCallback(\n * async (query: string) => {\n * const response = await fetch(`/api/search?q=${query}`);\n * return response.json();\n * },\n * { wait: 500 }\n * );\n *\n * // Use in an input\n * const results = await handleSearch(searchQuery);\n * ```\n */\nexport function injectAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n const debouncer = injectAsyncDebouncer(fn, options)\n return async (...args: Parameters<TFn>) => {\n const result = await debouncer.maybeExecute(...args)\n // Not sure if this is the best way to handle this,\n return result !== undefined ? await result : undefined\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,6BACd,IACA,SAC6E;CAC7E,MAAM,YAAYA,kDAAqB,IAAI,QAAQ;AACnD,QAAO,OAAO,GAAG,SAA0B;EACzC,MAAM,SAAS,MAAM,UAAU,aAAa,GAAG,KAAK;AAEpD,SAAO,WAAW,SAAY,MAAM,SAAS"}
@@ -0,0 +1,43 @@
1
+ import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
2
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
3
+
4
+ //#region src/async-debouncer/injectAsyncDebouncedCallback.d.ts
5
+ /**
6
+ * An Angular function that creates an async debounced version of a callback function.
7
+ * This function is essentially a wrapper around `injectAsyncDebouncer` that provides
8
+ * a simplified API for basic async debouncing needs.
9
+ *
10
+ * The debounced function will only execute after the specified wait time has elapsed
11
+ * since its last invocation. If called again before the wait time expires, the timer
12
+ * resets and starts waiting again.
13
+ *
14
+ * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic
15
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
16
+ *
17
+ * For advanced usage requiring features like:
18
+ * - Manual cancellation
19
+ * - Access to execution counts
20
+ * - Error handling callbacks
21
+ * - Retry support
22
+ *
23
+ * Consider using the `injectAsyncDebouncer` function instead.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Debounce an async search handler
28
+ * const handleSearch = injectAsyncDebouncedCallback(
29
+ * async (query: string) => {
30
+ * const response = await fetch(`/api/search?q=${query}`);
31
+ * return response.json();
32
+ * },
33
+ * { wait: 500 }
34
+ * );
35
+ *
36
+ * // Use in an input
37
+ * const results = await handleSearch(searchQuery);
38
+ * ```
39
+ */
40
+ declare function injectAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
41
+ //#endregion
42
+ export { injectAsyncDebouncedCallback };
43
+ //# sourceMappingURL=injectAsyncDebouncedCallback.d.cts.map
@@ -0,0 +1,43 @@
1
+ import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
2
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
3
+
4
+ //#region src/async-debouncer/injectAsyncDebouncedCallback.d.ts
5
+ /**
6
+ * An Angular function that creates an async debounced version of a callback function.
7
+ * This function is essentially a wrapper around `injectAsyncDebouncer` that provides
8
+ * a simplified API for basic async debouncing needs.
9
+ *
10
+ * The debounced function will only execute after the specified wait time has elapsed
11
+ * since its last invocation. If called again before the wait time expires, the timer
12
+ * resets and starts waiting again.
13
+ *
14
+ * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic
15
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
16
+ *
17
+ * For advanced usage requiring features like:
18
+ * - Manual cancellation
19
+ * - Access to execution counts
20
+ * - Error handling callbacks
21
+ * - Retry support
22
+ *
23
+ * Consider using the `injectAsyncDebouncer` function instead.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Debounce an async search handler
28
+ * const handleSearch = injectAsyncDebouncedCallback(
29
+ * async (query: string) => {
30
+ * const response = await fetch(`/api/search?q=${query}`);
31
+ * return response.json();
32
+ * },
33
+ * { wait: 500 }
34
+ * );
35
+ *
36
+ * // Use in an input
37
+ * const results = await handleSearch(searchQuery);
38
+ * ```
39
+ */
40
+ declare function injectAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
41
+ //#endregion
42
+ export { injectAsyncDebouncedCallback };
43
+ //# sourceMappingURL=injectAsyncDebouncedCallback.d.ts.map
@@ -0,0 +1,49 @@
1
+ import { injectAsyncDebouncer } from "./injectAsyncDebouncer.js";
2
+
3
+ //#region src/async-debouncer/injectAsyncDebouncedCallback.ts
4
+ /**
5
+ * An Angular function that creates an async debounced version of a callback function.
6
+ * This function is essentially a wrapper around `injectAsyncDebouncer` that provides
7
+ * a simplified API for basic async debouncing needs.
8
+ *
9
+ * The debounced function will only execute after the specified wait time has elapsed
10
+ * since its last invocation. If called again before the wait time expires, the timer
11
+ * resets and starts waiting again.
12
+ *
13
+ * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic
14
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
15
+ *
16
+ * For advanced usage requiring features like:
17
+ * - Manual cancellation
18
+ * - Access to execution counts
19
+ * - Error handling callbacks
20
+ * - Retry support
21
+ *
22
+ * Consider using the `injectAsyncDebouncer` function instead.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * // Debounce an async search handler
27
+ * const handleSearch = injectAsyncDebouncedCallback(
28
+ * async (query: string) => {
29
+ * const response = await fetch(`/api/search?q=${query}`);
30
+ * return response.json();
31
+ * },
32
+ * { wait: 500 }
33
+ * );
34
+ *
35
+ * // Use in an input
36
+ * const results = await handleSearch(searchQuery);
37
+ * ```
38
+ */
39
+ function injectAsyncDebouncedCallback(fn, options) {
40
+ const debouncer = injectAsyncDebouncer(fn, options);
41
+ return async (...args) => {
42
+ const result = await debouncer.maybeExecute(...args);
43
+ return result !== void 0 ? await result : void 0;
44
+ };
45
+ }
46
+
47
+ //#endregion
48
+ export { injectAsyncDebouncedCallback };
49
+ //# sourceMappingURL=injectAsyncDebouncedCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncDebouncedCallback.js","names":[],"sources":["../../src/async-debouncer/injectAsyncDebouncedCallback.ts"],"sourcesContent":["import { injectAsyncDebouncer } from './injectAsyncDebouncer'\nimport type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates an async debounced version of a callback function.\n * This function is essentially a wrapper around `injectAsyncDebouncer` that provides\n * a simplified API for basic async debouncing needs.\n *\n * The debounced function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again.\n *\n * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic\n * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Error handling callbacks\n * - Retry support\n *\n * Consider using the `injectAsyncDebouncer` function instead.\n *\n * @example\n * ```ts\n * // Debounce an async search handler\n * const handleSearch = injectAsyncDebouncedCallback(\n * async (query: string) => {\n * const response = await fetch(`/api/search?q=${query}`);\n * return response.json();\n * },\n * { wait: 500 }\n * );\n *\n * // Use in an input\n * const results = await handleSearch(searchQuery);\n * ```\n */\nexport function injectAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n const debouncer = injectAsyncDebouncer(fn, options)\n return async (...args: Parameters<TFn>) => {\n const result = await debouncer.maybeExecute(...args)\n // Not sure if this is the best way to handle this,\n return result !== undefined ? await result : undefined\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,6BACd,IACA,SAC6E;CAC7E,MAAM,YAAY,qBAAqB,IAAI,QAAQ;AACnD,QAAO,OAAO,GAAG,SAA0B;EACzC,MAAM,SAAS,MAAM,UAAU,aAAa,GAAG,KAAK;AAEpD,SAAO,WAAW,SAAY,MAAM,SAAS"}
@@ -0,0 +1,83 @@
1
+ const require_pacer_context = require('../provider/pacer-context.cjs');
2
+ let _tanstack_angular_store = require("@tanstack/angular-store");
3
+ let _tanstack_pacer_async_debouncer = require("@tanstack/pacer/async-debouncer");
4
+
5
+ //#region src/async-debouncer/injectAsyncDebouncer.ts
6
+ /**
7
+ * An Angular function that creates and manages an AsyncDebouncer instance.
8
+ *
9
+ * This is a lower-level function that provides direct access to the AsyncDebouncer's functionality.
10
+ * This allows you to integrate it with any state management solution you prefer.
11
+ *
12
+ * This function provides async debouncing functionality with promise support, error handling,
13
+ * retry capabilities, and abort support.
14
+ *
15
+ * The debouncer will only execute the function after the specified wait time has elapsed
16
+ * since the last call. If the function is called again before the wait time expires, the
17
+ * timer resets and starts waiting again.
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 debouncer can execute on the leading edge
31
+ * - `errorCount`: Number of function executions that have resulted in errors
32
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
33
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
34
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
35
+ * - `lastResult`: The result from the most recent successful function execution
36
+ * - `settleCount`: Number of function executions that have completed (either successfully or with errors)
37
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
38
+ * - `successCount`: Number of function executions that have completed successfully
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * // Default behavior - no reactive state subscriptions
43
+ * const debouncer = injectAsyncDebouncer(
44
+ * async (query: string) => {
45
+ * const response = await fetch(`/api/search?q=${query}`);
46
+ * return response.json();
47
+ * },
48
+ * { wait: 500 }
49
+ * );
50
+ *
51
+ * // Opt-in to track isExecuting changes (optimized for loading states)
52
+ * const debouncer = injectAsyncDebouncer(
53
+ * async (query: string) => fetchSearchResults(query),
54
+ * { wait: 500 },
55
+ * (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending })
56
+ * );
57
+ *
58
+ * // In an event handler
59
+ * const handleChange = async (e: Event) => {
60
+ * const target = e.target as HTMLInputElement;
61
+ * const result = await debouncer.maybeExecute(target.value);
62
+ * console.log('Search results:', result);
63
+ * };
64
+ *
65
+ * // Access the selected state
66
+ * const { isExecuting, errorCount } = debouncer.state();
67
+ * ```
68
+ */
69
+ function injectAsyncDebouncer(fn, options, selector = () => ({})) {
70
+ const debouncer = new _tanstack_pacer_async_debouncer.AsyncDebouncer(fn, {
71
+ ...require_pacer_context.injectPacerOptions().asyncDebouncer,
72
+ ...options
73
+ });
74
+ const state = (0, _tanstack_angular_store.injectStore)(debouncer.store, selector);
75
+ return {
76
+ ...debouncer,
77
+ state
78
+ };
79
+ }
80
+
81
+ //#endregion
82
+ exports.injectAsyncDebouncer = injectAsyncDebouncer;
83
+ //# sourceMappingURL=injectAsyncDebouncer.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"injectAsyncDebouncer.cjs","names":["AsyncDebouncer","injectPacerOptions"],"sources":["../../src/async-debouncer/injectAsyncDebouncer.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n AsyncDebouncerOptions,\n AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\n\nexport interface AngularAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncDebouncer<TFn>, 'store'> {\n /**\n * Reactive state signal that will be updated when the async debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.\n * The state on the store object is not reactive in Angular signals.\n */\n readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages an AsyncDebouncer instance.\n *\n * This is a lower-level function that provides direct access to the AsyncDebouncer's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides async debouncing functionality with promise support, error handling,\n * retry capabilities, and abort support.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\n *\n * ## State Management and Selector\n *\n * The 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 debouncer can execute on the leading edge\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (either successfully or with errors)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const debouncer = injectAsyncDebouncer(\n * async (query: string) => {\n * const response = await fetch(`/api/search?q=${query}`);\n * return response.json();\n * },\n * { wait: 500 }\n * );\n *\n * // Opt-in to track isExecuting changes (optimized for loading states)\n * const debouncer = injectAsyncDebouncer(\n * async (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending })\n * );\n *\n * // In an event handler\n * const handleChange = async (e: Event) => {\n * const target = e.target as HTMLInputElement;\n * const result = await debouncer.maybeExecute(target.value);\n * console.log('Search results:', result);\n * };\n *\n * // Access the selected state\n * const { isExecuting, errorCount } = debouncer.state();\n * ```\n */\nexport function injectAsyncDebouncer<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n>(\n fn: TFn,\n options: AsyncDebouncerOptions<TFn>,\n selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): AngularAsyncDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().asyncDebouncer,\n ...options,\n } as AsyncDebouncerOptions<TFn>\n\n const debouncer = new AsyncDebouncer<TFn>(fn, mergedOptions)\n const state = injectStore(debouncer.store, selector)\n\n return {\n ...debouncer,\n state,\n } as AngularAsyncDebouncer<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2FA,SAAgB,qBAId,IACA,SACA,kBACG,EAAE,GACkC;CAMvC,MAAM,YAAY,IAAIA,+CAAoB,IALpB;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAE2D;CAC5D,MAAM,iDAAoB,UAAU,OAAO,SAAS;AAEpD,QAAO;EACL,GAAG;EACH;EACD"}
@@ -0,0 +1,86 @@
1
+ import { Signal } from "@angular/core";
2
+ import { Store } from "@tanstack/store";
3
+ import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
4
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
5
+
6
+ //#region src/async-debouncer/injectAsyncDebouncer.d.ts
7
+ interface AngularAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
+ /**
9
+ * Reactive state signal that will be updated when the async debouncer state changes
10
+ *
11
+ * Use this instead of `debouncer.store.state`
12
+ */
13
+ readonly state: Signal<Readonly<TSelected>>;
14
+ /**
15
+ * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
16
+ * The state on the store object is not reactive in Angular signals.
17
+ */
18
+ readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
19
+ }
20
+ /**
21
+ * An Angular function that creates and manages an AsyncDebouncer instance.
22
+ *
23
+ * This is a lower-level function that provides direct access to the AsyncDebouncer's functionality.
24
+ * This allows you to integrate it with any state management solution you prefer.
25
+ *
26
+ * This function provides async debouncing functionality with promise support, error handling,
27
+ * retry capabilities, and abort support.
28
+ *
29
+ * The debouncer will only execute the function after the specified wait time has elapsed
30
+ * since the last call. If the function is called again before the wait time expires, the
31
+ * timer resets and starts waiting again.
32
+ *
33
+ * ## State Management and Selector
34
+ *
35
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
36
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
37
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
38
+ *
39
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
40
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
41
+ * full control over when your component tracks state changes.
42
+ *
43
+ * Available state properties:
44
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
45
+ * - `errorCount`: Number of function executions that have resulted in errors
46
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
47
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
48
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
49
+ * - `lastResult`: The result from the most recent successful function execution
50
+ * - `settleCount`: Number of function executions that have completed (either successfully or with errors)
51
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
52
+ * - `successCount`: Number of function executions that have completed successfully
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * // Default behavior - no reactive state subscriptions
57
+ * const debouncer = injectAsyncDebouncer(
58
+ * async (query: string) => {
59
+ * const response = await fetch(`/api/search?q=${query}`);
60
+ * return response.json();
61
+ * },
62
+ * { wait: 500 }
63
+ * );
64
+ *
65
+ * // Opt-in to track isExecuting changes (optimized for loading states)
66
+ * const debouncer = injectAsyncDebouncer(
67
+ * async (query: string) => fetchSearchResults(query),
68
+ * { wait: 500 },
69
+ * (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending })
70
+ * );
71
+ *
72
+ * // In an event handler
73
+ * const handleChange = async (e: Event) => {
74
+ * const target = e.target as HTMLInputElement;
75
+ * const result = await debouncer.maybeExecute(target.value);
76
+ * console.log('Search results:', result);
77
+ * };
78
+ *
79
+ * // Access the selected state
80
+ * const { isExecuting, errorCount } = debouncer.state();
81
+ * ```
82
+ */
83
+ declare function injectAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): AngularAsyncDebouncer<TFn, TSelected>;
84
+ //#endregion
85
+ export { AngularAsyncDebouncer, injectAsyncDebouncer };
86
+ //# sourceMappingURL=injectAsyncDebouncer.d.cts.map
@@ -0,0 +1,86 @@
1
+ import { Signal } from "@angular/core";
2
+ import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
3
+ import { AnyAsyncFunction } from "@tanstack/pacer/types";
4
+ import { Store } from "@tanstack/store";
5
+
6
+ //#region src/async-debouncer/injectAsyncDebouncer.d.ts
7
+ interface AngularAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<TFn>, 'store'> {
8
+ /**
9
+ * Reactive state signal that will be updated when the async debouncer state changes
10
+ *
11
+ * Use this instead of `debouncer.store.state`
12
+ */
13
+ readonly state: Signal<Readonly<TSelected>>;
14
+ /**
15
+ * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
16
+ * The state on the store object is not reactive in Angular signals.
17
+ */
18
+ readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
19
+ }
20
+ /**
21
+ * An Angular function that creates and manages an AsyncDebouncer instance.
22
+ *
23
+ * This is a lower-level function that provides direct access to the AsyncDebouncer's functionality.
24
+ * This allows you to integrate it with any state management solution you prefer.
25
+ *
26
+ * This function provides async debouncing functionality with promise support, error handling,
27
+ * retry capabilities, and abort support.
28
+ *
29
+ * The debouncer will only execute the function after the specified wait time has elapsed
30
+ * since the last call. If the function is called again before the wait time expires, the
31
+ * timer resets and starts waiting again.
32
+ *
33
+ * ## State Management and Selector
34
+ *
35
+ * The function uses TanStack Store for state management and wraps it with Angular signals.
36
+ * The `selector` parameter allows you to specify which state changes will trigger signal updates,
37
+ * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
38
+ *
39
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
40
+ * tracking by providing a selector function. This prevents unnecessary updates and gives you
41
+ * full control over when your component tracks state changes.
42
+ *
43
+ * Available state properties:
44
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
45
+ * - `errorCount`: Number of function executions that have resulted in errors
46
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
47
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
48
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
49
+ * - `lastResult`: The result from the most recent successful function execution
50
+ * - `settleCount`: Number of function executions that have completed (either successfully or with errors)
51
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
52
+ * - `successCount`: Number of function executions that have completed successfully
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * // Default behavior - no reactive state subscriptions
57
+ * const debouncer = injectAsyncDebouncer(
58
+ * async (query: string) => {
59
+ * const response = await fetch(`/api/search?q=${query}`);
60
+ * return response.json();
61
+ * },
62
+ * { wait: 500 }
63
+ * );
64
+ *
65
+ * // Opt-in to track isExecuting changes (optimized for loading states)
66
+ * const debouncer = injectAsyncDebouncer(
67
+ * async (query: string) => fetchSearchResults(query),
68
+ * { wait: 500 },
69
+ * (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending })
70
+ * );
71
+ *
72
+ * // In an event handler
73
+ * const handleChange = async (e: Event) => {
74
+ * const target = e.target as HTMLInputElement;
75
+ * const result = await debouncer.maybeExecute(target.value);
76
+ * console.log('Search results:', result);
77
+ * };
78
+ *
79
+ * // Access the selected state
80
+ * const { isExecuting, errorCount } = debouncer.state();
81
+ * ```
82
+ */
83
+ declare function injectAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): AngularAsyncDebouncer<TFn, TSelected>;
84
+ //#endregion
85
+ export { AngularAsyncDebouncer, injectAsyncDebouncer };
86
+ //# sourceMappingURL=injectAsyncDebouncer.d.ts.map