@tanstack/solid-pacer 0.15.3 → 0.16.1

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 (320) hide show
  1. package/README.md +165 -0
  2. package/dist/async-batcher/createAsyncBatcher.cjs +122 -0
  3. package/dist/async-batcher/createAsyncBatcher.cjs.map +1 -0
  4. package/dist/{cjs/async-batcher → async-batcher}/createAsyncBatcher.d.cts +22 -17
  5. package/dist/{esm/async-batcher → async-batcher}/createAsyncBatcher.d.ts +22 -17
  6. package/dist/async-batcher/createAsyncBatcher.js +122 -0
  7. package/dist/async-batcher/createAsyncBatcher.js.map +1 -0
  8. package/dist/async-batcher/index.cjs +10 -0
  9. package/dist/async-batcher/index.d.cts +3 -0
  10. package/dist/async-batcher/index.d.ts +3 -0
  11. package/dist/async-batcher/index.js +5 -0
  12. package/dist/async-debouncer/createAsyncDebouncer.cjs +114 -0
  13. package/dist/async-debouncer/createAsyncDebouncer.cjs.map +1 -0
  14. package/dist/{cjs/async-debouncer → async-debouncer}/createAsyncDebouncer.d.cts +23 -18
  15. package/dist/{esm/async-debouncer → async-debouncer}/createAsyncDebouncer.d.ts +23 -18
  16. package/dist/async-debouncer/createAsyncDebouncer.js +114 -0
  17. package/dist/async-debouncer/createAsyncDebouncer.js.map +1 -0
  18. package/dist/async-debouncer/index.cjs +10 -0
  19. package/dist/async-debouncer/index.d.cts +3 -0
  20. package/dist/async-debouncer/index.d.ts +3 -0
  21. package/dist/async-debouncer/index.js +5 -0
  22. package/dist/async-queuer/createAsyncQueuer.cjs +114 -0
  23. package/dist/async-queuer/createAsyncQueuer.cjs.map +1 -0
  24. package/dist/{cjs/async-queuer → async-queuer}/createAsyncQueuer.d.cts +22 -17
  25. package/dist/{esm/async-queuer → async-queuer}/createAsyncQueuer.d.ts +22 -17
  26. package/dist/async-queuer/createAsyncQueuer.js +114 -0
  27. package/dist/async-queuer/createAsyncQueuer.js.map +1 -0
  28. package/dist/async-queuer/index.cjs +10 -0
  29. package/dist/async-queuer/index.d.cts +3 -0
  30. package/dist/async-queuer/index.d.ts +3 -0
  31. package/dist/async-queuer/index.js +5 -0
  32. package/dist/async-rate-limiter/createAsyncRateLimiter.cjs +120 -0
  33. package/dist/async-rate-limiter/createAsyncRateLimiter.cjs.map +1 -0
  34. package/dist/{cjs/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.cts +23 -18
  35. package/dist/{esm/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.ts +23 -18
  36. package/dist/async-rate-limiter/createAsyncRateLimiter.js +120 -0
  37. package/dist/async-rate-limiter/createAsyncRateLimiter.js.map +1 -0
  38. package/dist/async-rate-limiter/index.cjs +10 -0
  39. package/dist/async-rate-limiter/index.d.cts +3 -0
  40. package/dist/async-rate-limiter/index.d.ts +3 -0
  41. package/dist/async-rate-limiter/index.js +5 -0
  42. package/dist/async-throttler/createAsyncThrottler.cjs +108 -0
  43. package/dist/async-throttler/createAsyncThrottler.cjs.map +1 -0
  44. package/dist/{cjs/async-throttler → async-throttler}/createAsyncThrottler.d.cts +23 -18
  45. package/dist/{esm/async-throttler → async-throttler}/createAsyncThrottler.d.ts +23 -18
  46. package/dist/async-throttler/createAsyncThrottler.js +108 -0
  47. package/dist/async-throttler/createAsyncThrottler.js.map +1 -0
  48. package/dist/async-throttler/index.cjs +10 -0
  49. package/dist/async-throttler/index.d.cts +3 -0
  50. package/dist/async-throttler/index.d.ts +3 -0
  51. package/dist/async-throttler/index.js +5 -0
  52. package/dist/batcher/createBatcher.cjs +97 -0
  53. package/dist/batcher/createBatcher.cjs.map +1 -0
  54. package/dist/{cjs/batcher → batcher}/createBatcher.d.cts +22 -17
  55. package/dist/{esm/batcher → batcher}/createBatcher.d.ts +22 -17
  56. package/dist/batcher/createBatcher.js +97 -0
  57. package/dist/batcher/createBatcher.js.map +1 -0
  58. package/dist/batcher/index.cjs +10 -0
  59. package/dist/batcher/index.d.cts +3 -0
  60. package/dist/batcher/index.d.ts +3 -0
  61. package/dist/batcher/index.js +5 -0
  62. package/dist/debouncer/createDebouncedSignal.cjs +88 -0
  63. package/dist/debouncer/createDebouncedSignal.cjs.map +1 -0
  64. package/dist/{cjs/debouncer → debouncer}/createDebouncedSignal.d.cts +10 -8
  65. package/dist/{esm/debouncer → debouncer}/createDebouncedSignal.d.ts +10 -8
  66. package/dist/debouncer/createDebouncedSignal.js +88 -0
  67. package/dist/debouncer/createDebouncedSignal.js.map +1 -0
  68. package/dist/debouncer/createDebouncedValue.cjs +77 -0
  69. package/dist/debouncer/createDebouncedValue.cjs.map +1 -0
  70. package/dist/{cjs/debouncer → debouncer}/createDebouncedValue.d.cts +10 -4
  71. package/dist/{esm/debouncer → debouncer}/createDebouncedValue.d.ts +10 -4
  72. package/dist/debouncer/createDebouncedValue.js +77 -0
  73. package/dist/debouncer/createDebouncedValue.js.map +1 -0
  74. package/dist/debouncer/createDebouncer.cjs +101 -0
  75. package/dist/debouncer/createDebouncer.cjs.map +1 -0
  76. package/dist/{cjs/debouncer → debouncer}/createDebouncer.d.cts +23 -18
  77. package/dist/{esm/debouncer → debouncer}/createDebouncer.d.ts +23 -18
  78. package/dist/debouncer/createDebouncer.js +101 -0
  79. package/dist/debouncer/createDebouncer.js.map +1 -0
  80. package/dist/debouncer/index.cjs +14 -0
  81. package/dist/debouncer/index.d.cts +5 -0
  82. package/dist/debouncer/index.d.ts +5 -0
  83. package/dist/{esm/debouncer → debouncer}/index.js +5 -8
  84. package/dist/index.cjs +46 -0
  85. package/dist/index.d.cts +20 -0
  86. package/dist/index.d.ts +20 -0
  87. package/dist/{esm/index.js → index.js} +8 -22
  88. package/dist/provider/PacerProvider.cjs +27 -0
  89. package/dist/provider/PacerProvider.cjs.map +1 -0
  90. package/dist/provider/PacerProvider.d.cts +29 -0
  91. package/dist/provider/PacerProvider.d.ts +29 -0
  92. package/dist/provider/PacerProvider.js +25 -0
  93. package/dist/provider/PacerProvider.js.map +1 -0
  94. package/dist/provider/index.cjs +5 -0
  95. package/dist/provider/index.d.cts +2 -0
  96. package/dist/provider/index.d.ts +2 -0
  97. package/dist/provider/index.js +3 -0
  98. package/dist/queuer/createQueuedSignal.cjs +129 -0
  99. package/dist/queuer/createQueuedSignal.cjs.map +1 -0
  100. package/dist/queuer/createQueuedSignal.d.cts +123 -0
  101. package/dist/queuer/createQueuedSignal.d.ts +123 -0
  102. package/dist/queuer/createQueuedSignal.js +129 -0
  103. package/dist/queuer/createQueuedSignal.js.map +1 -0
  104. package/dist/queuer/createQueuer.cjs +98 -0
  105. package/dist/queuer/createQueuer.cjs.map +1 -0
  106. package/dist/{cjs/queuer → queuer}/createQueuer.d.cts +22 -17
  107. package/dist/{esm/queuer → queuer}/createQueuer.d.ts +22 -17
  108. package/dist/queuer/createQueuer.js +98 -0
  109. package/dist/queuer/createQueuer.js.map +1 -0
  110. package/dist/queuer/index.cjs +12 -0
  111. package/dist/queuer/index.d.cts +4 -0
  112. package/dist/queuer/index.d.ts +4 -0
  113. package/dist/queuer/index.js +6 -0
  114. package/dist/rate-limiter/createRateLimitedSignal.cjs +102 -0
  115. package/dist/rate-limiter/createRateLimitedSignal.cjs.map +1 -0
  116. package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimitedSignal.d.cts +10 -8
  117. package/dist/{esm/rate-limiter → rate-limiter}/createRateLimitedSignal.d.ts +10 -8
  118. package/dist/rate-limiter/createRateLimitedSignal.js +102 -0
  119. package/dist/rate-limiter/createRateLimitedSignal.js.map +1 -0
  120. package/dist/rate-limiter/createRateLimitedValue.cjs +102 -0
  121. package/dist/rate-limiter/createRateLimitedValue.cjs.map +1 -0
  122. package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimitedValue.d.cts +40 -20
  123. package/dist/{esm/rate-limiter → rate-limiter}/createRateLimitedValue.d.ts +40 -20
  124. package/dist/rate-limiter/createRateLimitedValue.js +102 -0
  125. package/dist/rate-limiter/createRateLimitedValue.js.map +1 -0
  126. package/dist/rate-limiter/createRateLimiter.cjs +95 -0
  127. package/dist/rate-limiter/createRateLimiter.cjs.map +1 -0
  128. package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimiter.d.cts +23 -18
  129. package/dist/{esm/rate-limiter → rate-limiter}/createRateLimiter.d.ts +23 -18
  130. package/dist/rate-limiter/createRateLimiter.js +95 -0
  131. package/dist/rate-limiter/createRateLimiter.js.map +1 -0
  132. package/dist/rate-limiter/index.cjs +14 -0
  133. package/dist/rate-limiter/index.d.cts +5 -0
  134. package/dist/rate-limiter/index.d.ts +5 -0
  135. package/dist/{esm/rate-limiter → rate-limiter}/index.js +4 -7
  136. package/dist/throttler/createThrottledSignal.cjs +79 -0
  137. package/dist/throttler/createThrottledSignal.cjs.map +1 -0
  138. package/dist/{cjs/throttler → throttler}/createThrottledSignal.d.cts +10 -8
  139. package/dist/{esm/throttler → throttler}/createThrottledSignal.d.ts +10 -8
  140. package/dist/throttler/createThrottledSignal.js +79 -0
  141. package/dist/throttler/createThrottledSignal.js.map +1 -0
  142. package/dist/throttler/createThrottledValue.cjs +74 -0
  143. package/dist/throttler/createThrottledValue.cjs.map +1 -0
  144. package/dist/{cjs/throttler → throttler}/createThrottledValue.d.cts +10 -4
  145. package/dist/{esm/throttler → throttler}/createThrottledValue.d.ts +10 -4
  146. package/dist/throttler/createThrottledValue.js +74 -0
  147. package/dist/throttler/createThrottledValue.js.map +1 -0
  148. package/dist/throttler/createThrottler.cjs +97 -0
  149. package/dist/throttler/createThrottler.cjs.map +1 -0
  150. package/dist/{cjs/throttler → throttler}/createThrottler.d.cts +23 -18
  151. package/dist/{esm/throttler → throttler}/createThrottler.d.ts +23 -18
  152. package/dist/throttler/createThrottler.js +97 -0
  153. package/dist/throttler/createThrottler.js.map +1 -0
  154. package/dist/throttler/index.cjs +14 -0
  155. package/dist/throttler/index.d.cts +5 -0
  156. package/dist/throttler/index.d.ts +5 -0
  157. package/dist/{esm/throttler → throttler}/index.js +5 -8
  158. package/dist/types/index.cjs +9 -0
  159. package/dist/types/index.d.cts +1 -0
  160. package/dist/types/index.d.ts +1 -0
  161. package/dist/types/index.js +3 -0
  162. package/dist/utils/index.cjs +9 -0
  163. package/dist/utils/index.d.cts +1 -0
  164. package/dist/utils/index.d.ts +1 -0
  165. package/dist/utils/index.js +3 -0
  166. package/package.json +37 -106
  167. package/src/async-batcher/createAsyncBatcher.ts +12 -4
  168. package/src/async-debouncer/createAsyncDebouncer.ts +8 -2
  169. package/src/async-queuer/createAsyncQueuer.ts +12 -4
  170. package/src/async-rate-limiter/createAsyncRateLimiter.ts +8 -2
  171. package/src/async-throttler/createAsyncThrottler.ts +8 -2
  172. package/src/batcher/createBatcher.ts +12 -4
  173. package/src/debouncer/createDebouncer.ts +12 -4
  174. package/src/index.ts +4 -0
  175. package/src/provider/PacerProvider.tsx +63 -0
  176. package/src/provider/index.ts +1 -0
  177. package/src/queuer/createQueuedSignal.ts +138 -0
  178. package/src/queuer/createQueuer.ts +12 -4
  179. package/src/queuer/index.ts +1 -0
  180. package/src/rate-limiter/createRateLimitedValue.ts +30 -16
  181. package/src/rate-limiter/createRateLimiter.ts +12 -4
  182. package/src/throttler/createThrottler.ts +12 -4
  183. package/dist/cjs/async-batcher/createAsyncBatcher.cjs +0 -14
  184. package/dist/cjs/async-batcher/createAsyncBatcher.cjs.map +0 -1
  185. package/dist/cjs/async-batcher/index.cjs +0 -12
  186. package/dist/cjs/async-batcher/index.cjs.map +0 -1
  187. package/dist/cjs/async-batcher/index.d.cts +0 -2
  188. package/dist/cjs/async-debouncer/createAsyncDebouncer.cjs +0 -20
  189. package/dist/cjs/async-debouncer/createAsyncDebouncer.cjs.map +0 -1
  190. package/dist/cjs/async-debouncer/index.cjs +0 -12
  191. package/dist/cjs/async-debouncer/index.cjs.map +0 -1
  192. package/dist/cjs/async-debouncer/index.d.cts +0 -2
  193. package/dist/cjs/async-queuer/createAsyncQueuer.cjs +0 -14
  194. package/dist/cjs/async-queuer/createAsyncQueuer.cjs.map +0 -1
  195. package/dist/cjs/async-queuer/index.cjs +0 -12
  196. package/dist/cjs/async-queuer/index.cjs.map +0 -1
  197. package/dist/cjs/async-queuer/index.d.cts +0 -2
  198. package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.cjs +0 -14
  199. package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.cjs.map +0 -1
  200. package/dist/cjs/async-rate-limiter/index.cjs +0 -12
  201. package/dist/cjs/async-rate-limiter/index.cjs.map +0 -1
  202. package/dist/cjs/async-rate-limiter/index.d.cts +0 -2
  203. package/dist/cjs/async-throttler/createAsyncThrottler.cjs +0 -14
  204. package/dist/cjs/async-throttler/createAsyncThrottler.cjs.map +0 -1
  205. package/dist/cjs/async-throttler/index.cjs +0 -12
  206. package/dist/cjs/async-throttler/index.cjs.map +0 -1
  207. package/dist/cjs/async-throttler/index.d.cts +0 -2
  208. package/dist/cjs/batcher/createBatcher.cjs +0 -14
  209. package/dist/cjs/batcher/createBatcher.cjs.map +0 -1
  210. package/dist/cjs/batcher/index.cjs +0 -12
  211. package/dist/cjs/batcher/index.cjs.map +0 -1
  212. package/dist/cjs/batcher/index.d.cts +0 -2
  213. package/dist/cjs/debouncer/createDebouncedSignal.cjs +0 -11
  214. package/dist/cjs/debouncer/createDebouncedSignal.cjs.map +0 -1
  215. package/dist/cjs/debouncer/createDebouncedValue.cjs +0 -17
  216. package/dist/cjs/debouncer/createDebouncedValue.cjs.map +0 -1
  217. package/dist/cjs/debouncer/createDebouncer.cjs +0 -20
  218. package/dist/cjs/debouncer/createDebouncer.cjs.map +0 -1
  219. package/dist/cjs/debouncer/index.cjs +0 -16
  220. package/dist/cjs/debouncer/index.cjs.map +0 -1
  221. package/dist/cjs/debouncer/index.d.cts +0 -4
  222. package/dist/cjs/index.cjs +0 -42
  223. package/dist/cjs/index.cjs.map +0 -1
  224. package/dist/cjs/index.d.cts +0 -20
  225. package/dist/cjs/queuer/createQueuer.cjs +0 -14
  226. package/dist/cjs/queuer/createQueuer.cjs.map +0 -1
  227. package/dist/cjs/queuer/index.cjs +0 -12
  228. package/dist/cjs/queuer/index.cjs.map +0 -1
  229. package/dist/cjs/queuer/index.d.cts +0 -2
  230. package/dist/cjs/rate-limiter/createRateLimitedSignal.cjs +0 -19
  231. package/dist/cjs/rate-limiter/createRateLimitedSignal.cjs.map +0 -1
  232. package/dist/cjs/rate-limiter/createRateLimitedValue.cjs +0 -13
  233. package/dist/cjs/rate-limiter/createRateLimitedValue.cjs.map +0 -1
  234. package/dist/cjs/rate-limiter/createRateLimiter.cjs +0 -14
  235. package/dist/cjs/rate-limiter/createRateLimiter.cjs.map +0 -1
  236. package/dist/cjs/rate-limiter/index.cjs +0 -16
  237. package/dist/cjs/rate-limiter/index.cjs.map +0 -1
  238. package/dist/cjs/rate-limiter/index.d.cts +0 -4
  239. package/dist/cjs/throttler/createThrottledSignal.cjs +0 -11
  240. package/dist/cjs/throttler/createThrottledSignal.cjs.map +0 -1
  241. package/dist/cjs/throttler/createThrottledValue.cjs +0 -17
  242. package/dist/cjs/throttler/createThrottledValue.cjs.map +0 -1
  243. package/dist/cjs/throttler/createThrottler.cjs +0 -20
  244. package/dist/cjs/throttler/createThrottler.cjs.map +0 -1
  245. package/dist/cjs/throttler/index.cjs +0 -16
  246. package/dist/cjs/throttler/index.cjs.map +0 -1
  247. package/dist/cjs/throttler/index.d.cts +0 -4
  248. package/dist/cjs/types/index.cjs +0 -10
  249. package/dist/cjs/types/index.cjs.map +0 -1
  250. package/dist/cjs/types/index.d.cts +0 -1
  251. package/dist/cjs/utils/index.cjs +0 -10
  252. package/dist/cjs/utils/index.cjs.map +0 -1
  253. package/dist/cjs/utils/index.d.cts +0 -1
  254. package/dist/esm/async-batcher/createAsyncBatcher.js +0 -14
  255. package/dist/esm/async-batcher/createAsyncBatcher.js.map +0 -1
  256. package/dist/esm/async-batcher/index.d.ts +0 -2
  257. package/dist/esm/async-batcher/index.js +0 -6
  258. package/dist/esm/async-batcher/index.js.map +0 -1
  259. package/dist/esm/async-debouncer/createAsyncDebouncer.js +0 -20
  260. package/dist/esm/async-debouncer/createAsyncDebouncer.js.map +0 -1
  261. package/dist/esm/async-debouncer/index.d.ts +0 -2
  262. package/dist/esm/async-debouncer/index.js +0 -6
  263. package/dist/esm/async-debouncer/index.js.map +0 -1
  264. package/dist/esm/async-queuer/createAsyncQueuer.js +0 -14
  265. package/dist/esm/async-queuer/createAsyncQueuer.js.map +0 -1
  266. package/dist/esm/async-queuer/index.d.ts +0 -2
  267. package/dist/esm/async-queuer/index.js +0 -6
  268. package/dist/esm/async-queuer/index.js.map +0 -1
  269. package/dist/esm/async-rate-limiter/createAsyncRateLimiter.js +0 -14
  270. package/dist/esm/async-rate-limiter/createAsyncRateLimiter.js.map +0 -1
  271. package/dist/esm/async-rate-limiter/index.d.ts +0 -2
  272. package/dist/esm/async-rate-limiter/index.js +0 -6
  273. package/dist/esm/async-rate-limiter/index.js.map +0 -1
  274. package/dist/esm/async-throttler/createAsyncThrottler.js +0 -14
  275. package/dist/esm/async-throttler/createAsyncThrottler.js.map +0 -1
  276. package/dist/esm/async-throttler/index.d.ts +0 -2
  277. package/dist/esm/async-throttler/index.js +0 -6
  278. package/dist/esm/async-throttler/index.js.map +0 -1
  279. package/dist/esm/batcher/createBatcher.js +0 -14
  280. package/dist/esm/batcher/createBatcher.js.map +0 -1
  281. package/dist/esm/batcher/index.d.ts +0 -2
  282. package/dist/esm/batcher/index.js +0 -6
  283. package/dist/esm/batcher/index.js.map +0 -1
  284. package/dist/esm/debouncer/createDebouncedSignal.js +0 -11
  285. package/dist/esm/debouncer/createDebouncedSignal.js.map +0 -1
  286. package/dist/esm/debouncer/createDebouncedValue.js +0 -17
  287. package/dist/esm/debouncer/createDebouncedValue.js.map +0 -1
  288. package/dist/esm/debouncer/createDebouncer.js +0 -20
  289. package/dist/esm/debouncer/createDebouncer.js.map +0 -1
  290. package/dist/esm/debouncer/index.d.ts +0 -4
  291. package/dist/esm/debouncer/index.js.map +0 -1
  292. package/dist/esm/index.d.ts +0 -20
  293. package/dist/esm/index.js.map +0 -1
  294. package/dist/esm/queuer/createQueuer.js +0 -14
  295. package/dist/esm/queuer/createQueuer.js.map +0 -1
  296. package/dist/esm/queuer/index.d.ts +0 -2
  297. package/dist/esm/queuer/index.js +0 -6
  298. package/dist/esm/queuer/index.js.map +0 -1
  299. package/dist/esm/rate-limiter/createRateLimitedSignal.js +0 -19
  300. package/dist/esm/rate-limiter/createRateLimitedSignal.js.map +0 -1
  301. package/dist/esm/rate-limiter/createRateLimitedValue.js +0 -13
  302. package/dist/esm/rate-limiter/createRateLimitedValue.js.map +0 -1
  303. package/dist/esm/rate-limiter/createRateLimiter.js +0 -14
  304. package/dist/esm/rate-limiter/createRateLimiter.js.map +0 -1
  305. package/dist/esm/rate-limiter/index.d.ts +0 -4
  306. package/dist/esm/rate-limiter/index.js.map +0 -1
  307. package/dist/esm/throttler/createThrottledSignal.js +0 -11
  308. package/dist/esm/throttler/createThrottledSignal.js.map +0 -1
  309. package/dist/esm/throttler/createThrottledValue.js +0 -17
  310. package/dist/esm/throttler/createThrottledValue.js.map +0 -1
  311. package/dist/esm/throttler/createThrottler.js +0 -20
  312. package/dist/esm/throttler/createThrottler.js.map +0 -1
  313. package/dist/esm/throttler/index.d.ts +0 -4
  314. package/dist/esm/throttler/index.js.map +0 -1
  315. package/dist/esm/types/index.d.ts +0 -1
  316. package/dist/esm/types/index.js +0 -2
  317. package/dist/esm/types/index.js.map +0 -1
  318. package/dist/esm/utils/index.d.ts +0 -1
  319. package/dist/esm/utils/index.js +0 -2
  320. package/dist/esm/utils/index.js.map +0 -1
@@ -0,0 +1,95 @@
1
+ import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
2
+ import { useStore } from "@tanstack/solid-store";
3
+ import { RateLimiter } from "@tanstack/pacer/rate-limiter";
4
+
5
+ //#region src/rate-limiter/createRateLimiter.ts
6
+ /**
7
+ * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
8
+ *
9
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
10
+ * you can integrate with any state management solution (createSignal, etc).
11
+ *
12
+ * Rate limiting is a simple "hard limit" approach that allows executions until a maximum count is reached within
13
+ * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
14
+ * it does not attempt to space out or collapse executions intelligently.
15
+ *
16
+ * The rate limiter supports two types of windows:
17
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
18
+ * towards the limit, and the window resets completely after the period.
19
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
20
+ * consistent rate of execution over time.
21
+ *
22
+ * For smoother execution patterns:
23
+ * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
24
+ * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
25
+ * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
26
+ *
27
+ * ## State Management and Selector
28
+ *
29
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
30
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
31
+ * unnecessary re-renders when irrelevant state changes occur.
32
+ *
33
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
34
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
35
+ * full control over when your component updates. Only when you provide a selector will the
36
+ * component re-render when the selected state values change.
37
+ *
38
+ * Available state properties:
39
+ * - `executionCount`: Number of function executions that have been completed
40
+ * - `rejectionCount`: Number of function calls that were rejected due to rate limiting
41
+ * - `remainingInWindow`: Number of executions remaining in the current window
42
+ * - `nextWindowTime`: Timestamp when the next window begins
43
+ * - `currentWindowStart`: Timestamp when the current window started
44
+ *
45
+ * @example
46
+ * ```tsx
47
+ * // Default behavior - no reactive state subscriptions
48
+ * const rateLimiter = createRateLimiter(apiCall, {
49
+ * limit: 5,
50
+ * window: 60000,
51
+ * windowType: 'sliding',
52
+ * onReject: (rateLimiter) => {
53
+ * console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
54
+ * }
55
+ * });
56
+ *
57
+ * // Opt-in to re-render when rate limit state changes (optimized for UI feedback)
58
+ * const rateLimiter = createRateLimiter(
59
+ * apiCall,
60
+ * { limit: 5, window: 60000 },
61
+ * (state) => ({
62
+ * remainingInWindow: state.remainingInWindow,
63
+ * rejectionCount: state.rejectionCount
64
+ * })
65
+ * );
66
+ *
67
+ * // Opt-in to re-render when execution metrics change (optimized for tracking progress)
68
+ * const rateLimiter = createRateLimiter(
69
+ * apiCall,
70
+ * { limit: 5, window: 60000 },
71
+ * (state) => ({
72
+ * executionCount: state.executionCount,
73
+ * nextWindowTime: state.nextWindowTime
74
+ * })
75
+ * );
76
+ *
77
+ * // Access the selected state (will be empty object {} unless selector provided)
78
+ * const { remainingInWindow, rejectionCount } = rateLimiter.state();
79
+ * ```
80
+ */
81
+ function createRateLimiter(fn, options, selector = () => ({})) {
82
+ const rateLimiter = new RateLimiter(fn, {
83
+ ...useDefaultPacerOptions().rateLimiter,
84
+ ...options
85
+ });
86
+ const state = useStore(rateLimiter.store, selector);
87
+ return {
88
+ ...rateLimiter,
89
+ state
90
+ };
91
+ }
92
+
93
+ //#endregion
94
+ export { createRateLimiter };
95
+ //# sourceMappingURL=createRateLimiter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createRateLimiter.js","names":[],"sources":["../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\n /**\n * Reactive state that will be updated when the rate limiter state changes\n *\n * Use this instead of `rateLimiter.store.state`\n */\n readonly state: Accessor<Readonly<TSelected>>\n /**\n * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` in your own usage.\n */\n readonly store: Store<Readonly<RateLimiterState>>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n * towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n * consistent rate of execution over time.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `rejectionCount`: Number of function calls that were rejected due to rate limiting\n * - `remainingInWindow`: Number of executions remaining in the current window\n * - `nextWindowTime`: Timestamp when the next window begins\n * - `currentWindowStart`: Timestamp when the current window started\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = createRateLimiter(apiCall, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding',\n * onReject: (rateLimiter) => {\n * console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n * }\n * });\n *\n * // Opt-in to re-render when rate limit state changes (optimized for UI feedback)\n * const rateLimiter = createRateLimiter(\n * apiCall,\n * { limit: 5, window: 60000 },\n * (state) => ({\n * remainingInWindow: state.remainingInWindow,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for tracking progress)\n * const rateLimiter = createRateLimiter(\n * apiCall,\n * { limit: 5, window: 60000 },\n * (state) => ({\n * executionCount: state.executionCount,\n * nextWindowTime: state.nextWindowTime\n * })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { remainingInWindow, rejectionCount } = rateLimiter.state();\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: RateLimiterOptions<TFn>,\n selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): SolidRateLimiter<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().rateLimiter,\n ...options,\n } as RateLimiterOptions<TFn>\n\n const rateLimiter = new RateLimiter<TFn>(fn, mergedOptions)\n\n const state = useStore(rateLimiter.store, selector)\n\n return {\n ...rateLimiter,\n state,\n } as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwGA,SAAgB,kBACd,IACA,SACA,kBAA0D,EAAE,GAC1B;CAMlC,MAAM,cAAc,IAAI,YAAiB,IALnB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAE0D;CAE3D,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO;EACL,GAAG;EACH;EACD"}
@@ -0,0 +1,14 @@
1
+ const require_createRateLimiter = require('./createRateLimiter.cjs');
2
+ const require_createRateLimitedSignal = require('./createRateLimitedSignal.cjs');
3
+ const require_createRateLimitedValue = require('./createRateLimitedValue.cjs');
4
+
5
+ exports.createRateLimitedSignal = require_createRateLimitedSignal.createRateLimitedSignal;
6
+ exports.createRateLimitedValue = require_createRateLimitedValue.createRateLimitedValue;
7
+ exports.createRateLimiter = require_createRateLimiter.createRateLimiter;
8
+ var __tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
9
+ Object.keys(__tanstack_pacer_rate_limiter).forEach(function (k) {
10
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
11
+ enumerable: true,
12
+ get: function () { return __tanstack_pacer_rate_limiter[k]; }
13
+ });
14
+ });
@@ -0,0 +1,5 @@
1
+ import { SolidRateLimiter, createRateLimiter } from "./createRateLimiter.cjs";
2
+ import { createRateLimitedSignal } from "./createRateLimitedSignal.cjs";
3
+ import { createRateLimitedValue } from "./createRateLimitedValue.cjs";
4
+ export * from "@tanstack/pacer/rate-limiter";
5
+ export { SolidRateLimiter, createRateLimitedSignal, createRateLimitedValue, createRateLimiter };
@@ -0,0 +1,5 @@
1
+ import { SolidRateLimiter, createRateLimiter } from "./createRateLimiter.js";
2
+ import { createRateLimitedSignal } from "./createRateLimitedSignal.js";
3
+ import { createRateLimitedValue } from "./createRateLimitedValue.js";
4
+ export * from "@tanstack/pacer/rate-limiter";
5
+ export { SolidRateLimiter, createRateLimitedSignal, createRateLimitedValue, createRateLimiter };
@@ -1,10 +1,7 @@
1
- export * from "@tanstack/pacer/rate-limiter";
2
1
  import { createRateLimiter } from "./createRateLimiter.js";
