@tanstack/pacer 0.22.0 → 0.23.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 (100) hide show
  1. package/README.md +4 -4
  2. package/dist/async-batcher.d.ts +11 -13
  3. package/dist/async-batcher.js +185 -131
  4. package/dist/async-debouncer.d.ts +6 -8
  5. package/dist/async-debouncer.js +186 -142
  6. package/dist/async-queuer.d.ts +11 -13
  7. package/dist/async-queuer.js +383 -290
  8. package/dist/async-rate-limiter.d.ts +6 -8
  9. package/dist/async-rate-limiter.js +197 -143
  10. package/dist/async-retryer.d.ts +6 -8
  11. package/dist/async-retryer.js +209 -179
  12. package/dist/async-throttler.d.ts +6 -8
  13. package/dist/async-throttler.js +214 -157
  14. package/dist/batcher.d.ts +5 -7
  15. package/dist/batcher.js +107 -87
  16. package/dist/debouncer.d.ts +6 -8
  17. package/dist/debouncer.js +99 -86
  18. package/dist/event-client.d.ts +8 -10
  19. package/dist/event-client.js +1 -2
  20. package/dist/queuer.d.ts +7 -9
  21. package/dist/queuer.js +277 -212
  22. package/dist/rate-limiter.d.ts +6 -8
  23. package/dist/rate-limiter.js +127 -109
  24. package/dist/throttler.d.ts +6 -8
  25. package/dist/throttler.js +127 -90
  26. package/dist/types.d.ts +4 -6
  27. package/dist/utils.d.ts +3 -5
  28. package/dist/utils.js +1 -2
  29. package/package.json +21 -68
  30. package/dist/async-batcher.cjs +0 -337
  31. package/dist/async-batcher.cjs.map +0 -1
  32. package/dist/async-batcher.d.cts +0 -343
  33. package/dist/async-batcher.js.map +0 -1
  34. package/dist/async-debouncer.cjs +0 -327
  35. package/dist/async-debouncer.cjs.map +0 -1
  36. package/dist/async-debouncer.d.cts +0 -299
  37. package/dist/async-debouncer.js.map +0 -1
  38. package/dist/async-queuer.cjs +0 -516
  39. package/dist/async-queuer.cjs.map +0 -1
  40. package/dist/async-queuer.d.cts +0 -440
  41. package/dist/async-queuer.js.map +0 -1
  42. package/dist/async-rate-limiter.cjs +0 -370
  43. package/dist/async-rate-limiter.cjs.map +0 -1
  44. package/dist/async-rate-limiter.d.cts +0 -356
  45. package/dist/async-rate-limiter.js.map +0 -1
  46. package/dist/async-retryer.cjs +0 -365
  47. package/dist/async-retryer.cjs.map +0 -1
  48. package/dist/async-retryer.d.cts +0 -321
  49. package/dist/async-retryer.js.map +0 -1
  50. package/dist/async-throttler.cjs +0 -344
  51. package/dist/async-throttler.cjs.map +0 -1
  52. package/dist/async-throttler.d.cts +0 -319
  53. package/dist/async-throttler.js.map +0 -1
  54. package/dist/batcher.cjs +0 -200
  55. package/dist/batcher.cjs.map +0 -1
  56. package/dist/batcher.d.cts +0 -179
  57. package/dist/batcher.js.map +0 -1
  58. package/dist/debouncer.cjs +0 -203
  59. package/dist/debouncer.cjs.map +0 -1
  60. package/dist/debouncer.d.cts +0 -166
  61. package/dist/debouncer.js.map +0 -1
  62. package/dist/event-client.cjs +0 -64
  63. package/dist/event-client.cjs.map +0 -1
  64. package/dist/event-client.d.cts +0 -65
  65. package/dist/event-client.js.map +0 -1
  66. package/dist/index.cjs +0 -52
  67. package/dist/index.d.cts +0 -15
  68. package/dist/queuer.cjs +0 -406
  69. package/dist/queuer.cjs.map +0 -1
  70. package/dist/queuer.d.cts +0 -345
  71. package/dist/queuer.js.map +0 -1
  72. package/dist/rate-limiter.cjs +0 -263
  73. package/dist/rate-limiter.cjs.map +0 -1
  74. package/dist/rate-limiter.d.cts +0 -214
  75. package/dist/rate-limiter.js.map +0 -1
  76. package/dist/throttler.cjs +0 -215
  77. package/dist/throttler.cjs.map +0 -1
  78. package/dist/throttler.d.cts +0 -206
  79. package/dist/throttler.js.map +0 -1
  80. package/dist/types.cjs +0 -0
  81. package/dist/types.d.cts +0 -13
  82. package/dist/utils.cjs +0 -13
  83. package/dist/utils.cjs.map +0 -1
  84. package/dist/utils.d.cts +0 -7
  85. package/dist/utils.js.map +0 -1
  86. package/src/async-batcher.ts +0 -594
  87. package/src/async-debouncer.ts +0 -566
  88. package/src/async-queuer.ts +0 -988
  89. package/src/async-rate-limiter.ts +0 -648
  90. package/src/async-retryer.ts +0 -673
  91. package/src/async-throttler.ts +0 -634
  92. package/src/batcher.ts +0 -329
  93. package/src/debouncer.ts +0 -334
  94. package/src/event-client.ts +0 -129
  95. package/src/index.ts +0 -24
  96. package/src/queuer.ts +0 -751
  97. package/src/rate-limiter.ts +0 -429
  98. package/src/throttler.ts +0 -380
  99. package/src/types.ts +0 -12
  100. package/src/utils.ts +0 -12
