@tanstack/preact-pacer 0.23.0 → 0.24.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 (242) hide show
  1. package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -4
  2. package/dist/async-batcher/useAsyncBatchedCallback.js +1 -2
  3. package/dist/async-batcher/useAsyncBatcher.d.ts +4 -7
  4. package/dist/async-batcher/useAsyncBatcher.js +1 -3
  5. package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +2 -4
  6. package/dist/async-debouncer/useAsyncDebouncedCallback.js +1 -2
  7. package/dist/async-debouncer/useAsyncDebouncer.d.ts +4 -6
  8. package/dist/async-debouncer/useAsyncDebouncer.js +1 -2
  9. package/dist/async-queuer/useAsyncQueuedState.d.ts +4 -6
  10. package/dist/async-queuer/useAsyncQueuedState.js +3 -4
  11. package/dist/async-queuer/useAsyncQueuer.d.ts +6 -8
  12. package/dist/async-queuer/useAsyncQueuer.js +3 -4
  13. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -4
  14. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +1 -2
  15. package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +4 -6
  16. package/dist/async-rate-limiter/useAsyncRateLimiter.js +1 -2
  17. package/dist/async-throttler/useAsyncThrottledCallback.d.ts +2 -4
  18. package/dist/async-throttler/useAsyncThrottledCallback.js +1 -2
  19. package/dist/async-throttler/useAsyncThrottler.d.ts +4 -6
  20. package/dist/async-throttler/useAsyncThrottler.js +1 -2
  21. package/dist/batcher/useBatchedCallback.d.ts +2 -4
  22. package/dist/batcher/useBatchedCallback.js +1 -2
  23. package/dist/batcher/useBatcher.d.ts +6 -10
  24. package/dist/batcher/useBatcher.js +3 -6
  25. package/dist/debouncer/useDebouncedCallback.d.ts +2 -4
  26. package/dist/debouncer/useDebouncedCallback.js +1 -2
  27. package/dist/debouncer/useDebouncedState.d.ts +2 -4
  28. package/dist/debouncer/useDebouncedState.js +1 -2
  29. package/dist/debouncer/useDebouncedValue.d.ts +2 -4
  30. package/dist/debouncer/useDebouncedValue.js +1 -2
  31. package/dist/debouncer/useDebouncer.d.ts +4 -6
  32. package/dist/debouncer/useDebouncer.js +1 -2
  33. package/dist/provider/PacerProvider.d.ts +6 -8
  34. package/dist/provider/PacerProvider.js +1 -2
  35. package/dist/queuer/useQueuedState.d.ts +2 -4
  36. package/dist/queuer/useQueuedState.js +1 -2
  37. package/dist/queuer/useQueuedValue.d.ts +2 -4
  38. package/dist/queuer/useQueuedValue.js +1 -2
  39. package/dist/queuer/useQueuer.d.ts +4 -6
  40. package/dist/queuer/useQueuer.js +1 -2
  41. package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -4
  42. package/dist/rate-limiter/useRateLimitedCallback.js +1 -2
  43. package/dist/rate-limiter/useRateLimitedState.d.ts +2 -4
  44. package/dist/rate-limiter/useRateLimitedState.js +1 -2
  45. package/dist/rate-limiter/useRateLimitedValue.d.ts +2 -4
  46. package/dist/rate-limiter/useRateLimitedValue.js +1 -2
  47. package/dist/rate-limiter/useRateLimiter.d.ts +4 -6
  48. package/dist/rate-limiter/useRateLimiter.js +1 -2
  49. package/dist/throttler/useThrottledCallback.d.ts +2 -4
  50. package/dist/throttler/useThrottledCallback.js +1 -2
  51. package/dist/throttler/useThrottledState.d.ts +2 -4
  52. package/dist/throttler/useThrottledState.js +1 -2
  53. package/dist/throttler/useThrottledValue.d.ts +2 -4
  54. package/dist/throttler/useThrottledValue.js +1 -2
  55. package/dist/throttler/useThrottler.d.ts +4 -6
  56. package/dist/throttler/useThrottler.js +1 -2
  57. package/package.json +22 -70
  58. package/dist/async-batcher/index.cjs +0 -13
  59. package/dist/async-batcher/index.d.cts +0 -4
  60. package/dist/async-batcher/useAsyncBatchedCallback.cjs +0 -51
  61. package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +0 -1
  62. package/dist/async-batcher/useAsyncBatchedCallback.d.cts +0 -43
  63. package/dist/async-batcher/useAsyncBatchedCallback.js.map +0 -1
  64. package/dist/async-batcher/useAsyncBatcher.cjs +0 -217
  65. package/dist/async-batcher/useAsyncBatcher.cjs.map +0 -1
  66. package/dist/async-batcher/useAsyncBatcher.d.cts +0 -223
  67. package/dist/async-batcher/useAsyncBatcher.js.map +0 -1
  68. package/dist/async-debouncer/index.cjs +0 -13
  69. package/dist/async-debouncer/index.d.cts +0 -4
  70. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs +0 -52
  71. package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +0 -1
  72. package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +0 -47
  73. package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +0 -1
  74. package/dist/async-debouncer/useAsyncDebouncer.cjs +0 -195
  75. package/dist/async-debouncer/useAsyncDebouncer.cjs.map +0 -1
  76. package/dist/async-debouncer/useAsyncDebouncer.d.cts +0 -202
  77. package/dist/async-debouncer/useAsyncDebouncer.js.map +0 -1
  78. package/dist/async-queuer/index.cjs +0 -13
  79. package/dist/async-queuer/index.d.cts +0 -4
  80. package/dist/async-queuer/useAsyncQueuedState.cjs +0 -154
  81. package/dist/async-queuer/useAsyncQueuedState.cjs.map +0 -1
  82. package/dist/async-queuer/useAsyncQueuedState.d.cts +0 -150
  83. package/dist/async-queuer/useAsyncQueuedState.js.map +0 -1
  84. package/dist/async-queuer/useAsyncQueuer.cjs +0 -217
  85. package/dist/async-queuer/useAsyncQueuer.cjs.map +0 -1
  86. package/dist/async-queuer/useAsyncQueuer.d.cts +0 -223
  87. package/dist/async-queuer/useAsyncQueuer.js.map +0 -1
  88. package/dist/async-rate-limiter/index.cjs +0 -13
  89. package/dist/async-rate-limiter/index.d.cts +0 -4
  90. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs +0 -65
  91. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +0 -1
  92. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +0 -60
  93. package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +0 -1
  94. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +0 -209
  95. package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +0 -1
  96. package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +0 -219
  97. package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +0 -1
  98. package/dist/async-retryer/index.cjs +0 -8
  99. package/dist/async-retryer/index.d.cts +0 -1
  100. package/dist/async-throttler/index.cjs +0 -13
  101. package/dist/async-throttler/index.d.cts +0 -4
  102. package/dist/async-throttler/useAsyncThrottledCallback.cjs +0 -49
  103. package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +0 -1
  104. package/dist/async-throttler/useAsyncThrottledCallback.d.cts +0 -44
  105. package/dist/async-throttler/useAsyncThrottledCallback.js.map +0 -1
  106. package/dist/async-throttler/useAsyncThrottler.cjs +0 -206
  107. package/dist/async-throttler/useAsyncThrottler.cjs.map +0 -1
  108. package/dist/async-throttler/useAsyncThrottler.d.cts +0 -213
  109. package/dist/async-throttler/useAsyncThrottler.js.map +0 -1
  110. package/dist/batcher/index.cjs +0 -13
  111. package/dist/batcher/index.d.cts +0 -4
  112. package/dist/batcher/useBatchedCallback.cjs +0 -47
  113. package/dist/batcher/useBatchedCallback.cjs.map +0 -1
  114. package/dist/batcher/useBatchedCallback.d.cts +0 -41
  115. package/dist/batcher/useBatchedCallback.js.map +0 -1
  116. package/dist/batcher/useBatcher.cjs +0 -165
  117. package/dist/batcher/useBatcher.cjs.map +0 -1
  118. package/dist/batcher/useBatcher.d.cts +0 -174
  119. package/dist/batcher/useBatcher.js.map +0 -1
  120. package/dist/debouncer/index.cjs +0 -17
  121. package/dist/debouncer/index.d.cts +0 -6
  122. package/dist/debouncer/useDebouncedCallback.cjs +0 -48
  123. package/dist/debouncer/useDebouncedCallback.cjs.map +0 -1
  124. package/dist/debouncer/useDebouncedCallback.d.cts +0 -43
  125. package/dist/debouncer/useDebouncedCallback.js.map +0 -1
  126. package/dist/debouncer/useDebouncedState.cjs +0 -89
  127. package/dist/debouncer/useDebouncedState.cjs.map +0 -1
  128. package/dist/debouncer/useDebouncedState.d.cts +0 -80
  129. package/dist/debouncer/useDebouncedState.js.map +0 -1
  130. package/dist/debouncer/useDebouncedValue.cjs +0 -96
  131. package/dist/debouncer/useDebouncedValue.cjs.map +0 -1
  132. package/dist/debouncer/useDebouncedValue.d.cts +0 -89
  133. package/dist/debouncer/useDebouncedValue.js.map +0 -1
  134. package/dist/debouncer/useDebouncer.cjs +0 -141
  135. package/dist/debouncer/useDebouncer.cjs.map +0 -1
  136. package/dist/debouncer/useDebouncer.d.cts +0 -151
  137. package/dist/debouncer/useDebouncer.js.map +0 -1
  138. package/dist/index.cjs +0 -67
  139. package/dist/index.d.cts +0 -30
  140. package/dist/provider/PacerProvider.cjs +0 -26
  141. package/dist/provider/PacerProvider.cjs.map +0 -1
  142. package/dist/provider/PacerProvider.d.cts +0 -28
  143. package/dist/provider/PacerProvider.js.map +0 -1
  144. package/dist/provider/index.cjs +0 -6
  145. package/dist/provider/index.d.cts +0 -2
  146. package/dist/queuer/index.cjs +0 -15
  147. package/dist/queuer/index.d.cts +0 -5
  148. package/dist/queuer/useQueuedState.cjs +0 -129
  149. package/dist/queuer/useQueuedState.cjs.map +0 -1
  150. package/dist/queuer/useQueuedState.d.cts +0 -121
  151. package/dist/queuer/useQueuedState.js.map +0 -1
  152. package/dist/queuer/useQueuedValue.cjs +0 -115
  153. package/dist/queuer/useQueuedValue.cjs.map +0 -1
  154. package/dist/queuer/useQueuedValue.d.cts +0 -104
  155. package/dist/queuer/useQueuedValue.js.map +0 -1
  156. package/dist/queuer/useQueuer.cjs +0 -176
  157. package/dist/queuer/useQueuer.cjs.map +0 -1
  158. package/dist/queuer/useQueuer.d.cts +0 -185
  159. package/dist/queuer/useQueuer.js.map +0 -1
  160. package/dist/rate-limiter/index.cjs +0 -17
  161. package/dist/rate-limiter/index.d.cts +0 -6
  162. package/dist/rate-limiter/useRateLimitedCallback.cjs +0 -65
  163. package/dist/rate-limiter/useRateLimitedCallback.cjs.map +0 -1
  164. package/dist/rate-limiter/useRateLimitedCallback.d.cts +0 -60
  165. package/dist/rate-limiter/useRateLimitedCallback.js.map +0 -1
  166. package/dist/rate-limiter/useRateLimitedState.cjs +0 -115
  167. package/dist/rate-limiter/useRateLimitedState.cjs.map +0 -1
  168. package/dist/rate-limiter/useRateLimitedState.d.cts +0 -106
  169. package/dist/rate-limiter/useRateLimitedState.js.map +0 -1
  170. package/dist/rate-limiter/useRateLimitedValue.cjs +0 -102
  171. package/dist/rate-limiter/useRateLimitedValue.cjs.map +0 -1
  172. package/dist/rate-limiter/useRateLimitedValue.d.cts +0 -95
  173. package/dist/rate-limiter/useRateLimitedValue.js.map +0 -1
  174. package/dist/rate-limiter/useRateLimiter.cjs +0 -167
  175. package/dist/rate-limiter/useRateLimiter.cjs.map +0 -1
  176. package/dist/rate-limiter/useRateLimiter.d.cts +0 -178
  177. package/dist/rate-limiter/useRateLimiter.js.map +0 -1
  178. package/dist/throttler/index.cjs +0 -17
  179. package/dist/throttler/index.d.cts +0 -6
  180. package/dist/throttler/useThrottledCallback.cjs +0 -49
  181. package/dist/throttler/useThrottledCallback.cjs.map +0 -1
  182. package/dist/throttler/useThrottledCallback.d.cts +0 -44
  183. package/dist/throttler/useThrottledCallback.js.map +0 -1
  184. package/dist/throttler/useThrottledState.cjs +0 -100
  185. package/dist/throttler/useThrottledState.cjs.map +0 -1
  186. package/dist/throttler/useThrottledState.d.cts +0 -91
  187. package/dist/throttler/useThrottledState.js.map +0 -1
  188. package/dist/throttler/useThrottledValue.cjs +0 -91
  189. package/dist/throttler/useThrottledValue.cjs.map +0 -1
  190. package/dist/throttler/useThrottledValue.d.cts +0 -84
  191. package/dist/throttler/useThrottledValue.js.map +0 -1
  192. package/dist/throttler/useThrottler.cjs +0 -146
  193. package/dist/throttler/useThrottler.cjs.map +0 -1
  194. package/dist/throttler/useThrottler.d.cts +0 -156
  195. package/dist/throttler/useThrottler.js.map +0 -1
  196. package/dist/types/index.cjs +0 -8
  197. package/dist/types/index.d.cts +0 -1
  198. package/dist/utils/index.cjs +0 -8
  199. package/dist/utils/index.d.cts +0 -1
  200. package/src/async-batcher/index.ts +0 -4
  201. package/src/async-batcher/useAsyncBatchedCallback.ts +0 -53
  202. package/src/async-batcher/useAsyncBatcher.ts +0 -293
  203. package/src/async-debouncer/index.ts +0 -5
  204. package/src/async-debouncer/useAsyncDebouncedCallback.ts +0 -55
  205. package/src/async-debouncer/useAsyncDebouncer.ts +0 -274
  206. package/src/async-queuer/index.ts +0 -4
  207. package/src/async-queuer/useAsyncQueuedState.ts +0 -165
  208. package/src/async-queuer/useAsyncQueuer.ts +0 -293
  209. package/src/async-rate-limiter/index.ts +0 -5
  210. package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +0 -68
  211. package/src/async-rate-limiter/useAsyncRateLimiter.ts +0 -294
  212. package/src/async-retryer/index.ts +0 -2
  213. package/src/async-throttler/index.ts +0 -5
  214. package/src/async-throttler/useAsyncThrottledCallback.ts +0 -52
  215. package/src/async-throttler/useAsyncThrottler.ts +0 -285
  216. package/src/batcher/index.ts +0 -4
  217. package/src/batcher/useBatchedCallback.ts +0 -46
  218. package/src/batcher/useBatcher.ts +0 -241
  219. package/src/debouncer/index.ts +0 -7
  220. package/src/debouncer/useDebouncedCallback.ts +0 -51
  221. package/src/debouncer/useDebouncedState.ts +0 -106
  222. package/src/debouncer/useDebouncedValue.ts +0 -109
  223. package/src/debouncer/useDebouncer.ts +0 -219
  224. package/src/index.ts +0 -56
  225. package/src/provider/PacerProvider.tsx +0 -70
  226. package/src/provider/index.ts +0 -1
  227. package/src/queuer/index.ts +0 -5
  228. package/src/queuer/useQueuedState.ts +0 -133
  229. package/src/queuer/useQueuedValue.ts +0 -129
  230. package/src/queuer/useQueuer.ts +0 -251
  231. package/src/rate-limiter/index.ts +0 -6
  232. package/src/rate-limiter/useRateLimitedCallback.ts +0 -68
  233. package/src/rate-limiter/useRateLimitedState.ts +0 -124
  234. package/src/rate-limiter/useRateLimitedValue.ts +0 -110
  235. package/src/rate-limiter/useRateLimiter.ts +0 -244
  236. package/src/throttler/index.ts +0 -7
  237. package/src/throttler/useThrottledCallback.ts +0 -52
  238. package/src/throttler/useThrottledState.ts +0 -118
  239. package/src/throttler/useThrottledValue.ts +0 -104
  240. package/src/throttler/useThrottler.ts +0 -224
  241. package/src/types/index.ts +0 -1
  242. package/src/utils/index.ts +0 -1