3
2
  import { createRateLimitedSignal } from "./createRateLimitedSignal.js";
4
3
  import { createRateLimitedValue } from "./createRateLimitedValue.js";
5
- export {
6
- createRateLimitedSignal,
7
- createRateLimitedValue,
8
- createRateLimiter
9
- };
10
- //# sourceMappingURL=index.js.map
4
+
5
+ export * from "@tanstack/pacer/rate-limiter"
6
+
7
+ export { createRateLimitedSignal, createRateLimitedValue, createRateLimiter };
@@ -0,0 +1,79 @@
1
+ const require_createThrottler = require('./createThrottler.cjs');
2
+ let solid_js = require("solid-js");
3
+
4
+ //#region src/throttler/createThrottledSignal.ts
5
+ /**
6
+ * A Solid hook that creates a throttled state value that updates at most once within a specified time window.
7
+ * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.
8
+ *
9
+ * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.
10
+ * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.
11
+ *
12
+ * The hook returns a tuple containing:
13
+ * - The throttled state value accessor
14
+ * - A throttled setter function that respects the configured wait time
15
+ * - The throttler instance for additional control
16
+ *
17
+ * For more direct control over throttling without state management,
18
+ * consider using the lower-level createThrottler hook instead.
19
+ *
20
+ * ## State Management and Selector
21
+ *
22
+ * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
23
+ * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,
24
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
25
+ *
26
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
27
+ * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you
28
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
29
+ * the reactive system track the selected state values.
30
+ *
31
+ * Available throttler state properties:
32
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
33
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
34
+ * - `executionCount`: Number of function executions that have been completed
35
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
36
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
37
+ * - `lastExecutionTime`: Unix timestamp of the last execution
38
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
39
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
40
+ *
41
+ * @example
42
+ * ```tsx
43
+ * // Default behavior - no reactive state subscriptions
44
+ * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });
45
+ *
46
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
47
+ * const [value, setValue, throttler] = createThrottledSignal(
48
+ * 0,
49
+ * { wait: 1000 },
50
+ * (state) => ({ isPending: state.isPending })
51
+ * );
52
+ *
53
+ * // With custom leading/trailing behavior
54
+ * const [value, setValue] = createThrottledSignal(0, {
55
+ * wait: 1000,
56
+ * leading: true, // Update immediately on first change
57
+ * trailing: false // Skip trailing edge updates
58
+ * });
59
+ *
60
+ * // Access throttler state via signals
61
+ * console.log('Executions:', throttler.state().executionCount);
62
+ * console.log('Is pending:', throttler.state().isPending);
63
+ * console.log('Last execution:', throttler.state().lastExecutionTime);
64
+ * console.log('Next execution:', throttler.state().nextExecutionTime);
65
+ * ```
66
+ */
67
+ function createThrottledSignal(value, initialOptions, selector) {
68
+ const [throttledValue, setThrottledValue] = (0, solid_js.createSignal)(value);
69
+ const throttler = require_createThrottler.createThrottler(setThrottledValue, initialOptions, selector);
70
+ return [
71
+ throttledValue,
72
+ throttler.maybeExecute,
73
+ throttler
74
+ ];
75
+ }
76
+
77
+ //#endregion
78
+ exports.createThrottledSignal = createThrottledSignal;
79
+ //# sourceMappingURL=createThrottledSignal.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createThrottledSignal.cjs","names":["createThrottler"],"sources":["../../src/throttler/createThrottledSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createThrottler } from './createThrottler'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\n/**\n * A Solid hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value accessor\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Unix timestamp of the last execution\n * - `nextExecutionTime`: Unix timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });\n *\n * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)\n * const [value, setValue, throttler] = createThrottledSignal(\n * 0,\n * { wait: 1000 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = createThrottledSignal(0, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access throttler state via signals\n * console.log('Executions:', throttler.state().executionCount);\n * console.log('Is pending:', throttler.state().isPending);\n * console.log('Last execution:', throttler.state().lastExecutionTime);\n * console.log('Next execution:', throttler.state().nextExecutionTime);\n * ```\n */\nexport function createThrottledSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [\n Accessor<TValue>,\n Setter<TValue>,\n SolidThrottler<Setter<TValue>, TSelected>,\n] {\n const [throttledValue, setThrottledValue] = createSignal<TValue>(value)\n const throttler = createThrottler(setThrottledValue, initialOptions, selector)\n return [throttledValue, throttler.maybeExecute as Setter<TValue>, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,SAAgB,sBACd,OACA,gBACA,UAKA;CACA,MAAM,CAAC,gBAAgB,gDAA0C,MAAM;CACvE,MAAM,YAAYA,wCAAgB,mBAAmB,gBAAgB,SAAS;AAC9E,QAAO;EAAC;EAAgB,UAAU;EAAgC;EAAU"}
@@ -1,6 +1,9 @@
1
- import { SolidThrottler } from './createThrottler.cjs';
2
- import { Accessor, Setter } from 'solid-js';
3
- import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
1
+ import { SolidThrottler } from "./createThrottler.cjs";
2
+ import { Accessor, Setter } from "solid-js";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/createThrottledSignal.d.ts
6
+
4
7
  /**
5
8
  * A Solid hook that creates a throttled state value that updates at most once within a specified time window.
6
9
  * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.
@@ -63,8 +66,7 @@ import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
63
66
  * console.log('Next execution:', throttler.state().nextExecutionTime);
64
67
  * ```
65
68
  */