@@ -1,319 +0,0 @@
1
- import { AnyAsyncFunction } from "./types.cjs";
2
- import { AsyncRetryer, AsyncRetryerOptions } from "./async-retryer.cjs";
3
- import { Store } from "@tanstack/store";
4
- //#region src/async-throttler.d.ts
5
- interface AsyncThrottlerState<TFn extends AnyAsyncFunction> {
6
- /**
7
- * Number of function executions that have resulted in errors
8
- */
9
- errorCount: number;
10
- /**
11
- * Whether the throttled function is currently executing asynchronously
12
- */
13
- isExecuting: boolean;
14
- /**
15
- * Whether the throttler is waiting for the timeout to trigger execution
16
- */
17
- isPending: boolean;
18
- /**
19
- * The arguments from the most recent call to maybeExecute
20
- */
21
- lastArgs: Parameters<TFn> | undefined;
22
- /**
23
- * Timestamp of the last function execution in milliseconds
24
- */
25
- lastExecutionTime: number;
26
- /**
27
- * The result from the most recent successful function execution
28
- */
29
- lastResult: Awaited<ReturnType<TFn>> | undefined;
30
- /**
31
- * Number of times maybeExecute has been called (for reduction calculations)
32
- */
33
- maybeExecuteCount: number;
34
- /**
35
- * Timestamp when the next execution can occur in milliseconds
36
- */
37
- nextExecutionTime: number | undefined;
38
- /**
39
- * Number of function executions that have completed (either successfully or with errors)
40
- */
41
- settleCount: number;
42
- /**
43
- * Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed
44
- */
45
- status: 'disabled' | 'idle' | 'pending' | 'executing' | 'settled';
46
- /**
47
- * Number of function executions that have completed successfully
48
- */
49
- successCount: number;
50
- }
51
- /**
52
- * Options for configuring an async throttled function
53
- */
54
- interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
55
- /**
56
- * Options for configuring the underlying async retryer
57
- */
58
- asyncRetryerOptions?: AsyncRetryerOptions<TFn>;
59
- /**
60
- * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
61
- * Can be a boolean or a function that returns a boolean.
62
- * Defaults to true.
63
- */
64
- enabled?: boolean | ((throttler: AsyncThrottler<TFn>) => boolean);
65
- /**
66
- * Initial state for the async throttler
67
- */
68
- initialState?: Partial<AsyncThrottlerState<TFn>>;
69
- /**
70
- * Optional key to identify this async throttler instance.
71
- * If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable.
72
- */
73
- key?: string;
74
- /**
75
- * Whether to execute the function immediately when called
76
- * Defaults to true
77
- */
78
- leading?: boolean;
79
- /**
80
- * Optional error handler for when the throttled function throws.
81
- * If provided, the handler will be called with the error and throttler instance.
82
- * This can be used alongside throwOnError - the handler will be called before any error is thrown.
83
- */
84
- onError?: (error: Error, args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
85
- /**
86
- * Optional function to call when the throttled function is executed
87
- */
88
- onSettled?: (args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
89
- /**
90
- * Optional function to call when the throttled function is executed
91
- */
92
- onSuccess?: (result: Awaited<ReturnType<TFn>>, args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
93
- /**
94
- * Whether to throw errors when they occur.
95
- * Defaults to true if no onError handler is provided, false if an onError handler is provided.
96
- * Can be explicitly set to override these defaults.
97
- */
98
- throwOnError?: boolean;
99
- /**
100
- * Whether to execute the function on the trailing edge of the wait period
101
- * Defaults to true
102
- */
103
- trailing?: boolean;
104
- /**
105
- * Time window in milliseconds during which the function can only be executed once.
106
- * Can be a number or a function that returns a number.
107
- * Defaults to 0ms
108
- */
109
- wait: number | ((throttler: AsyncThrottler<TFn>) => number);
110
- }
111
- /**
112
- * Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances.
113
- */
114
- declare function asyncThrottlerOptions<TFn extends AnyAsyncFunction = AnyAsyncFunction, TOptions extends Partial<AsyncThrottlerOptions<TFn>> = Partial<AsyncThrottlerOptions<TFn>>>(options: TOptions): TOptions;
115
- /**
116
- * A class that creates an async throttled function.
117
- *
118
- * Async vs Sync Versions:
119
- * The async version provides advanced features over the sync Throttler:
120
- * - Returns promises that can be awaited for throttled function results
121
- * - Built-in retry support via AsyncRetryer integration
122
- * - Abort support to cancel in-flight executions
123
- * - Cancel support to prevent pending executions from starting
124
- * - Comprehensive error handling with onError callbacks and throwOnError control
125
- * - Detailed execution tracking (success/error/settle counts)
126
- * - Waits for ongoing executions to complete before scheduling the next one
127
- *
128
- * The sync Throttler is lighter weight and simpler when you don't need async features,
129
- * return values, or execution control.
130
- *
131
- * What is Throttling?
132
- * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
133
- * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
134
- * regular interval regardless of how often it's called.
135
- *
136
- * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to
137
- * ensure a maximum execution frequency.
138
- *
139
- * Error Handling:
140
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
141
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
142
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
143
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
144
- * - The error state can be checked using the underlying AsyncThrottler instance
145
- *
146
- * State Management:
147
- * - Uses TanStack Store for reactive state management
148
- * - Use `initialState` to provide initial state values when creating the async throttler
149
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
150
- * - Use `onError` callback to react to function execution errors and implement custom error handling
151
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
152
- * - The state includes error count, execution status, last execution time, and success/settle counts
153
- * - State can be accessed via `asyncThrottler.store.state` when using the class directly
154
- * - When using framework adapters (React/Solid), state is accessed from `asyncThrottler.state`
155
- *
156
- * @example
157
- * ```ts
158
- * const throttler = new AsyncThrottler(async (value: string) => {
159
- * const result = await saveToAPI(value);
160
- * return result; // Return value is preserved
161
- * }, {
162
- * wait: 1000,
163
- * onError: (error) => {
164
- * console.error('API call failed:', error);
165
- * }
166
- * });
167
- *
168
- * // Will only execute once per second no matter how often called
169
- * // Returns the API response directly
170
- * const result = await throttler.maybeExecute(inputElement.value);
171
- * ```
172
- */
173
- declare class AsyncThrottler<TFn extends AnyAsyncFunction> {
174
- #private;
175
- fn: TFn;
176
- readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>;
177
- key: string | undefined;
178
- options: AsyncThrottlerOptions<TFn>;
179
- asyncRetryers: Map<number, AsyncRetryer<TFn>>;
180
- constructor(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn>);
181
- /**
182
- * Updates the async throttler options
183
- */
184
- setOptions: (newOptions: Partial<AsyncThrottlerOptions<TFn>>) => void;
185
- /**
186
- * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
187
- *
188
- * - If enough time has passed since the last execution (>= wait period):
189
- * - With leading=true: Executes immediately
190
- * - With leading=false: Waits for the next trailing execution
191
- *
192
- * - If within the wait period:
193
- * - With trailing=true: Schedules execution for end of wait period
194
- * - With trailing=false: Drops the execution
195
- *
196
- * @example
197
- * ```ts
198
- * const throttled = new AsyncThrottler(fn, { wait: 1000 });
199
- *
200
- * // First call executes immediately
201
- * await throttled.maybeExecute('a', 'b');
202
- *
203
- * // Call during wait period - gets throttled
204
- * await throttled.maybeExecute('c', 'd');
205
- * ```
206
- */
207
- maybeExecute: (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
208
- /**
209
- * Processes the current pending execution immediately
210
- */
211
- flush: () => Promise<Awaited<ReturnType<TFn>> | undefined>;
212
- /**
213
- * Returns the AbortSignal for a specific execution.
214
- * If no maybeExecuteCount is provided, returns the signal for the most recent execution.
215
- * Returns null if no execution is found or not currently executing.
216
- *
217
- * @param maybeExecuteCount - Optional specific execution to get signal for
218
- * @example
219
- * ```typescript
220
- * const throttler = new AsyncThrottler(
221
- * async (data: string) => {
222
- * const signal = throttler.getAbortSignal()
223
- * if (signal) {
224
- * const response = await fetch('/api/save', {
225
- * method: 'POST',
226
- * body: data,
227
- * signal
228
- * })
229
- * return response.json()
230
- * }
231
- * },
232
- * { wait: 1000 }
233
- * )
234
- * ```
235
- */
236
- getAbortSignal: (maybeExecuteCount?: number) => AbortSignal | null;
237
- /**
238
- * Aborts all ongoing executions with the internal abort controllers.
239
- * Does NOT cancel any pending execution that have not started yet.
240
- */
241
- abort: () => void;
242
- /**
243
- * Cancels any pending execution that have not started yet.
244
- * Does NOT abort any execution already in progress.
245
- */
246
- cancel: () => void;
247
- /**
248
- * Resets the debouncer state to its default values
249
- */
250
- reset: () => void;
251
- }
252
- /**
253
- * Creates an async throttled function that limits how often the function can execute.
254
- * The throttled function will execute at most once per wait period, even if called multiple times.
255
- * If called while executing, it will wait until execution completes before scheduling the next call.
256
- *
257
- * Async vs Sync Versions:
258
- * The async version provides advanced features over the sync throttle function:
259
- * - Returns promises that can be awaited for throttled function results
260
- * - Built-in retry support via AsyncRetryer integration
261
- * - Abort support to cancel in-flight executions
262
- * - Cancel support to prevent pending executions from starting
263
- * - Comprehensive error handling with onError callbacks and throwOnError control
264
- * - Detailed execution tracking (success/error/settle counts)
265
- * - Waits for ongoing executions to complete before scheduling the next one
266
- *
267
- * The sync throttle function is lighter weight and simpler when you don't need async features,
268
- * return values, or execution control.
269
- *
270
- * What is Throttling?
271
- * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
272
- * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
273
- * regular interval regardless of how often it's called.
274
- *
275
- * Configuration Options:
276
- * - `wait`: Time window in milliseconds during which the function can only execute once (required)
277
- * - `leading`: Execute immediately when called (default: true)
278
- * - `trailing`: Execute on the trailing edge of the wait period (default: true)
279
- * - `enabled`: Whether the throttler is enabled (default: true)
280
- * - `asyncRetryerOptions`: Configure retry behavior for executions
281
- *
282
- * Error Handling:
283
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
284
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
285
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
286
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
287
- * - The error state can be checked using the underlying AsyncThrottler instance
288
- *
289
- * State Management:
290
- * - Uses TanStack Store for reactive state management
291
- * - Use `initialState` to provide initial state values when creating the async throttler
292
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
293
- * - Use `onError` callback to react to function execution errors and implement custom error handling
294
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
295
- * - The state includes error count, execution status, last execution time, and success/settle counts
296
- * - State can be accessed via the underlying AsyncThrottler instance's `store.state` property
297
- * - When using framework adapters (React/Solid), state is accessed from the hook's state property
298
- *
299
- * @example
300
- * ```ts
301
- * const throttled = asyncThrottle(async (value: string) => {
302
- * const result = await saveToAPI(value);
303
- * return result; // Return value is preserved
304
- * }, {
305
- * wait: 1000,
306
- * onError: (error) => {
307
- * console.error('API call failed:', error);
308
- * }
309
- * });
310
- *
311
- * // This will execute at most once per second
312
- * // Returns the API response directly
313
- * const result = await throttled(inputElement.value);
314
- * ```
315
- */
316
- declare function asyncThrottle<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
317
- //#endregion
318
- export { AsyncThrottler, AsyncThrottlerOptions, AsyncThrottlerState, asyncThrottle, asyncThrottlerOptions };
319
- //# sourceMappingURL=async-throttler.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"async-throttler.js","names":["#getEnabled","#resolvePreviousPromiseInternal","#setState","#getWait","#execute","#resolvePreviousPromise","#timeoutId","#clearTimeout"],"sources":["../src/async-throttler.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { AsyncRetryer } from './async-retryer'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AsyncRetryerOptions } from './async-retryer'\nimport type { AnyAsyncFunction, OptionalKeys } from './types'\n\nexport interface AsyncThrottlerState<TFn extends AnyAsyncFunction> {\n /**\n * Number of function executions that have resulted in errors\n */\n errorCount: number\n /**\n * Whether the throttled function is currently executing asynchronously\n */\n isExecuting: boolean\n /**\n * Whether the throttler is waiting for the timeout to trigger execution\n */\n isPending: boolean\n /**\n * The arguments from the most recent call to maybeExecute\n */\n lastArgs: Parameters<TFn> | undefined\n /**\n * Timestamp of the last function execution in milliseconds\n */\n lastExecutionTime: number\n /**\n * The result from the most recent successful function execution\n */\n lastResult: Awaited<ReturnType<TFn>> | undefined\n /**\n * Number of times maybeExecute has been called (for reduction calculations)\n */\n maybeExecuteCount: number\n /**\n * Timestamp when the next execution can occur in milliseconds\n */\n nextExecutionTime: number | undefined\n /**\n * Number of function executions that have completed (either successfully or with errors)\n */\n settleCount: number\n /**\n * Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed\n */\n status: 'disabled' | 'idle' | 'pending' | 'executing' | 'settled'\n /**\n * Number of function executions that have completed successfully\n */\n successCount: number\n}\n\nfunction getDefaultAsyncThrottlerState<\n TFn extends AnyAsyncFunction,\n>(): AsyncThrottlerState<TFn> {\n return {\n errorCount: 0,\n isExecuting: false,\n isPending: false,\n lastArgs: undefined,\n lastExecutionTime: 0,\n lastResult: undefined,\n maybeExecuteCount: 0,\n nextExecutionTime: undefined,\n settleCount: 0,\n status: 'idle',\n successCount: 0,\n }\n}\n\n/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {\n /**\n * Options for configuring the underlying async retryer\n */\n asyncRetryerOptions?: AsyncRetryerOptions<TFn>\n /**\n * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n * Can be a boolean or a function that returns a boolean.\n * Defaults to true.\n */\n enabled?: boolean | ((throttler: AsyncThrottler<TFn>) => boolean)\n /**\n * Initial state for the async throttler\n */\n initialState?: Partial<AsyncThrottlerState<TFn>>\n /**\n * Optional key to identify this async throttler instance.\n * If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable.\n */\n key?: string\n /**\n * Whether to execute the function immediately when called\n * Defaults to true\n */\n leading?: boolean\n /**\n * Optional error handler for when the throttled function throws.\n * If provided, the handler will be called with the error and throttler instance.\n * This can be used alongside throwOnError - the handler will be called before any error is thrown.\n */\n onError?: (\n error: Error,\n args: Parameters<TFn>,\n asyncThrottler: AsyncThrottler<TFn>,\n ) => void\n /**\n * Optional function to call when the throttled function is executed\n */\n onSettled?: (\n args: Parameters<TFn>,\n asyncThrottler: AsyncThrottler<TFn>,\n ) => void\n /**\n * Optional function to call when the throttled function is executed\n */\n onSuccess?: (\n result: Awaited<ReturnType<TFn>>,\n args: Parameters<TFn>,\n asyncThrottler: AsyncThrottler<TFn>,\n ) => void\n /**\n * Whether to throw errors when they occur.\n * Defaults to true if no onError handler is provided, false if an onError handler is provided.\n * Can be explicitly set to override these defaults.\n */\n throwOnError?: boolean\n /**\n * Whether to execute the function on the trailing edge of the wait period\n * Defaults to true\n */\n trailing?: boolean\n /**\n * Time window in milliseconds during which the function can only be executed once.\n * Can be a number or a function that returns a number.\n * Defaults to 0ms\n */\n wait: number | ((throttler: AsyncThrottler<TFn>) => number)\n}\n\n/**\n * Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances.\n */\nexport function asyncThrottlerOptions<\n TFn extends AnyAsyncFunction = AnyAsyncFunction,\n TOptions extends Partial<AsyncThrottlerOptions<TFn>> = Partial<\n AsyncThrottlerOptions<TFn>\n >,\n>(options: TOptions): TOptions {\n return options\n}\n\ntype AsyncThrottlerOptionsWithOptionalCallbacks = OptionalKeys<\n AsyncThrottlerOptions<any>,\n 'initialState' | 'onError' | 'onSettled' | 'onSuccess'\n>\n\nconst defaultOptions: AsyncThrottlerOptionsWithOptionalCallbacks = {\n asyncRetryerOptions: {\n maxAttempts: 1,\n },\n enabled: true,\n leading: true,\n trailing: true,\n wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync Throttler:\n * - Returns promises that can be awaited for throttled function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Cancel support to prevent pending executions from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n * - Waits for ongoing executions to complete before scheduling the next one\n *\n * The sync Throttler is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Throttling?\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\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:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the async throttler\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - The state includes error count, execution status, last execution time, and success/settle counts\n * - State can be accessed via `asyncThrottler.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `asyncThrottler.state`\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n * const result = await saveToAPI(value);\n * return result; // Return value is preserved\n * }, {\n * wait: 1000,\n * onError: (error) => {\n * console.error('API call failed:', error);\n * }\n * });\n *\n * // Will only execute once per second no matter how often called\n * // Returns the API response directly\n * const result = await throttler.maybeExecute(inputElement.value);\n * ```\n */\nexport class AsyncThrottler<TFn extends AnyAsyncFunction> {\n readonly store: Store<Readonly<AsyncThrottlerState<TFn>>> = new Store<\n AsyncThrottlerState<TFn>\n >(getDefaultAsyncThrottlerState<TFn>())\n key: string | undefined\n options: AsyncThrottlerOptions<TFn>\n asyncRetryers = new Map<number, AsyncRetryer<TFn>>()\n #timeoutId: ReturnType<typeof setTimeout> | null = null\n #resolvePreviousPromise:\n ((value?: Awaited<ReturnType<TFn>> | undefined) => void) | null = null\n\n constructor(\n public fn: TFn,\n initialOptions: AsyncThrottlerOptions<TFn>,\n ) {\n this.key = initialOptions.key\n this.options = {\n ...defaultOptions,\n ...initialOptions,\n throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n }\n this.#setState(this.options.initialState ?? {})\n\n if (this.key) {\n pacerEventClient.on('d-AsyncThrottler', (event) => {\n if (event.payload.key !== this.key) return\n this.#setState(\n event.payload.store.state as Partial<AsyncThrottlerState<TFn>>,\n )\n this.setOptions(\n event.payload.options as Partial<AsyncThrottlerOptions<TFn>>,\n )\n })\n }\n }\n\n /**\n * Updates the async throttler options\n */\n setOptions = (newOptions: Partial<AsyncThrottlerOptions<TFn>>): void => {\n this.options = { ...this.options, ...newOptions }\n\n // End the pending state if the throttler is disabled\n if (!this.#getEnabled()) {\n this.cancel()\n }\n }\n\n #setState = (newState: Partial<AsyncThrottlerState<TFn>>): void => {\n this.store.setState((state) => {\n const combinedState = {\n ...state,\n ...newState,\n }\n const { isPending, isExecuting, settleCount } = combinedState\n return {\n ...combinedState,\n status: !this.#getEnabled()\n ? 'disabled'\n : isPending\n ? 'pending'\n : isExecuting\n ? 'executing'\n : settleCount > 0\n ? 'settled'\n : 'idle',\n }\n })\n emitChange('AsyncThrottler', this)\n }\n\n /**\n * Returns the current enabled state of the async throttler\n */\n #getEnabled = (): boolean => {\n return !!parseFunctionOrValue(this.options.enabled, this)\n }\n\n /**\n * Returns the current wait time in milliseconds\n */\n #getWait = (): number => {\n return parseFunctionOrValue(this.options.wait, this)\n }\n\n /**\n * Attempts to execute the throttled function. The execution behavior depends on the throttler options:\n *\n * - If enough time has passed since the last execution (>= wait period):\n * - With leading=true: Executes immediately\n * - With leading=false: Waits for the next trailing execution\n *\n * - If within the wait period:\n * - With trailing=true: Schedules execution for end of wait period\n * - With trailing=false: Drops the execution\n *\n * @example\n * ```ts\n * const throttled = new AsyncThrottler(fn, { wait: 1000 });\n *\n * // First call executes immediately\n * await throttled.maybeExecute('a', 'b');\n *\n * // Call during wait period - gets throttled\n * await throttled.maybeExecute('c', 'd');\n * ```\n */\n maybeExecute = async (\n ...args: Parameters<TFn>\n ): Promise<Awaited<ReturnType<TFn>> | undefined> => {\n if (!this.#getEnabled()) return undefined\n\n this.#resolvePreviousPromiseInternal()\n\n this.#setState({\n maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n lastArgs: args, // store the arguments for potential trailing execution\n })\n\n const wait = this.#getWait()\n const thisMaybeExecuteNumber = this.store.state.maybeExecuteCount\n\n // Wait for the wait period for the previous execution to complete if it's still running\n for (\n let maxNumIterations = wait / 10;\n this.store.state.isExecuting && maxNumIterations > 0;\n maxNumIterations--\n ) {\n await new Promise((resolve) => setTimeout(resolve, 10))\n if (this.store.state.maybeExecuteCount !== thisMaybeExecuteNumber) {\n // cancel the current maybeExecute loop because a new maybeExecute call was made\n return this.store.state.lastResult\n }\n }\n\n const now = Date.now()\n const timeSinceLastExecution = now - this.store.state.lastExecutionTime\n\n if (\n this.options.leading &&\n !this.store.state.isPending &&\n timeSinceLastExecution >= wait\n ) {\n await this.#execute(...args) // Leading EXECUTE!\n } else if (this.options.trailing) {\n // replace old pending execution with a new one\n this.cancel()\n this.#setState({\n isPending: true,\n })\n\n // Set up new trailing execution\n return new Promise<Awaited<ReturnType<TFn>> | undefined>(\n (resolve, reject) => {\n this.#resolvePreviousPromise = resolve\n\n const newTimeSinceLastExecution = this.store.state.lastExecutionTime\n ? now - this.store.state.lastExecutionTime\n : 0\n const timeoutDuration = Math.max(0, wait - newTimeSinceLastExecution)\n\n this.#timeoutId = setTimeout(async () => {\n this.#clearTimeout()\n if (this.store.state.lastArgs !== undefined) {\n try {\n await this.#execute(...this.store.state.lastArgs) // Trailing EXECUTE!\n } catch (error) {\n reject(error)\n }\n }\n this.#resolvePreviousPromise = null\n resolve(this.store.state.lastResult)\n }, timeoutDuration)\n },\n )\n }\n return this.store.state.lastResult\n }\n\n #execute = async (\n ...args: Parameters<TFn>\n ): Promise<Awaited<ReturnType<TFn>> | undefined> => {\n if (!this.#getEnabled()) return undefined\n\n const currentMaybeExecute = this.store.state.maybeExecuteCount\n\n try {\n this.#setState({ isExecuting: true })\n const currentAsyncRetryer = new AsyncRetryer(\n this.fn,\n this.options.asyncRetryerOptions,\n )\n this.asyncRetryers.set(currentMaybeExecute, currentAsyncRetryer)\n const result = await currentAsyncRetryer.execute(...args) // EXECUTE!\n this.#setState({\n lastResult: result,\n successCount: this.store.state.successCount + 1,\n })\n this.options.onSuccess?.(result as Awaited<ReturnType<TFn>>, args, this)\n } catch (error) {\n this.#setState({\n errorCount: this.store.state.errorCount + 1,\n })\n this.options.onError?.(error as Error, args, this)\n if (this.options.throwOnError) {\n throw error\n }\n } finally {\n this.asyncRetryers.delete(currentMaybeExecute) // dispose retryer\n const lastExecutionTime = Date.now()\n const wait = this.#getWait()\n const nextExecutionTime = lastExecutionTime + wait\n this.#setState({\n isExecuting: false,\n isPending: !!this.#timeoutId,\n settleCount: this.store.state.settleCount + 1,\n lastExecutionTime,\n nextExecutionTime,\n })\n this.options.onSettled?.(args, this)\n setTimeout(() => {\n if (!this.store.state.isPending) {\n // clear nextExecutionTime if there is no pending execution\n this.#setState({ nextExecutionTime: undefined })\n }\n }, wait)\n }\n return this.store.state.lastResult\n }\n\n /**\n * Processes the current pending execution immediately\n */\n flush = async (): Promise<Awaited<ReturnType<TFn>> | undefined> => {\n if (this.store.state.isPending && this.store.state.lastArgs) {\n // Store the pending promise resolver before clearing timeout\n const resolvePromise = this.#resolvePreviousPromise\n\n // Clear timeout and state without resolving the promise\n this.#clearTimeout()\n this.#setState({\n isPending: false,\n })\n\n const result = await this.#execute(...this.store.state.lastArgs)\n\n // Resolve the pending promise with the result\n if (resolvePromise) {\n resolvePromise(result)\n }\n\n return result\n }\n return undefined\n }\n\n #resolvePreviousPromiseInternal = (): void => {\n if (this.#resolvePreviousPromise) {\n this.#resolvePreviousPromise(this.store.state.lastResult)\n this.#resolvePreviousPromise = null\n }\n }\n\n #clearTimeout = (): void => {\n if (this.#timeoutId) {\n clearTimeout(this.#timeoutId)\n this.#timeoutId = null\n }\n }\n\n /**\n * Returns the AbortSignal for a specific execution.\n * If no maybeExecuteCount is provided, returns the signal for the most recent execution.\n * Returns null if no execution is found or not currently executing.\n *\n * @param maybeExecuteCount - Optional specific execution to get signal for\n * @example\n * ```typescript\n * const throttler = new AsyncThrottler(\n * async (data: string) => {\n * const signal = throttler.getAbortSignal()\n * if (signal) {\n * const response = await fetch('/api/save', {\n * method: 'POST',\n * body: data,\n * signal\n * })\n * return response.json()\n * }\n * },\n * { wait: 1000 }\n * )\n * ```\n */\n getAbortSignal = (maybeExecuteCount?: number): AbortSignal | null => {\n const count = maybeExecuteCount ?? this.store.state.maybeExecuteCount\n const retryer = this.asyncRetryers.get(count)\n return retryer?.getAbortSignal() ?? null\n }\n\n /**\n * Aborts all ongoing executions with the internal abort controllers.\n * Does NOT cancel any pending execution that have not started yet.\n */\n abort = (): void => {\n this.asyncRetryers.forEach((retryer) => retryer.abort())\n this.asyncRetryers.clear()\n this.#setState({ isExecuting: false })\n }\n\n /**\n * Cancels any pending execution that have not started yet.\n * Does NOT abort any execution already in progress.\n */\n cancel = (): void => {\n this.#clearTimeout()\n if (this.#resolvePreviousPromise) {\n this.#resolvePreviousPromiseInternal()\n this.#resolvePreviousPromise = null\n }\n this.#setState({\n isPending: false,\n })\n }\n\n /**\n * Resets the debouncer state to its default values\n */\n reset = (): void => {\n this.#setState(getDefaultAsyncThrottlerState<TFn>())\n this.asyncRetryers.forEach((retryer) => retryer.reset())\n }\n}\n\n/**\n * Creates an async throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync throttle function:\n * - Returns promises that can be awaited for throttled function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Cancel support to prevent pending executions from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n * - Waits for ongoing executions to complete before scheduling the next one\n *\n * The sync throttle function is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Throttling?\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * Configuration Options:\n * - `wait`: Time window in milliseconds during which the function can only execute once (required)\n * - `leading`: Execute immediately when called (default: true)\n * - `trailing`: Execute on the trailing edge of the wait period (default: true)\n * - `enabled`: Whether the throttler is enabled (default: true)\n * - `asyncRetryerOptions`: Configure retry behavior for executions\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:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the async throttler\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - The state includes error count, execution status, last execution time, and success/settle counts\n * - State can be accessed via the underlying AsyncThrottler instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * @example\n * ```ts\n * const throttled = asyncThrottle(async (value: string) => {\n * const result = await saveToAPI(value);\n * return result; // Return value is preserved\n * }, {\n * wait: 1000,\n * onError: (error) => {\n * console.error('API call failed:', error);\n * }\n * });\n *\n * // This will execute at most once per second\n * // Returns the API response directly\n * const result = await throttled(inputElement.value);\n * ```\n */\nexport function asyncThrottle<TFn extends AnyAsyncFunction>(\n fn: TFn,\n initialOptions: AsyncThrottlerOptions<TFn>,\n) {\n const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n return asyncThrottler.maybeExecute\n}\n"],"mappings":";;;;;;AAsDA,SAAS,gCAEqB;CAC5B,OAAO;EACL,YAAY;EACZ,aAAa;EACb,WAAW;EACX,UAAU;EACV,mBAAmB;EACnB,YAAY;EACZ,mBAAmB;EACnB,mBAAmB;EACnB,aAAa;EACb,QAAQ;EACR,cAAc;CAChB;AACF;;;;AA6EA,SAAgB,sBAKd,SAA6B;CAC7B,OAAO;AACT;AAOA,MAAM,iBAA6D;CACjE,qBAAqB,EACnB,aAAa,EACf;CACA,SAAS;CACT,SAAS;CACT,UAAU;CACV,MAAM;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,IAAa,iBAAb,MAA0D;CAOxD;CACA;CAGA,YACE,AAAO,IACP,gBACA;EAFO;eAXmD,IAAI,MAE9D,8BAAmC,CAAC;uCAGtB,IAAI,IAA+B;oBACA;iCAEiB;qBA8BtD,eAA0D;GACtE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;GAAW;GAGhD,IAAI,CAAC,KAAKA,YAAY,GACpB,KAAK,OAAO;EAEhB;oBAEa,aAAsD;GACjE,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;IACL;IACA,MAAM,EAAE,WAAW,aAAa,gBAAgB;IAChD,OAAO;KACL,GAAG;KACH,QAAQ,CAAC,KAAKA,YAAY,IACtB,aACA,YACE,YACA,cACE,cACA,cAAc,IACZ,YACA;IACZ;GACF,CAAC;GACD,WAAW,kBAAkB,IAAI;EACnC;2BAK6B;GAC3B,OAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,IAAI;EAC1D;wBAKyB;GACvB,OAAO,qBAAqB,KAAK,QAAQ,MAAM,IAAI;EACrD;sBAwBe,OACb,GAAG,SAC+C;GAClD,IAAI,CAAC,KAAKA,YAAY,GAAG,OAAO;GAEhC,KAAKC,gCAAgC;GAErC,KAAKC,UAAU;IACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB;IACxD,UAAU;GACZ,CAAC;GAED,MAAM,OAAO,KAAKC,SAAS;GAC3B,MAAM,yBAAyB,KAAK,MAAM,MAAM;GAGhD,KACE,IAAI,mBAAmB,OAAO,IAC9B,KAAK,MAAM,MAAM,eAAe,mBAAmB,GACnD,oBACA;IACA,MAAM,IAAI,SAAS,YAAY,WAAW,SAAS,EAAE,CAAC;IACtD,IAAI,KAAK,MAAM,MAAM,sBAAsB,wBAEzC,OAAO,KAAK,MAAM,MAAM;GAE5B;GAEA,MAAM,MAAM,KAAK,IAAI;GACrB,MAAM,yBAAyB,MAAM,KAAK,MAAM,MAAM;GAEtD,IACE,KAAK,QAAQ,WACb,CAAC,KAAK,MAAM,MAAM,aAClB,0BAA0B,MAE1B,MAAM,KAAKC,SAAS,GAAG,IAAI;QACtB,IAAI,KAAK,QAAQ,UAAU;IAEhC,KAAK,OAAO;IACZ,KAAKF,UAAU,EACb,WAAW,KACb,CAAC;IAGD,OAAO,IAAI,SACR,SAAS,WAAW;KACnB,KAAKG,0BAA0B;KAE/B,MAAM,4BAA4B,KAAK,MAAM,MAAM,oBAC/C,MAAM,KAAK,MAAM,MAAM,oBACvB;KACJ,MAAM,kBAAkB,KAAK,IAAI,GAAG,OAAO,yBAAyB;KAEpE,KAAKC,aAAa,WAAW,YAAY;MACvC,KAAKC,cAAc;MACnB,IAAI,KAAK,MAAM,MAAM,aAAa,QAChC,IAAI;OACF,MAAM,KAAKH,SAAS,GAAG,KAAK,MAAM,MAAM,QAAQ;MAClD,SAAS,OAAO;OACd,OAAO,KAAK;MACd;MAEF,KAAKC,0BAA0B;MAC/B,QAAQ,KAAK,MAAM,MAAM,UAAU;KACrC,GAAG,eAAe;IACpB,CACF;GACF;GACA,OAAO,KAAK,MAAM,MAAM;EAC1B;kBAEW,OACT,GAAG,SAC+C;GAClD,IAAI,CAAC,KAAKL,YAAY,GAAG,OAAO;GAEhC,MAAM,sBAAsB,KAAK,MAAM,MAAM;GAE7C,IAAI;IACF,KAAKE,UAAU,EAAE,aAAa,KAAK,CAAC;IACpC,MAAM,sBAAsB,IAAI,aAC9B,KAAK,IACL,KAAK,QAAQ,mBACf;IACA,KAAK,cAAc,IAAI,qBAAqB,mBAAmB;IAC/D,MAAM,SAAS,MAAM,oBAAoB,QAAQ,GAAG,IAAI;IACxD,KAAKA,UAAU;KACb,YAAY;KACZ,cAAc,KAAK,MAAM,MAAM,eAAe;IAChD,CAAC;IACD,KAAK,QAAQ,YAAY,QAAoC,MAAM,IAAI;GACzE,SAAS,OAAO;IACd,KAAKA,UAAU,EACb,YAAY,KAAK,MAAM,MAAM,aAAa,EAC5C,CAAC;IACD,KAAK,QAAQ,UAAU,OAAgB,MAAM,IAAI;IACjD,IAAI,KAAK,QAAQ,cACf,MAAM;GAEV,UAAU;IACR,KAAK,cAAc,OAAO,mBAAmB;IAC7C,MAAM,oBAAoB,KAAK,IAAI;IACnC,MAAM,OAAO,KAAKC,SAAS;IAC3B,MAAM,oBAAoB,oBAAoB;IAC9C,KAAKD,UAAU;KACb,aAAa;KACb,WAAW,CAAC,CAAC,KAAKI;KAClB,aAAa,KAAK,MAAM,MAAM,cAAc;KAC5C;KACA;IACF,CAAC;IACD,KAAK,QAAQ,YAAY,MAAM,IAAI;IACnC,iBAAiB;KACf,IAAI,CAAC,KAAK,MAAM,MAAM,WAEpB,KAAKJ,UAAU,EAAE,mBAAmB,OAAU,CAAC;IAEnD,GAAG,IAAI;GACT;GACA,OAAO,KAAK,MAAM,MAAM;EAC1B;eAKQ,YAA2D;GACjE,IAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;IAE3D,MAAM,iBAAiB,KAAKG;IAG5B,KAAKE,cAAc;IACnB,KAAKL,UAAU,EACb,WAAW,MACb,CAAC;IAED,MAAM,SAAS,MAAM,KAAKE,SAAS,GAAG,KAAK,MAAM,MAAM,QAAQ;IAG/D,IAAI,gBACF,eAAe,MAAM;IAGvB,OAAO;GACT;EAEF;+CAE8C;GAC5C,IAAI,KAAKC,yBAAyB;IAChC,KAAKA,wBAAwB,KAAK,MAAM,MAAM,UAAU;IACxD,KAAKA,0BAA0B;GACjC;EACF;6BAE4B;GAC1B,IAAI,KAAKC,YAAY;IACnB,aAAa,KAAKA,UAAU;IAC5B,KAAKA,aAAa;GACpB;EACF;yBA0BkB,sBAAmD;GACnE,MAAM,QAAQ,qBAAqB,KAAK,MAAM,MAAM;GAEpD,OADgB,KAAK,cAAc,IAAI,KAC1B,CAAC,EAAE,eAAe,KAAK;EACtC;qBAMoB;GAClB,KAAK,cAAc,SAAS,YAAY,QAAQ,MAAM,CAAC;GACvD,KAAK,cAAc,MAAM;GACzB,KAAKJ,UAAU,EAAE,aAAa,MAAM,CAAC;EACvC;sBAMqB;GACnB,KAAKK,cAAc;GACnB,IAAI,KAAKF,yBAAyB;IAChC,KAAKJ,gCAAgC;IACrC,KAAKI,0BAA0B;GACjC;GACA,KAAKH,UAAU,EACb,WAAW,MACb,CAAC;EACH;qBAKoB;GAClB,KAAKA,UAAU,8BAAmC,CAAC;GACnD,KAAK,cAAc,SAAS,YAAY,QAAQ,MAAM,CAAC;EACzD;EA5TE,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;GACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;EAC/D;EACA,KAAKA,UAAU,KAAK,QAAQ,gBAAgB,CAAC,CAAC;EAE9C,IAAI,KAAK,KACP,iBAAiB,GAAG,qBAAqB,UAAU;GACjD,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKA,UACH,MAAM,QAAQ,MAAM,KACtB;GACA,KAAK,WACH,MAAM,QAAQ,OAChB;EACF,CAAC;CAEL;CAcA;;;;CA0BA;;;;CAOA;CAkGA;CA6EA;CAOA;AAqEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,SAAgB,cACd,IACA,gBACA;CAEA,OAAO,IADoB,eAAe,IAAI,cAC1B,CAAC,CAAC;AACxB"}
package/dist/batcher.cjs DELETED
@@ -1,200 +0,0 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
- const require_utils = require('./utils.cjs');
3
- const require_event_client = require('./event-client.cjs');
4
- let _tanstack_store = require("@tanstack/store");
5
-
6
- //#region src/batcher.ts
7
- function getDefaultBatcherState() {
8
- return {
9
- executionCount: 0,
10
- isEmpty: true,
11
- isPending: false,
12
- totalItemsProcessed: 0,
13
- items: [],
14
- size: 0,
15
- status: "idle"
16
- };
17
- }
18
- const defaultOptions = {
19
- getShouldExecute: () => false,
20
- maxSize: Infinity,
21
- started: true,
22
- wait: Infinity
23
- };
24
- /**
25
- * A class that collects items and processes them in batches.
26
- *
27
- * Batching is a technique for grouping multiple operations together to be processed as a single unit.
28
- * This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
29
- *
30
- * The Batcher provides a flexible way to implement batching with configurable:
31
- * - Maximum batch size (number of items per batch)
32
- * - Time-based batching (process after X milliseconds)
33
- * - Custom batch processing logic via getShouldExecute
34
- * - Event callbacks for monitoring batch operations
35
- *
36
- * State Management:
37
- * - Uses TanStack Store for reactive state management
38
- * - Use `initialState` to provide initial state values when creating the batcher
39
- * - Use `onExecute` callback to react to batch execution and implement custom logic
40
- * - Use `onItemsChange` callback to react to items being added or removed from the batcher
41
- * - The state includes batch execution count, total items processed, items, and running status
42
- * - State can be accessed via `batcher.store.state` when using the class directly
43
- * - When using framework adapters (React/Solid), state is accessed from `batcher.state`
44
- *
45
- * @example
46
- * ```ts
47
- * const batcher = new Batcher<number>(
48
- * (items) => console.log('Processing batch:', items),
49
- * {
50
- * maxSize: 5,
51
- * wait: 2000,
52
- * onExecute: (batch, batcher) => console.log('Batch executed:', batch)
53
- * }
54
- * );
55
- *
56
- * batcher.addItem(1);
57
- * batcher.addItem(2);
58
- * // After 2 seconds or when 5 items are added, whichever comes first,
59
- * // the batch will be processed
60
- * // batcher.flush() // manually trigger a batch
61
- * ```
62
- */
63
- var Batcher = class {
64
- #timeoutId;
65
- constructor(fn, initialOptions) {
66
- this.fn = fn;
67
- this.store = new _tanstack_store.Store(getDefaultBatcherState());
68
- this.#timeoutId = null;
69
- this.setOptions = (newOptions) => {
70
- this.options = {
71
- ...this.options,
72
- ...newOptions
73
- };
74
- };
75
- this.#setState = (newState) => {
76
- this.store.setState((state) => {
77
- const combinedState = {
78
- ...state,
79
- ...newState
80
- };
81
- const { isPending, items } = combinedState;
82
- const size = items.length;
83
- const isEmpty = size === 0;
84
- return {
85
- ...combinedState,
86
- isEmpty,
87
- size,
88
- status: isPending ? "pending" : "idle"
89
- };
90
- });
91
- require_event_client.emitChange("Batcher", this);
92
- };
93
- this.#getWait = () => {
94
- return require_utils.parseFunctionOrValue(this.options.wait, this);
95
- };
96
- this.addItem = (item) => {
97
- this.#setState({
98
- items: [...this.store.state.items, item],
99
- isPending: this.options.wait !== Infinity
100
- });
101
- this.options.onItemsChange?.(this);
102
- if (this.store.state.items.length >= this.options.maxSize || this.options.getShouldExecute(this.store.state.items, this)) this.#execute();
103
- else if (this.options.wait !== Infinity) {
104
- this.#clearTimeout();
105
- this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
106
- }
107
- };
108
- this.#execute = () => {
109
- if (this.store.state.items.length === 0) return;
110
- const batch = this.peekAllItems();
111
- this.clear();
112
- this.options.onItemsChange?.(this);
113
- this.fn(batch);
114
- this.#setState({
115
- executionCount: this.store.state.executionCount + 1,
116
- totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length
117
- });
118
- this.options.onExecute?.(batch, this);
119
- };
120
- this.flush = () => {
121
- this.#clearTimeout();
122
- this.#execute();
123
- };
124
- this.peekAllItems = () => {
125
- return [...this.store.state.items];
126
- };
127
- this.#clearTimeout = () => {
128
- if (this.#timeoutId) {
129
- clearTimeout(this.#timeoutId);
130
- this.#timeoutId = null;
131
- }
132
- };
133
- this.clear = () => {
134
- this.#setState({
135
- items: [],
136
- isPending: false
137
- });
138
- };
139
- this.cancel = () => {
140
- this.#clearTimeout();
141
- this.#setState({ isPending: false });
142
- };
143
- this.reset = () => {
144
- this.#setState(getDefaultBatcherState());
145
- this.options.onItemsChange?.(this);
146
- };
147
- this.key = initialOptions.key;
148
- this.options = {
149
- ...defaultOptions,
150
- ...initialOptions
151
- };
152
- this.#setState(this.options.initialState ?? {});
153
- if (this.key) require_event_client.pacerEventClient.on("d-Batcher", (event) => {
154
- if (event.payload.key !== this.key) return;
155
- this.#setState(event.payload.store.state);
156
- this.setOptions(event.payload.options);
157
- });
158
- }
159
- #setState;
160
- #getWait;
161
- /**
162
- * Processes the current batch of items.
163
- * This method will automatically be triggered if the batcher is running and any of these conditions are met:
164
- * - The number of items reaches batchSize
165
- * - The wait duration has elapsed
166
- * - The getShouldExecute function returns true upon adding an item
167
- *
168
- * You can also call this method manually to process the current batch at any time.
169
- */
170
- #execute;
171
- #clearTimeout;
172
- };
173
- /**
174
- * Creates a batcher that processes items in batches.
175
- *
176
- * This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
177
- *
178
- * @example
179
- * ```ts
180
- * const batchItems = batch<number>(
181
- * (items) => console.log('Processing:', items),
182
- * {
183
- * maxSize: 3,
184
- * onExecute: (batch, batcher) => console.log('Batch executed:', batch)
185
- * }
186
- * );
187
- *
188
- * batchItems(1);
189
- * batchItems(2);
190
- * batchItems(3); // Triggers batch processing
191
- * ```
192
- */
193
- function batch(fn, options) {
194
- return new Batcher(fn, options).addItem;
195
- }
196
-
197
- //#endregion
198
- exports.Batcher = Batcher;
199
- exports.batch = batch;
200
- //# sourceMappingURL=batcher.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"batcher.cjs","names":["Store","parseFunctionOrValue","#setState","#execute","#clearTimeout","#timeoutId","#getWait"],"sources":["../src/batcher.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { OptionalKeys } from './types'\n\nexport interface BatcherState<TValue> {\n /**\n * Number of batch executions that have been completed\n */\n executionCount: number\n /**\n * Whether the batcher has no items to process (items array is empty)\n */\n isEmpty: boolean\n /**\n * Whether the batcher is waiting for the timeout to trigger batch processing\n */\n isPending: boolean\n /**\n * Array of items currently queued for batch processing\n */\n items: Array<TValue>\n /**\n * Number of items currently in the batch queue\n */\n size: number\n /**\n * Current processing status - 'idle' when not processing, 'pending' when waiting for timeout\n */\n status: 'idle' | 'pending'\n /**\n * Total number of items that have been processed across all batches\n */\n totalItemsProcessed: number\n}\n\nfunction getDefaultBatcherState<TValue>(): BatcherState<TValue> {\n return {\n executionCount: 0,\n isEmpty: true,\n isPending: false,\n totalItemsProcessed: 0,\n items: [],\n size: 0,\n status: 'idle',\n }\n}\n\n/**\n * Options for configuring a Batcher instance\n */\nexport interface BatcherOptions<TValue> {\n /**\n * Custom function to determine if a batch should be processed\n * Return true to process the batch immediately\n */\n getShouldExecute?: (items: Array<TValue>, batcher: Batcher<TValue>) => boolean\n /**\n * Initial state for the batcher\n */\n initialState?: Partial<BatcherState<TValue>>\n /**\n * Optional key to identify this batcher instance.\n * If provided, the batcher will be identified by this key in the devtools and PacerProvider if applicable.\n */\n key?: string\n /**\n * Maximum number of items in a batch\n * @default Infinity\n */\n maxSize?: number\n /**\n * Callback fired after a batch is processed\n */\n onExecute?: (batch: Array<TValue>, batcher: Batcher<TValue>) => void\n /**\n * Callback fired after items are added to the batcher\n */\n onItemsChange?: (batcher: Batcher<TValue>) => void\n /**\n * Whether the batcher should start processing immediately\n * @default true\n */\n started?: boolean\n /**\n * Maximum time in milliseconds to wait before processing a batch.\n * If the wait duration has elapsed, the batch will be processed.\n * If not provided, the batch will not be triggered by a timeout.\n * @default Infinity\n */\n wait?: number | ((batcher: Batcher<TValue>) => number)\n}\n\ntype BatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<\n Required<BatcherOptions<TValue>>,\n 'initialState' | 'onExecute' | 'onItemsChange' | 'key'\n>\n\nconst defaultOptions: BatcherOptionsWithOptionalCallbacks<any> = {\n getShouldExecute: () => false,\n maxSize: Infinity,\n started: true,\n wait: Infinity,\n}\n\n/**\n * A class that collects items and processes them in batches.\n *\n * Batching is a technique for grouping multiple operations together to be processed as a single unit.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * The Batcher provides a flexible way to implement batching with configurable:\n * - Maximum batch size (number of items per batch)\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the batcher\n * - Use `onExecute` callback to react to batch execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the batcher\n * - The state includes batch execution count, total items processed, items, and running status\n * - State can be accessed via `batcher.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `batcher.state`\n *\n * @example\n * ```ts\n * const batcher = new Batcher<number>(\n * (items) => console.log('Processing batch:', items),\n * {\n * maxSize: 5,\n * wait: 2000,\n * onExecute: (batch, batcher) => console.log('Batch executed:', batch)\n * }\n * );\n *\n * batcher.addItem(1);\n * batcher.addItem(2);\n * // After 2 seconds or when 5 items are added, whichever comes first,\n * // the batch will be processed\n * // batcher.flush() // manually trigger a batch\n * ```\n */\nexport class Batcher<TValue> {\n readonly store: Store<Readonly<BatcherState<TValue>>> = new Store(\n getDefaultBatcherState<TValue>(),\n )\n key: string | undefined\n options: BatcherOptionsWithOptionalCallbacks<TValue>\n #timeoutId: ReturnType<typeof setTimeout> | null = null\n\n constructor(\n public fn: (items: Array<TValue>) => void,\n initialOptions: BatcherOptions<TValue>,\n ) {\n this.key = initialOptions.key\n this.options = {\n ...defaultOptions,\n ...initialOptions,\n }\n this.#setState(this.options.initialState ?? {})\n\n if (this.key) {\n pacerEventClient.on('d-Batcher', (event) => {\n if (event.payload.key !== this.key) return\n this.#setState(\n event.payload.store.state as Partial<BatcherState<TValue>>,\n )\n this.setOptions(\n event.payload.options as Partial<BatcherOptions<TValue>>,\n )\n })\n }\n }\n\n /**\n * Updates the batcher options\n */\n setOptions = (newOptions: Partial<BatcherOptions<TValue>>): void => {\n this.options = { ...this.options, ...newOptions }\n }\n\n #setState = (newState: Partial<BatcherState<TValue>>): void => {\n this.store.setState((state) => {\n const combinedState = {\n ...state,\n ...newState,\n }\n const { isPending, items } = combinedState\n const size = items.length\n const isEmpty = size === 0\n return {\n ...combinedState,\n isEmpty,\n size,\n status: isPending ? 'pending' : 'idle',\n }\n })\n emitChange('Batcher', this)\n }\n\n #getWait = (): number => {\n return parseFunctionOrValue(this.options.wait, this)\n }\n\n /**\n * Adds an item to the batcher\n * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed\n */\n addItem = (item: TValue): void => {\n this.#setState({\n items: [...this.store.state.items, item],\n isPending: this.options.wait !== Infinity,\n })\n this.options.onItemsChange?.(this)\n\n const shouldProcess =\n this.store.state.items.length >= this.options.maxSize ||\n this.options.getShouldExecute(this.store.state.items, this)\n\n if (shouldProcess) {\n this.#execute()\n } else if (this.options.wait !== Infinity) {\n this.#clearTimeout() // clear any pending timeout to replace it with a new one\n this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait())\n }\n }\n\n /**\n * Processes the current batch of items.\n * This method will automatically be triggered if the batcher is running and any of these conditions are met:\n * - The number of items reaches batchSize\n * - The wait duration has elapsed\n * - The getShouldExecute function returns true upon adding an item\n *\n * You can also call this method manually to process the current batch at any time.\n */\n #execute = (): void => {\n if (this.store.state.items.length === 0) {\n return\n }\n\n const batch = this.peekAllItems() // copy of the items to be processed (to prevent race conditions)\n this.clear() // Clear items before processing to prevent race conditions\n this.options.onItemsChange?.(this) // Call onItemsChange to notify listeners that the items have changed\n\n this.fn(batch) // EXECUTE\n this.#setState({\n executionCount: this.store.state.executionCount + 1,\n totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,\n })\n this.options.onExecute?.(batch, this)\n }\n\n /**\n * Processes the current batch of items immediately\n */\n flush = (): void => {\n this.#clearTimeout() // clear any pending timeout\n this.#execute() // execute immediately\n }\n\n /**\n * Returns a copy of all items in the batcher\n */\n peekAllItems = (): Array<TValue> => {\n return [...this.store.state.items]\n }\n\n #clearTimeout = (): void => {\n if (this.#timeoutId) {\n clearTimeout(this.#timeoutId)\n this.#timeoutId = null\n }\n }\n\n /**\n * Removes all items from the batcher\n */\n clear = (): void => {\n this.#setState({ items: [], isPending: false })\n }\n\n /**\n * Cancels any pending execution that was scheduled.\n * Does NOT clear out the items.\n */\n cancel = (): void => {\n this.#clearTimeout()\n this.#setState({ isPending: false })\n }\n\n /**\n * Resets the batcher state to its default values\n */\n reset = (): void => {\n this.#setState(getDefaultBatcherState<TValue>())\n this.options.onItemsChange?.(this)\n }\n}\n\n/**\n * Creates a batcher that processes items in batches.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * @example\n * ```ts\n * const batchItems = batch<number>(\n * (items) => console.log('Processing:', items),\n * {\n * maxSize: 3,\n * onExecute: (batch, batcher) => console.log('Batch executed:', batch)\n * }\n * );\n *\n * batchItems(1);\n * batchItems(2);\n * batchItems(3); // Triggers batch processing\n * ```\n */\nexport function batch<TValue>(\n fn: (items: Array<TValue>) => void,\n options: BatcherOptions<TValue>,\n) {\n const batcher = new Batcher<TValue>(fn, options)\n return batcher.addItem\n}\n"],"mappings":";;;;;;AAoCA,SAAS,yBAAuD;CAC9D,OAAO;EACL,gBAAgB;EAChB,SAAS;EACT,WAAW;EACX,qBAAqB;EACrB,OAAO,CAAC;EACR,MAAM;EACN,QAAQ;CACV;AACF;AAoDA,MAAM,iBAA2D;CAC/D,wBAAwB;CACxB,SAAS;CACT,SAAS;CACT,MAAM;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,IAAa,UAAb,MAA6B;CAM3B;CAEA,YACE,AAAO,IACP,gBACA;EAFO;eAR+C,IAAIA,sBAC1D,uBAA+B,CACjC;oBAGmD;qBA6BrC,eAAsD;GAClE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;GAAW;EAClD;oBAEa,aAAkD;GAC7D,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;IACL;IACA,MAAM,EAAE,WAAW,UAAU;IAC7B,MAAM,OAAO,MAAM;IACnB,MAAM,UAAU,SAAS;IACzB,OAAO;KACL,GAAG;KACH;KACA;KACA,QAAQ,YAAY,YAAY;IAClC;GACF,CAAC;GACD,gCAAW,WAAW,IAAI;EAC5B;wBAEyB;GACvB,OAAOC,mCAAqB,KAAK,QAAQ,MAAM,IAAI;EACrD;kBAMW,SAAuB;GAChC,KAAKC,UAAU;IACb,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,OAAO,IAAI;IACvC,WAAW,KAAK,QAAQ,SAAS;GACnC,CAAC;GACD,KAAK,QAAQ,gBAAgB,IAAI;GAMjC,IAHE,KAAK,MAAM,MAAM,MAAM,UAAU,KAAK,QAAQ,WAC9C,KAAK,QAAQ,iBAAiB,KAAK,MAAM,MAAM,OAAO,IAAI,GAG1D,KAAKC,SAAS;QACT,IAAI,KAAK,QAAQ,SAAS,UAAU;IACzC,KAAKC,cAAc;IACnB,KAAKC,aAAa,iBAAiB,KAAKF,SAAS,GAAG,KAAKG,SAAS,CAAC;GACrE;EACF;wBAWuB;GACrB,IAAI,KAAK,MAAM,MAAM,MAAM,WAAW,GACpC;GAGF,MAAM,QAAQ,KAAK,aAAa;GAChC,KAAK,MAAM;GACX,KAAK,QAAQ,gBAAgB,IAAI;GAEjC,KAAK,GAAG,KAAK;GACb,KAAKJ,UAAU;IACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;IAClD,qBAAqB,KAAK,MAAM,MAAM,sBAAsB,MAAM;GACpE,CAAC;GACD,KAAK,QAAQ,YAAY,OAAO,IAAI;EACtC;qBAKoB;GAClB,KAAKE,cAAc;GACnB,KAAKD,SAAS;EAChB;4BAKoC;GAClC,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;EACnC;6BAE4B;GAC1B,IAAI,KAAKE,YAAY;IACnB,aAAa,KAAKA,UAAU;IAC5B,KAAKA,aAAa;GACpB;EACF;qBAKoB;GAClB,KAAKH,UAAU;IAAE,OAAO,CAAC;IAAG,WAAW;GAAM,CAAC;EAChD;sBAMqB;GACnB,KAAKE,cAAc;GACnB,KAAKF,UAAU,EAAE,WAAW,MAAM,CAAC;EACrC;qBAKoB;GAClB,KAAKA,UAAU,uBAA+B,CAAC;GAC/C,KAAK,QAAQ,gBAAgB,IAAI;EACnC;EA/IE,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;EACL;EACA,KAAKA,UAAU,KAAK,QAAQ,gBAAgB,CAAC,CAAC;EAE9C,IAAI,KAAK,KACP,sCAAiB,GAAG,cAAc,UAAU;GAC1C,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKA,UACH,MAAM,QAAQ,MAAM,KACtB;GACA,KAAK,WACH,MAAM,QAAQ,OAChB;EACF,CAAC;CAEL;CASA;CAmBA;;;;;;;;;;CAoCA;CAgCA;AA8BF;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,MACd,IACA,SACA;CAEA,OAAO,IADa,QAAgB,IAAI,OAC3B,CAAC,CAAC;AACjB"}