@@ -1 +0,0 @@
1
- {"version":3,"file":"useAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n AsyncRateLimiterOptions,\n AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiterOptions<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the rate limiter instance.\n * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n */\n onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncRateLimiter<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n *\n * This is useful for opting into state re-renders for specific parts of the rate limiter state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n * {({ rejectionCount }) => (\n * <div>Rejections: {rejectionCount}</div>\n * )}\n * </rateLimiter.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the rate limiter state changes\n *\n * Use this instead of `rateLimiter.store.state`\n */\n readonly state: 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 `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\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 (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\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 * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * 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 or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook aborts any in-flight execution when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data; // Return value is preserved\n * },\n * { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n * {({ rejectionCount }) => (\n * <div>Rejections: {rejectionCount}</div>\n * )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { limit: 5, window: 1000 },\n * (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { limit: 5, window: 1000 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount\n * })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * {\n * limit: 5,\n * window: 1000,\n * onError: (error) => console.error('API call failed:', error),\n * onReject: (rateLimiter) => console.log('Rate limit exceeded')\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { limit: 5, window: 1000 },\n * (state) => ({\n * successCount: state.successCount,\n * errorCount: state.errorCount,\n * settleCount: state.settleCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { limit: 5, window: 1000 },\n * (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n * async (query) => {\n * const result = await searchAPI(query);\n * setData(result);\n * return result; // Return value can be used by the caller\n * },\n * {\n * limit: 10,\n * window: 60000, // 10 calls per minute\n * onReject: (rateLimiter) => {\n * console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n * },\n * onError: (error) => {\n * console.error('API call failed:', error);\n * }\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n>(\n fn: TFn,\n options: PreactAsyncRateLimiterOptions<TFn, TSelected>,\n selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncRateLimiter,\n ...options,\n } as PreactAsyncRateLimiterOptions<TFn, TSelected>\n\n const [asyncRateLimiter] = useState(() => {\n const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(rateLimiterInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return rateLimiterInstance\n })\n\n asyncRateLimiter.fn = fn\n asyncRateLimiter.setOptions(mergedOptions)\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(asyncRateLimiter)\n } else {\n asyncRateLimiter.abort()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n const state = useSelector(asyncRateLimiter.store, selector, {\n compare: shallow,\n })\n\n return useMemo(\n () =>\n ({\n ...asyncRateLimiter,\n state,\n }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncRateLimiter, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsOA,SAAgB,oBAId,IACA,SACA,kBACG,CAAC,IACoC;CACxC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CAEA,MAAM,CAAC,oBAAoB,eAAe;EACxC,MAAM,sBAAsB,IAAI,iBAC9B,IACA,aACF;EAEA,oBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,WAAW,YAAY,oBAAoB,OAAO,MAAM,UAAU,EACtE,SAAS,QACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,iBAAiB,KAAK;CACtB,iBAAiB,WAAW,aAAa;CAGzC,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,gBAAgB;QAExC,iBAAiB,MAAM;EAE3B;CACF,GAAG,CAAC,CAAC;CAGL,MAAM,QAAQ,YAAY,iBAAiB,OAAO,UAAU,EAC1D,SAAS,QACX,CAAC;CAED,OAAO,eAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,kBAAkB,KAAK,CAC1B;AACF"}
@@ -1,8 +0,0 @@
1
-
2
- var _tanstack_pacer_async_retryer = require("@tanstack/pacer/async-retryer");
3
- Object.keys(_tanstack_pacer_async_retryer).forEach(function (k) {
4
- if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
5
- enumerable: true,
6
- get: function () { return _tanstack_pacer_async_retryer[k]; }
7
- });
8
- });
@@ -1 +0,0 @@
1
- export * from "@tanstack/pacer/async-retryer";
@@ -1,13 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_useAsyncThrottler = require('./useAsyncThrottler.cjs');
3
- const require_useAsyncThrottledCallback = require('./useAsyncThrottledCallback.cjs');
4
-
5
- exports.useAsyncThrottledCallback = require_useAsyncThrottledCallback.useAsyncThrottledCallback;
6
- exports.useAsyncThrottler = require_useAsyncThrottler.useAsyncThrottler;
7
- var _tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler");
8
- Object.keys(_tanstack_pacer_async_throttler).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_throttler[k]; }
12
- });
13
- });
@@ -1,4 +0,0 @@
1
- import { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottler } from "./useAsyncThrottler.cjs";
2
- import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.cjs";
3
- export * from "@tanstack/pacer/async-throttler";
4
- export { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottledCallback, useAsyncThrottler };
@@ -1,49 +0,0 @@
1
- const require_useAsyncThrottler = require('./useAsyncThrottler.cjs');
2
- let preact_hooks = require("preact/hooks");
3
-
4
- //#region src/async-throttler/useAsyncThrottledCallback.ts
5
- /**
6
- * A Preact hook that creates a throttled version of an async callback function.
7
- * This hook is a convenient wrapper around the `useAsyncThrottler` hook,
8
- * providing a stable, throttled async function reference for use in Preact components.
9
- *
10
- * The throttled async function will execute at most once within the specified wait time period,
11
- * regardless of how many times it is called. Calls made during the wait period reschedule a
12
- * single trailing execution with the latest arguments when `trailing` is enabled (the default).
13
- * The most recent call's promise resolves or rejects with the trailing execution's result;
14
- * each earlier call's promise resolves immediately with the most recent previous result (or
15
- * `undefined` if nothing has executed yet), as does every call when the throttler is disabled.
16
- *
17
- * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
18
- * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
19
- *
20
- * For advanced usage requiring features like:
21
- * - Manual cancellation
22
- * - Access to execution/error state
23
- * - Custom useCallback dependencies
24
- *
25
- * Consider using the `useAsyncThrottler` hook instead.
26
- *
27
- *
28
- * @example
29
- * ```tsx
30
- * // Throttle an async API call
31
- * const handleApiCall = useAsyncThrottledCallback(async (data) => {
32
- * const result = await sendDataToServer(data);
33
- * return result;
34
- * }, {
35
- * wait: 200 // Execute at most once every 200ms
36
- * });
37
- *
38
- * // Use in an event handler
39
- * <button onClick={() => handleApiCall(formData)}>Send</button>
40
- * ```
41
- */
42
- function useAsyncThrottledCallback(fn, options) {
43
- const asyncThrottledFn = require_useAsyncThrottler.useAsyncThrottler(fn, options).maybeExecute;
44
- return (0, preact_hooks.useCallback)((...args) => asyncThrottledFn(...args), [asyncThrottledFn]);
45
- }
46
-
47
- //#endregion
48
- exports.useAsyncThrottledCallback = useAsyncThrottledCallback;
49
- //# sourceMappingURL=useAsyncThrottledCallback.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useAsyncThrottledCallback.cjs","names":["useAsyncThrottler","useCallback"],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { PreactAsyncThrottlerOptions } from './useAsyncThrottler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. Calls made during the wait period reschedule a\n * single trailing execution with the latest arguments when `trailing` is enabled (the default).\n * The most recent call's promise resolves or rejects with the trailing execution's result;\n * each earlier call's promise resolves immediately with the most recent previous result (or\n * `undefined` if nothing has executed yet), as does every call when the throttler is disabled.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n * const result = await sendDataToServer(data);\n * return result;\n * }, {\n * wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: PreactAsyncThrottlerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) => asyncThrottledFn(...args),\n [asyncThrottledFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,0BACd,IACA,SAC6E;CAC7E,MAAM,mBAAmBA,4CAAkB,IAAI,OAAO,CAAC,CAAC;CACxD,WAAOC,2BACJ,GAAG,SAA0B,iBAAiB,GAAG,IAAI,GACtD,CAAC,gBAAgB,CACnB;AACF"}
@@ -1,44 +0,0 @@
1
- import { PreactAsyncThrottlerOptions } from "./useAsyncThrottler.cjs";
2
- import { AnyAsyncFunction } from "@tanstack/pacer/types";
3
- //#region src/async-throttler/useAsyncThrottledCallback.d.ts
4
- /**
5
- * A Preact hook that creates a throttled version of an async callback function.
6
- * This hook is a convenient wrapper around the `useAsyncThrottler` hook,
7
- * providing a stable, throttled async function reference for use in Preact components.
8
- *
9
- * The throttled async function will execute at most once within the specified wait time period,
10
- * regardless of how many times it is called. Calls made during the wait period reschedule a
11
- * single trailing execution with the latest arguments when `trailing` is enabled (the default).
12
- * The most recent call's promise resolves or rejects with the trailing execution's result;
13
- * each earlier call's promise resolves immediately with the most recent previous result (or
14
- * `undefined` if nothing has executed yet), as does every call when the throttler is disabled.
15
- *
16
- * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
17
- * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
18
- *
19
- * For advanced usage requiring features like:
20
- * - Manual cancellation
21
- * - Access to execution/error state
22
- * - Custom useCallback dependencies
23
- *
24
- * Consider using the `useAsyncThrottler` hook instead.
25
- *
26
- *
27
- * @example
28
- * ```tsx
29
- * // Throttle an async API call
30
- * const handleApiCall = useAsyncThrottledCallback(async (data) => {
31
- * const result = await sendDataToServer(data);
32
- * return result;
33
- * }, {
34
- * wait: 200 // Execute at most once every 200ms
35
- * });
36
- *
37
- * // Use in an event handler
38
- * <button onClick={() => handleApiCall(formData)}>Send</button>
39
- * ```
40
- */
41
- declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncThrottlerOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
42
- //#endregion
43
- export { useAsyncThrottledCallback };
44
- //# sourceMappingURL=useAsyncThrottledCallback.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useAsyncThrottledCallback.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { PreactAsyncThrottlerOptions } from './useAsyncThrottler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. Calls made during the wait period reschedule a\n * single trailing execution with the latest arguments when `trailing` is enabled (the default).\n * The most recent call's promise resolves or rejects with the trailing execution's result;\n * each earlier call's promise resolves immediately with the most recent previous result (or\n * `undefined` if nothing has executed yet), as does every call when the throttler is disabled.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n * const result = await sendDataToServer(data);\n * return result;\n * }, {\n * wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n fn: TFn,\n options: PreactAsyncThrottlerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) => asyncThrottledFn(...args),\n [asyncThrottledFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,0BACd,IACA,SAC6E;CAC7E,MAAM,mBAAmB,kBAAkB,IAAI,OAAO,CAAC,CAAC;CACxD,OAAO,aACJ,GAAG,SAA0B,iBAAiB,GAAG,IAAI,GACtD,CAAC,gBAAgB,CACnB;AACF"}
@@ -1,206 +0,0 @@
1
- const require_PacerProvider = require('../provider/PacerProvider.cjs');
2
- let preact_hooks = require("preact/hooks");
3
- let _tanstack_preact_store = require("@tanstack/preact-store");
4
- let _tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler");
5
-
6
- //#region src/async-throttler/useAsyncThrottler.ts
7
- /**
8
- * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
9
- *
10
- * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
11
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
12
- *
13
- * Async throttling ensures an async function executes at most once within a specified time window,
14
- * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,
15
- * database operations, or other async tasks.
16
- *
17
- * Unlike the non-async Throttler, this async version supports returning values from the throttled function,
18
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
19
- * instead of setting the result on a state variable from within the throttled function.
20
- *
21
- * Error Handling:
22
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
23
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
24
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
25
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
26
- * - The error state can be checked using the underlying AsyncThrottler instance
27
- *
28
- * ## State Management and Selector
29
- *
30
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
31
- * in two ways:
32
- *
33
- * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
34
- *
35
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
36
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
37
- * in child components.
38
- *
39
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
40
- *
41
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
42
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
43
- * state changes occur.
44
- *
45
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
46
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
47
- * re-renders and gives you full control over when your component updates.
48
- *
49
- * Available state properties:
50
- * - `errorCount`: Number of function executions that have resulted in errors
51
- * - `isExecuting`: Whether the throttled function is currently executing asynchronously
52
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
53
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
54
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
55
- * - `lastResult`: The result from the most recent successful function execution
56
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
57
- * - `settleCount`: Number of function executions that have completed (success or error)
58
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
59
- * - `successCount`: Number of function executions that have completed successfully
60
- *
61
- * ## Unmount behavior
62
- *
63
- * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
64
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
65
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
66
- *
67
- * ```tsx
68
- * const throttler = useAsyncThrottler(fn, {
69
- * wait: 1000,
70
- * onUnmount: (t) => t.flush()
71
- * });
72
- * ```
73
- *
74
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
75
- * If your throttled function updates Preact state, those updates may run after the component has
76
- * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
77
- * accordingly when using onUnmount with flush.
78
- *
79
- * @example
80
- * ```tsx
81
- * // Default behavior - no reactive state subscriptions
82
- * const asyncThrottler = useAsyncThrottler(
83
- * async (id: string) => {
84
- * const data = await api.fetchData(id);
85
- * return data; // Return value is preserved
86
- * },
87
- * { wait: 1000 }
88
- * );
89
- *
90
- * // Subscribe to state changes deep in component tree using Subscribe HOC
91
- * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
92
- * {({ isPending }) => (
93
- * <div>{isPending ? 'Processing...' : 'Ready'}</div>
94
- * )}
95
- * </asyncThrottler.Subscribe>
96
- *
97
- * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
98
- * const asyncThrottler = useAsyncThrottler(
99
- * async (id: string) => {
100
- * const data = await api.fetchData(id);
101
- * return data;
102
- * },
103
- * { wait: 1000 },
104
- * (state) => ({
105
- * isExecuting: state.isExecuting,
106
- * isPending: state.isPending,
107
- * status: state.status
108
- * })
109
- * );
110
- *
111
- * // Opt-in to re-render when results are available (optimized for data display)
112
- * const asyncThrottler = useAsyncThrottler(
113
- * async (id: string) => {
114
- * const data = await api.fetchData(id);
115
- * return data;
116
- * },
117
- * { wait: 1000 },
118
- * (state) => ({
119
- * lastResult: state.lastResult,
120
- * successCount: state.successCount,
121
- * settleCount: state.settleCount
122
- * })
123
- * );
124
- *
125
- * // Opt-in to re-render when error state changes (optimized for error handling)
126
- * const asyncThrottler = useAsyncThrottler(
127
- * async (id: string) => {
128
- * const data = await api.fetchData(id);
129
- * return data;
130
- * },
131
- * {
132
- * wait: 1000,
133
- * onError: (error) => console.error('API call failed:', error)
134
- * },
135
- * (state) => ({
136
- * errorCount: state.errorCount,
137
- * status: state.status
138
- * })
139
- * );
140
- *
141
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
142
- * const asyncThrottler = useAsyncThrottler(
143
- * async (id: string) => {
144
- * const data = await api.fetchData(id);
145
- * return data;
146
- * },
147
- * { wait: 1000 },
148
- * (state) => ({
149
- * lastExecutionTime: state.lastExecutionTime,
150
- * nextExecutionTime: state.nextExecutionTime
151
- * })
152
- * );
153
- *
154
- * // With state management and return value
155
- * const [data, setData] = useState(null);
156
- * const { maybeExecute, state } = useAsyncThrottler(
157
- * async (query) => {
158
- * const result = await searchAPI(query);
159
- * setData(result);
160
- * return result; // Return value can be used by the caller
161
- * },
162
- * {
163
- * wait: 2000,
164
- * leading: true, // Execute immediately on first call
165
- * trailing: false // Skip trailing edge updates
166
- * }
167
- * );
168
- *
169
- * // Access the selected state (will be empty object {} unless selector provided)
170
- * const { isExecuting, lastResult } = state;
171
- * ```
172
- */
173
- function useAsyncThrottler(fn, options, selector = () => ({})) {
174
- const mergedOptions = {
175
- ...require_PacerProvider.useDefaultPacerOptions().asyncThrottler,
176
- ...options
177
- };
178
- const [asyncThrottler] = (0, preact_hooks.useState)(() => {
179
- const throttlerInstance = new _tanstack_pacer_async_throttler.AsyncThrottler(fn, mergedOptions);
180
- throttlerInstance.Subscribe = function Subscribe(props) {
181
- const selected = (0, _tanstack_preact_store.useSelector)(throttlerInstance.store, props.selector, { compare: _tanstack_preact_store.shallow });
182
- return typeof props.children === "function" ? props.children(selected) : props.children;
183
- };
184
- return throttlerInstance;
185
- });
186
- asyncThrottler.fn = fn;
187
- asyncThrottler.setOptions(mergedOptions);
188
- const state = (0, _tanstack_preact_store.useSelector)(asyncThrottler.store, selector, { compare: _tanstack_preact_store.shallow });
189
- (0, preact_hooks.useEffect)(() => {
190
- return () => {
191
- if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncThrottler);
192
- else {
193
- asyncThrottler.cancel();
194
- asyncThrottler.abort();
195
- }
196
- };
197
- }, []);
198
- return (0, preact_hooks.useMemo)(() => ({
199
- ...asyncThrottler,
200
- state
201
- }), [asyncThrottler, state]);
202
- }
203
-
204
- //#endregion
205
- exports.useAsyncThrottler = useAsyncThrottler;
206
- //# sourceMappingURL=useAsyncThrottler.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useAsyncThrottler.cjs","names":["useDefaultPacerOptions","useState","AsyncThrottler","useSelector","shallow","useMemo"],"sources":["../../src/async-throttler/useAsyncThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n AsyncThrottlerOptions,\n AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncThrottlerOptions<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends AsyncThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: PreactAsyncThrottler<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncThrottler<\n TFn extends AnyAsyncFunction,\n TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state.\n *\n * This is useful for opting into state re-renders for specific parts of the throttler state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: AsyncThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the throttler state changes\n *\n * Use this instead of `throttler.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async throttling ensures an async function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,\n * database operations, or other async tasks.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncThrottler instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * 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 or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the throttled function is currently executing asynchronously\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `lastResult`: The result from the most recent successful function execution\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = useAsyncThrottler(fn, {\n * wait: 1000,\n * onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your throttled function updates Preact state, those updates may run after the component has\n * unmounted, which can cause \"setState on unmounted component\" warnings. Guard your callbacks\n * accordingly when using onUnmount with flush.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data; // Return value is preserved\n * },\n * { wait: 1000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Processing...' : 'Ready'}</div>\n * )}\n * </asyncThrottler.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * isExecuting: state.isExecuting,\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * lastResult: state.lastResult,\n * successCount: state.successCount,\n * settleCount: state.settleCount\n * })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * {\n * wait: 1000,\n * onError: (error) => console.error('API call failed:', error)\n * },\n * (state) => ({\n * errorCount: state.errorCount,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const asyncThrottler = useAsyncThrottler(\n * async (id: string) => {\n * const data = await api.fetchData(id);\n * return data;\n * },\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncThrottler(\n * async (query) => {\n * const result = await searchAPI(query);\n * setData(result);\n * return result; // Return value can be used by the caller\n * },\n * {\n * wait: 2000,\n * leading: true, // Execute immediately on first call\n * trailing: false // Skip trailing edge updates\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(\n fn: TFn,\n options: PreactAsyncThrottlerOptions<TFn, TSelected>,\n selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n ({}) as TSelected,\n): PreactAsyncThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().asyncThrottler,\n ...options,\n } as PreactAsyncThrottlerOptions<TFn, TSelected>\n const [asyncThrottler] = useState(() => {\n const throttlerInstance = new AsyncThrottler<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactAsyncThrottler<TFn, TSelected>\n\n throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: AsyncThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(throttlerInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return throttlerInstance\n })\n\n asyncThrottler.fn = fn\n asyncThrottler.setOptions(mergedOptions)\n\n const state = useSelector(asyncThrottler.store, selector, {\n compare: shallow,\n })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(asyncThrottler)\n } else {\n asyncThrottler.cancel()\n asyncThrottler.abort()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...asyncThrottler,\n state,\n }) as PreactAsyncThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n [asyncThrottler, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgOA,SAAgB,kBACd,IACA,SACA,kBACG,CAAC,IACkC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,6CAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,CAAC,sBAAkBC,6BAAe;EACtC,MAAM,oBAAoB,IAAIC,+CAC5B,IACA,aACF;EAEA,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,eAAWC,oCAAY,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAASC,+BACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,eAAe,KAAK;CACpB,eAAe,WAAW,aAAa;CAEvC,MAAM,YAAQD,oCAAY,eAAe,OAAO,UAAU,EACxD,SAASC,+BACX,CAAC;CAGD,kCAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,cAAc;QACjC;IACL,eAAe,OAAO;IACtB,eAAe,MAAM;GACvB;EACF;CACF,GAAG,CAAC,CAAC;CAGL,WAAOC,6BAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,gBAAgB,KAAK,CACxB;AACF"}
@@ -1,213 +0,0 @@
1
- import { Store } from "@tanstack/preact-store";
2
- import { ComponentChildren } from "preact";
3
- import { AnyAsyncFunction } from "@tanstack/pacer/types";
4
- import { AsyncThrottler, AsyncThrottlerOptions, AsyncThrottlerState } from "@tanstack/pacer/async-throttler";
5
- //#region src/async-throttler/useAsyncThrottler.d.ts
6
- interface PreactAsyncThrottlerOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncThrottlerOptions<TFn> {
7
- /**
8
- * Optional callback invoked when the component unmounts. Receives the throttler instance.
9
- * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
10
- */
11
- onUnmount?: (throttler: PreactAsyncThrottler<TFn, TSelected>) => void;
12
- }
13
- interface PreactAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncThrottler<TFn>, 'store'> {
14
- /**
15
- * A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state.
16
- *
17
- * This is useful for opting into state re-renders for specific parts of the throttler state
18
- * deep in your component tree without needing to pass a selector to the hook.
19
- *
20
- * @example
21
- * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
22
- * {({ isPending }) => (
23
- * <div>{isPending ? 'Loading...' : 'Ready'}</div>
24
- * )}
25
- * </throttler.Subscribe>
26
- */
27
- Subscribe: <TSelected>(props: {
28
- selector: (state: AsyncThrottlerState<TFn>) => TSelected;
29
- children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
30
- }) => ComponentChildren;
31
- /**
32
- * Reactive state that will be updated and re-rendered when the throttler state changes
33
- *
34
- * Use this instead of `throttler.store.state`
35
- */
36
- readonly state: Readonly<TSelected>;
37
- /**
38
- * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
39
- * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
40
- * Although, you can make the state reactive by using the `useSelector` in your own usage.
41
- */
42
- readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>;
43
- }
44
- /**
45
- * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
46
- *
47
- * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
48
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
49
- *
50
- * Async throttling ensures an async function executes at most once within a specified time window,
51
- * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,
52
- * database operations, or other async tasks.
53
- *
54
- * Unlike the non-async Throttler, this async version supports returning values from the throttled function,
55
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
56
- * instead of setting the result on a state variable from within the throttled function.
57
- *
58
- * Error Handling:
59
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
60
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
61
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
62
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
63
- * - The error state can be checked using the underlying AsyncThrottler instance
64
- *
65
- * ## State Management and Selector
66
- *
67
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
68
- * in two ways:
69
- *
70
- * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
71
- *
72
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
73
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
74
- * in child components.
75
- *
76
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
77
- *
78
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
79
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
80
- * state changes occur.
81
- *
82
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
83
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
84
- * re-renders and gives you full control over when your component updates.
85
- *
86
- * Available state properties:
87
- * - `errorCount`: Number of function executions that have resulted in errors
88
- * - `isExecuting`: Whether the throttled function is currently executing asynchronously
89
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
90
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
91
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
92
- * - `lastResult`: The result from the most recent successful function execution
93
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
94
- * - `settleCount`: Number of function executions that have completed (success or error)
95
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
96
- * - `successCount`: Number of function executions that have completed successfully
97
- *
98
- * ## Unmount behavior
99
- *
100
- * By default, the hook cancels any pending execution and aborts any in-flight execution when the component unmounts.
101
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
102
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
103
- *
104
- * ```tsx
105
- * const throttler = useAsyncThrottler(fn, {
106
- * wait: 1000,
107
- * onUnmount: (t) => t.flush()
108
- * });
109
- * ```
110
- *
111
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
112
- * If your throttled function updates Preact state, those updates may run after the component has
113
- * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
114
- * accordingly when using onUnmount with flush.
115
- *
116
- * @example
117
- * ```tsx
118
- * // Default behavior - no reactive state subscriptions
119
- * const asyncThrottler = useAsyncThrottler(
120
- * async (id: string) => {
121
- * const data = await api.fetchData(id);
122
- * return data; // Return value is preserved
123
- * },
124
- * { wait: 1000 }
125
- * );
126
- *
127
- * // Subscribe to state changes deep in component tree using Subscribe HOC
128
- * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
129
- * {({ isPending }) => (
130
- * <div>{isPending ? 'Processing...' : 'Ready'}</div>
131
- * )}
132
- * </asyncThrottler.Subscribe>
133
- *
134
- * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
135
- * const asyncThrottler = useAsyncThrottler(
136
- * async (id: string) => {
137
- * const data = await api.fetchData(id);
138
- * return data;
139
- * },
140
- * { wait: 1000 },
141
- * (state) => ({
142
- * isExecuting: state.isExecuting,
143
- * isPending: state.isPending,
144
- * status: state.status
145
- * })
146
- * );
147
- *
148
- * // Opt-in to re-render when results are available (optimized for data display)
149
- * const asyncThrottler = useAsyncThrottler(
150
- * async (id: string) => {
151
- * const data = await api.fetchData(id);
152
- * return data;
153
- * },
154
- * { wait: 1000 },
155
- * (state) => ({
156
- * lastResult: state.lastResult,
157
- * successCount: state.successCount,
158
- * settleCount: state.settleCount
159
- * })
160
- * );
161
- *
162
- * // Opt-in to re-render when error state changes (optimized for error handling)
163
- * const asyncThrottler = useAsyncThrottler(
164
- * async (id: string) => {
165
- * const data = await api.fetchData(id);
166
- * return data;
167
- * },
168
- * {
169
- * wait: 1000,
170
- * onError: (error) => console.error('API call failed:', error)
171
- * },
172
- * (state) => ({
173
- * errorCount: state.errorCount,
174
- * status: state.status
175
- * })
176
- * );
177
- *
178
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
179
- * const asyncThrottler = useAsyncThrottler(
180
- * async (id: string) => {
181
- * const data = await api.fetchData(id);
182
- * return data;
183
- * },
184
- * { wait: 1000 },
185
- * (state) => ({
186
- * lastExecutionTime: state.lastExecutionTime,
187
- * nextExecutionTime: state.nextExecutionTime
188
- * })
189
- * );
190
- *
191
- * // With state management and return value
192
- * const [data, setData] = useState(null);
193
- * const { maybeExecute, state } = useAsyncThrottler(
194
- * async (query) => {
195
- * const result = await searchAPI(query);
196
- * setData(result);
197
- * return result; // Return value can be used by the caller
198
- * },
199
- * {
200
- * wait: 2000,
201
- * leading: true, // Execute immediately on first call
202
- * trailing: false // Skip trailing edge updates
203
- * }
204
- * );
205
- *
206
- * // Access the selected state (will be empty object {} unless selector provided)
207
- * const { isExecuting, lastResult } = state;
208
- * ```
209
- */
210
- declare function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncThrottlerOptions<TFn, TSelected>, selector?: (state: AsyncThrottlerState<TFn>) => TSelected): PreactAsyncThrottler<TFn, TSelected>;
211
- //#endregion
212
- export { PreactAsyncThrottler, PreactAsyncThrottlerOptions, useAsyncThrottler };
213
- //# sourceMappingURL=useAsyncThrottler.d.cts.map