66
- export declare function createThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [
67
- Accessor<TValue>,
68
- Setter<TValue>,
69
- SolidThrottler<Setter<TValue>, TSelected>
70
- ];
69
+ declare function createThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, Setter<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
70
+ //#endregion
71
+ export { createThrottledSignal };
72
+ //# sourceMappingURL=createThrottledSignal.d.cts.map
@@ -1,6 +1,9 @@
1
- import { SolidThrottler } from './createThrottler.js';
2
- import { Accessor, Setter } from 'solid-js';
3
- import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
1
+ import { SolidThrottler } from "./createThrottler.js";
2
+ import { Accessor, Setter } from "solid-js";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/createThrottledSignal.d.ts
6
+
4
7
  /**
5
8
  * A Solid hook that creates a throttled state value that updates at most once within a specified time window.
6
9
  * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.
@@ -63,8 +66,7 @@ import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
63
66
  * console.log('Next execution:', throttler.state().nextExecutionTime);
64
67
  * ```
65
68
  */
66
- export declare function createThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [
67
- Accessor<TValue>,
68
- Setter<TValue>,
69
- SolidThrottler<Setter<TValue>, TSelected>
70
- ];
69
+ declare function createThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, Setter<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
70
+ //#endregion
71
+ export { createThrottledSignal };
72
+ //# sourceMappingURL=createThrottledSignal.d.ts.map
@@ -0,0 +1,79 @@
1
+ import { createThrottler } from "./createThrottler.js";
2
+ import { createSignal } from "solid-js";
3
+
4
+ //#region src/throttler/createThrottledSignal.ts
5
+ /**
6
+ * A Solid hook that creates a throttled state value that updates at most once within a specified time window.
7
+ * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.
8
+ *
9
+ * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.
10
+ * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.
11
+ *
12
+ * The hook returns a tuple containing:
13
+ * - The throttled state value accessor
14
+ * - A throttled setter function that respects the configured wait time
15
+ * - The throttler instance for additional control
16
+ *
17
+ * For more direct control over throttling without state management,
18
+ * consider using the lower-level createThrottler hook instead.
19
+ *
20
+ * ## State Management and Selector
21
+ *
22
+ * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
23
+ * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,
24
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
25
+ *
26
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
27
+ * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you
28
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
29
+ * the reactive system track the selected state values.
30
+ *
31
+ * Available throttler state properties:
32
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
33
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
34
+ * - `executionCount`: Number of function executions that have been completed
35
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
36
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
37
+ * - `lastExecutionTime`: Unix timestamp of the last execution
38
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
39
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
40
+ *
41
+ * @example
42
+ * ```tsx
43
+ * // Default behavior - no reactive state subscriptions
44
+ * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });
45
+ *
46
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
47
+ * const [value, setValue, throttler] = createThrottledSignal(
48
+ * 0,
49
+ * { wait: 1000 },
50
+ * (state) => ({ isPending: state.isPending })
51
+ * );
52
+ *
53
+ * // With custom leading/trailing behavior
54
+ * const [value, setValue] = createThrottledSignal(0, {
55
+ * wait: 1000,
56
+ * leading: true, // Update immediately on first change
57
+ * trailing: false // Skip trailing edge updates
58
+ * });
59
+ *
60
+ * // Access throttler state via signals
61
+ * console.log('Executions:', throttler.state().executionCount);
62
+ * console.log('Is pending:', throttler.state().isPending);
63
+ * console.log('Last execution:', throttler.state().lastExecutionTime);
64
+ * console.log('Next execution:', throttler.state().nextExecutionTime);
65
+ * ```
66
+ */
67
+ function createThrottledSignal(value, initialOptions, selector) {
68
+ const [throttledValue, setThrottledValue] = createSignal(value);
69
+ const throttler = createThrottler(setThrottledValue, initialOptions, selector);
70
+ return [
71
+ throttledValue,
72
+ throttler.maybeExecute,
73
+ throttler
74
+ ];
75
+ }
76
+
77
+ //#endregion
78
+ export { createThrottledSignal };
79
+ //# sourceMappingURL=createThrottledSignal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createThrottledSignal.js","names":[],"sources":["../../src/throttler/createThrottledSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createThrottler } from './createThrottler'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\n/**\n * A Solid hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value accessor\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Unix timestamp of the last execution\n * - `nextExecutionTime`: Unix timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });\n *\n * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)\n * const [value, setValue, throttler] = createThrottledSignal(\n * 0,\n * { wait: 1000 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = createThrottledSignal(0, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access throttler state via signals\n * console.log('Executions:', throttler.state().executionCount);\n * console.log('Is pending:', throttler.state().isPending);\n * console.log('Last execution:', throttler.state().lastExecutionTime);\n * console.log('Next execution:', throttler.state().nextExecutionTime);\n * ```\n */\nexport function createThrottledSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [\n Accessor<TValue>,\n Setter<TValue>,\n SolidThrottler<Setter<TValue>, TSelected>,\n] {\n const [throttledValue, setThrottledValue] = createSignal<TValue>(value)\n const throttler = createThrottler(setThrottledValue, initialOptions, selector)\n return [throttledValue, throttler.maybeExecute as Setter<TValue>, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,SAAgB,sBACd,OACA,gBACA,UAKA;CACA,MAAM,CAAC,gBAAgB,qBAAqB,aAAqB,MAAM;CACvE,MAAM,YAAY,gBAAgB,mBAAmB,gBAAgB,SAAS;AAC9E,QAAO;EAAC;EAAgB,UAAU;EAAgC;EAAU"}
@@ -0,0 +1,74 @@
1
+ const require_createThrottledSignal = require('./createThrottledSignal.cjs');
2
+ let solid_js = require("solid-js");
3
+
4
+ //#region src/throttler/createThrottledValue.ts
5
+ /**
6
+ * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.
7
+ * This hook uses Solid's createSignal internally to manage the throttled state.
8
+ *
9
+ * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
10
+ * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
11
+ *
12
+ * The hook returns a tuple containing:
13
+ * - An accessor function that provides the throttled value
14
+ * - The throttler instance with control methods
15
+ *
16
+ * The throttled value will update according to the leading/trailing edge behavior specified in the options.
17
+ *
18
+ * For more direct control over throttling behavior without Solid state management,
19
+ * consider using the lower-level createThrottler hook instead.
20
+ *
21
+ * ## State Management and Selector
22
+ *
23
+ * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
24
+ * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,
25
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
26
+ *
27
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
28
+ * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you
29
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
30
+ * the reactive system track the selected state values.
31
+ *
32
+ * Available throttler state properties:
33
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
34
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
35
+ * - `executionCount`: Number of function executions that have been completed
36
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
37
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
38
+ * - `lastExecutionTime`: Unix timestamp of the last execution
39
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
40
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
41
+ *
42
+ * @example
43
+ * ```tsx
44
+ * // Default behavior - no reactive state subscriptions
45
+ * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });
46
+ *
47
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
48
+ * const [throttledValue, throttler] = createThrottledValue(
49
+ * rawValue,
50
+ * { wait: 1000 },
51
+ * (state) => ({ isPending: state.isPending })
52
+ * );
53
+ *
54
+ * // Use the throttled value
55
+ * console.log(throttledValue()); // Access the current throttled value
56
+ *
57
+ * // Access throttler state via signals
58
+ * console.log('Is pending:', throttler.state().isPending);
59
+ *
60
+ * // Control the throttler
61
+ * throttler.cancel(); // Cancel any pending updates
62
+ * ```
63
+ */
64
+ function createThrottledValue(value, initialOptions, selector) {
65
+ const [throttledValue, setThrottledValue, throttler] = require_createThrottledSignal.createThrottledSignal(value(), initialOptions, selector);
66
+ (0, solid_js.createEffect)(() => {
67
+ setThrottledValue(value());
68
+ });
69
+ return [throttledValue, throttler];
70
+ }
71
+
72
+ //#endregion
73
+ exports.createThrottledValue = createThrottledValue;
74
+ //# sourceMappingURL=createThrottledValue.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createThrottledValue.cjs","names":["createThrottledSignal"],"sources":["../../src/throttler/createThrottledValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createThrottledSignal } from './createThrottledSignal'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\n/**\n * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.\n * This hook uses Solid's createSignal internally to manage the throttled state.\n *\n * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.\n * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the throttled value\n * - The throttler instance with control methods\n *\n * The throttled value will update according to the leading/trailing edge behavior specified in the options.\n *\n * For more direct control over throttling behavior without Solid state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Unix timestamp of the last execution\n * - `nextExecutionTime`: Unix timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });\n *\n * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)\n * const [throttledValue, throttler] = createThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // Use the throttled value\n * console.log(throttledValue()); // Access the current throttled value\n *\n * // Access throttler state via signals\n * console.log('Is pending:', throttler.state().isPending);\n *\n * // Control the throttler\n * throttler.cancel(); // Cancel any pending updates\n * ```\n */\nexport function createThrottledValue<TValue, TSelected = {}>(\n value: Accessor<TValue>,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>] {\n const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(\n value(),\n initialOptions,\n selector,\n )\n\n createEffect(() => {\n setThrottledValue(value() as any)\n })\n\n return [throttledValue, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,SAAgB,qBACd,OACA,gBACA,UAC+D;CAC/D,MAAM,CAAC,gBAAgB,mBAAmB,aAAaA,oDACrD,OAAO,EACP,gBACA,SACD;AAED,kCAAmB;AACjB,oBAAkB,OAAO,CAAQ;GACjC;AAEF,QAAO,CAAC,gBAAgB,UAAU"}
@@ -1,6 +1,9 @@
1
- import { SolidThrottler } from './createThrottler.cjs';
2
- import { Accessor, Setter } from 'solid-js';
3
- import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
1
+ import { SolidThrottler } from "./createThrottler.cjs";
2
+ import { Accessor, Setter } from "solid-js";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/createThrottledValue.d.ts
6
+
4
7
  /**
5
8
  * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.
6
9
  * This hook uses Solid's createSignal internally to manage the throttled state.
@@ -60,4 +63,7 @@ import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
60
63
  * throttler.cancel(); // Cancel any pending updates
61
64
  * ```
62
65
  */
63
- export declare function createThrottledValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
66
+ declare function createThrottledValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
67
+ //#endregion
68
+ export { createThrottledValue };
69
+ //# sourceMappingURL=createThrottledValue.d.cts.map
@@ -1,6 +1,9 @@
1
- import { SolidThrottler } from './createThrottler.js';
2
- import { Accessor, Setter } from 'solid-js';
3
- import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
1
+ import { SolidThrottler } from "./createThrottler.js";
2
+ import { Accessor, Setter } from "solid-js";
3
+ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
4
+
5
+ //#region src/throttler/createThrottledValue.d.ts
6
+
4
7
  /**
5
8
  * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.
6
9
  * This hook uses Solid's createSignal internally to manage the throttled state.
@@ -60,4 +63,7 @@ import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
60
63
  * throttler.cancel(); // Cancel any pending updates
61
64
  * ```
62
65
  */
63
- export declare function createThrottledValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
66
+ declare function createThrottledValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>];
67
+ //#endregion
68
+ export { createThrottledValue };
69
+ //# sourceMappingURL=createThrottledValue.d.ts.map
@@ -0,0 +1,74 @@
1
+ import { createThrottledSignal } from "./createThrottledSignal.js";
2
+ import { createEffect } from "solid-js";
3
+
4
+ //#region src/throttler/createThrottledValue.ts
5
+ /**
6
+ * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.
7
+ * This hook uses Solid's createSignal internally to manage the throttled state.
8
+ *
9
+ * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
10
+ * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
11
+ *
12
+ * The hook returns a tuple containing:
13
+ * - An accessor function that provides the throttled value
14
+ * - The throttler instance with control methods
15
+ *
16
+ * The throttled value will update according to the leading/trailing edge behavior specified in the options.
17
+ *
18
+ * For more direct control over throttling behavior without Solid state management,
19
+ * consider using the lower-level createThrottler hook instead.
20
+ *
21
+ * ## State Management and Selector
22
+ *
23
+ * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
24
+ * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,
25
+ * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
26
+ *
27
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
28
+ * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you
29
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
30
+ * the reactive system track the selected state values.
31
+ *
32
+ * Available throttler state properties:
33
+ * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
34
+ * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
35
+ * - `executionCount`: Number of function executions that have been completed
36
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
37
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
38
+ * - `lastExecutionTime`: Unix timestamp of the last execution
39
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
40
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
41
+ *
42
+ * @example
43
+ * ```tsx
44
+ * // Default behavior - no reactive state subscriptions
45
+ * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });
46
+ *
47
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
48
+ * const [throttledValue, throttler] = createThrottledValue(
49
+ * rawValue,
50
+ * { wait: 1000 },
51
+ * (state) => ({ isPending: state.isPending })
52
+ * );
53
+ *
54
+ * // Use the throttled value
55
+ * console.log(throttledValue()); // Access the current throttled value
56
+ *
57
+ * // Access throttler state via signals
58
+ * console.log('Is pending:', throttler.state().isPending);
59
+ *
60
+ * // Control the throttler
61
+ * throttler.cancel(); // Cancel any pending updates
62
+ * ```
63
+ */
64
+ function createThrottledValue(value, initialOptions, selector) {
65
+ const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(value(), initialOptions, selector);
66
+ createEffect(() => {
67
+ setThrottledValue(value());
68
+ });
69
+ return [throttledValue, throttler];
70
+ }
71
+
72
+ //#endregion
73
+ export { createThrottledValue };
74
+ //# sourceMappingURL=createThrottledValue.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createThrottledValue.js","names":[],"sources":["../../src/throttler/createThrottledValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createThrottledSignal } from './createThrottledSignal'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\n/**\n * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.\n * This hook uses Solid's createSignal internally to manage the throttled state.\n *\n * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.\n * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the throttled value\n * - The throttler instance with control methods\n *\n * The throttled value will update according to the leading/trailing edge behavior specified in the options.\n *\n * For more direct control over throttling behavior without Solid state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Unix timestamp of the last execution\n * - `nextExecutionTime`: Unix timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });\n *\n * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)\n * const [throttledValue, throttler] = createThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // Use the throttled value\n * console.log(throttledValue()); // Access the current throttled value\n *\n * // Access throttler state via signals\n * console.log('Is pending:', throttler.state().isPending);\n *\n * // Control the throttler\n * throttler.cancel(); // Cancel any pending updates\n * ```\n */\nexport function createThrottledValue<TValue, TSelected = {}>(\n value: Accessor<TValue>,\n initialOptions: ThrottlerOptions<Setter<TValue>>,\n selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>] {\n const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(\n value(),\n initialOptions,\n selector,\n )\n\n createEffect(() => {\n setThrottledValue(value() as any)\n })\n\n return [throttledValue, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,SAAgB,qBACd,OACA,gBACA,UAC+D;CAC/D,MAAM,CAAC,gBAAgB,mBAAmB,aAAa,sBACrD,OAAO,EACP,gBACA,SACD;AAED,oBAAmB;AACjB,oBAAkB,OAAO,CAAQ;GACjC;AAEF,QAAO,CAAC,gBAAgB,UAAU"}