@tanstack/angular-pacer 0.23.1 → 0.25.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.
- package/README.md +21 -6
- package/dist/async-batcher/injectAsyncBatchedCallback.d.ts +2 -5
- package/dist/async-batcher/injectAsyncBatchedCallback.js +1 -2
- package/dist/async-batcher/injectAsyncBatcher.d.ts +4 -7
- package/dist/async-batcher/injectAsyncBatcher.js +1 -2
- package/dist/async-debouncer/injectAsyncDebouncedCallback.d.ts +2 -5
- package/dist/async-debouncer/injectAsyncDebouncedCallback.js +1 -2
- package/dist/async-debouncer/injectAsyncDebouncer.d.ts +4 -7
- package/dist/async-debouncer/injectAsyncDebouncer.js +1 -2
- package/dist/async-queuer/injectAsyncQueuedSignal.d.ts +3 -6
- package/dist/async-queuer/injectAsyncQueuedSignal.js +1 -2
- package/dist/async-queuer/injectAsyncQueuer.d.ts +4 -7
- package/dist/async-queuer/injectAsyncQueuer.js +1 -2
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.ts +2 -5
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js +1 -2
- package/dist/async-rate-limiter/injectAsyncRateLimiter.d.ts +4 -7
- package/dist/async-rate-limiter/injectAsyncRateLimiter.js +1 -2
- package/dist/async-throttler/injectAsyncThrottledCallback.d.ts +2 -5
- package/dist/async-throttler/injectAsyncThrottledCallback.js +1 -2
- package/dist/async-throttler/injectAsyncThrottler.d.ts +4 -7
- package/dist/async-throttler/injectAsyncThrottler.js +1 -2
- package/dist/batcher/injectBatchedCallback.d.ts +2 -5
- package/dist/batcher/injectBatchedCallback.js +1 -2
- package/dist/batcher/injectBatcher.d.ts +4 -7
- package/dist/batcher/injectBatcher.js +1 -2
- package/dist/debouncer/injectDebouncedCallback.d.ts +2 -5
- package/dist/debouncer/injectDebouncedCallback.js +1 -2
- package/dist/debouncer/injectDebouncedSignal.d.ts +3 -6
- package/dist/debouncer/injectDebouncedSignal.js +1 -2
- package/dist/debouncer/injectDebouncedValue.d.ts +3 -6
- package/dist/debouncer/injectDebouncedValue.js +1 -2
- package/dist/debouncer/injectDebouncer.d.ts +4 -7
- package/dist/debouncer/injectDebouncer.js +1 -2
- package/dist/provider/pacer-context.d.ts +4 -7
- package/dist/provider/pacer-context.js +1 -2
- package/dist/provider/pacer-provider.d.ts +2 -5
- package/dist/provider/pacer-provider.js +1 -2
- package/dist/queuer/injectQueuedSignal.d.ts +3 -6
- package/dist/queuer/injectQueuedSignal.js +1 -2
- package/dist/queuer/injectQueuedValue.d.ts +3 -6
- package/dist/queuer/injectQueuedValue.js +1 -2
- package/dist/queuer/injectQueuer.d.ts +4 -7
- package/dist/queuer/injectQueuer.js +1 -2
- package/dist/rate-limiter/injectRateLimitedCallback.d.ts +2 -5
- package/dist/rate-limiter/injectRateLimitedCallback.js +1 -2
- package/dist/rate-limiter/injectRateLimitedSignal.d.ts +3 -6
- package/dist/rate-limiter/injectRateLimitedSignal.js +1 -2
- package/dist/rate-limiter/injectRateLimitedValue.d.ts +3 -6
- package/dist/rate-limiter/injectRateLimitedValue.js +1 -2
- package/dist/rate-limiter/injectRateLimiter.d.ts +4 -7
- package/dist/rate-limiter/injectRateLimiter.js +1 -2
- package/dist/throttler/injectThrottledCallback.d.ts +2 -5
- package/dist/throttler/injectThrottledCallback.js +1 -2
- package/dist/throttler/injectThrottledSignal.d.ts +3 -8
- package/dist/throttler/injectThrottledSignal.js +1 -4
- package/dist/throttler/injectThrottledValue.d.ts +3 -8
- package/dist/throttler/injectThrottledValue.js +1 -2
- package/dist/throttler/injectThrottler.d.ts +4 -9
- package/dist/throttler/injectThrottler.js +1 -4
- package/package.json +25 -72
- package/dist/async-batcher/index.cjs +0 -13
- package/dist/async-batcher/index.d.cts +0 -4
- package/dist/async-batcher/injectAsyncBatchedCallback.cjs +0 -49
- package/dist/async-batcher/injectAsyncBatchedCallback.cjs.map +0 -1
- package/dist/async-batcher/injectAsyncBatchedCallback.d.cts +0 -45
- package/dist/async-batcher/injectAsyncBatchedCallback.js.map +0 -1
- package/dist/async-batcher/injectAsyncBatcher.cjs +0 -85
- package/dist/async-batcher/injectAsyncBatcher.cjs.map +0 -1
- package/dist/async-batcher/injectAsyncBatcher.d.cts +0 -85
- package/dist/async-batcher/injectAsyncBatcher.js.map +0 -1
- package/dist/async-debouncer/index.cjs +0 -13
- package/dist/async-debouncer/index.d.cts +0 -4
- package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs +0 -49
- package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs.map +0 -1
- package/dist/async-debouncer/injectAsyncDebouncedCallback.d.cts +0 -43
- package/dist/async-debouncer/injectAsyncDebouncedCallback.js.map +0 -1
- package/dist/async-debouncer/injectAsyncDebouncer.cjs +0 -107
- package/dist/async-debouncer/injectAsyncDebouncer.cjs.map +0 -1
- package/dist/async-debouncer/injectAsyncDebouncer.d.cts +0 -108
- package/dist/async-debouncer/injectAsyncDebouncer.js.map +0 -1
- package/dist/async-queuer/index.cjs +0 -13
- package/dist/async-queuer/index.d.cts +0 -4
- package/dist/async-queuer/injectAsyncQueuedSignal.cjs +0 -53
- package/dist/async-queuer/injectAsyncQueuedSignal.cjs.map +0 -1
- package/dist/async-queuer/injectAsyncQueuedSignal.d.cts +0 -50
- package/dist/async-queuer/injectAsyncQueuedSignal.js.map +0 -1
- package/dist/async-queuer/injectAsyncQueuer.cjs +0 -85
- package/dist/async-queuer/injectAsyncQueuer.cjs.map +0 -1
- package/dist/async-queuer/injectAsyncQueuer.d.cts +0 -85
- package/dist/async-queuer/injectAsyncQueuer.js.map +0 -1
- package/dist/async-rate-limiter/index.cjs +0 -13
- package/dist/async-rate-limiter/index.d.cts +0 -4
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs +0 -52
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs.map +0 -1
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.cts +0 -46
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js.map +0 -1
- package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs +0 -69
- package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs.map +0 -1
- package/dist/async-rate-limiter/injectAsyncRateLimiter.d.cts +0 -72
- package/dist/async-rate-limiter/injectAsyncRateLimiter.js.map +0 -1
- package/dist/async-retryer/index.cjs +0 -9
- package/dist/async-retryer/index.d.cts +0 -1
- package/dist/async-throttler/index.cjs +0 -13
- package/dist/async-throttler/index.d.cts +0 -4
- package/dist/async-throttler/injectAsyncThrottledCallback.cjs +0 -50
- package/dist/async-throttler/injectAsyncThrottledCallback.cjs.map +0 -1
- package/dist/async-throttler/injectAsyncThrottledCallback.d.cts +0 -44
- package/dist/async-throttler/injectAsyncThrottledCallback.js.map +0 -1
- package/dist/async-throttler/injectAsyncThrottler.cjs +0 -86
- package/dist/async-throttler/injectAsyncThrottler.cjs.map +0 -1
- package/dist/async-throttler/injectAsyncThrottler.d.cts +0 -87
- package/dist/async-throttler/injectAsyncThrottler.js.map +0 -1
- package/dist/batcher/index.cjs +0 -13
- package/dist/batcher/index.d.cts +0 -4
- package/dist/batcher/injectBatchedCallback.cjs +0 -47
- package/dist/batcher/injectBatchedCallback.cjs.map +0 -1
- package/dist/batcher/injectBatchedCallback.d.cts +0 -43
- package/dist/batcher/injectBatchedCallback.js.map +0 -1
- package/dist/batcher/injectBatcher.cjs +0 -75
- package/dist/batcher/injectBatcher.cjs.map +0 -1
- package/dist/batcher/injectBatcher.d.cts +0 -77
- package/dist/batcher/injectBatcher.js.map +0 -1
- package/dist/debouncer/index.cjs +0 -17
- package/dist/debouncer/index.d.cts +0 -6
- package/dist/debouncer/injectDebouncedCallback.cjs +0 -46
- package/dist/debouncer/injectDebouncedCallback.cjs.map +0 -1
- package/dist/debouncer/injectDebouncedCallback.d.cts +0 -43
- package/dist/debouncer/injectDebouncedCallback.js.map +0 -1
- package/dist/debouncer/injectDebouncedSignal.cjs +0 -68
- package/dist/debouncer/injectDebouncedSignal.cjs.map +0 -1
- package/dist/debouncer/injectDebouncedSignal.d.cts +0 -60
- package/dist/debouncer/injectDebouncedSignal.js.map +0 -1
- package/dist/debouncer/injectDebouncedValue.cjs +0 -17
- package/dist/debouncer/injectDebouncedValue.cjs.map +0 -1
- package/dist/debouncer/injectDebouncedValue.d.cts +0 -76
- package/dist/debouncer/injectDebouncedValue.js.map +0 -1
- package/dist/debouncer/injectDebouncer.cjs +0 -95
- package/dist/debouncer/injectDebouncer.cjs.map +0 -1
- package/dist/debouncer/injectDebouncer.d.cts +0 -98
- package/dist/debouncer/injectDebouncer.js.map +0 -1
- package/dist/index.cjs +0 -65
- package/dist/index.d.cts +0 -30
- package/dist/provider/index.cjs +0 -7
- package/dist/provider/index.d.cts +0 -3
- package/dist/provider/pacer-context.cjs +0 -20
- package/dist/provider/pacer-context.cjs.map +0 -1
- package/dist/provider/pacer-context.d.cts +0 -21
- package/dist/provider/pacer-context.js.map +0 -1
- package/dist/provider/pacer-provider.cjs +0 -41
- package/dist/provider/pacer-provider.cjs.map +0 -1
- package/dist/provider/pacer-provider.d.cts +0 -36
- package/dist/provider/pacer-provider.js.map +0 -1
- package/dist/queuer/index.cjs +0 -15
- package/dist/queuer/index.d.cts +0 -5
- package/dist/queuer/injectQueuedSignal.cjs +0 -47
- package/dist/queuer/injectQueuedSignal.cjs.map +0 -1
- package/dist/queuer/injectQueuedSignal.d.cts +0 -44
- package/dist/queuer/injectQueuedSignal.js.map +0 -1
- package/dist/queuer/injectQueuedValue.cjs +0 -23
- package/dist/queuer/injectQueuedValue.cjs.map +0 -1
- package/dist/queuer/injectQueuedValue.d.cts +0 -34
- package/dist/queuer/injectQueuedValue.js.map +0 -1
- package/dist/queuer/injectQueuer.cjs +0 -80
- package/dist/queuer/injectQueuer.cjs.map +0 -1
- package/dist/queuer/injectQueuer.d.cts +0 -82
- package/dist/queuer/injectQueuer.js.map +0 -1
- package/dist/rate-limiter/index.cjs +0 -17
- package/dist/rate-limiter/index.d.cts +0 -6
- package/dist/rate-limiter/injectRateLimitedCallback.cjs +0 -45
- package/dist/rate-limiter/injectRateLimitedCallback.cjs.map +0 -1
- package/dist/rate-limiter/injectRateLimitedCallback.d.cts +0 -42
- package/dist/rate-limiter/injectRateLimitedCallback.js.map +0 -1
- package/dist/rate-limiter/injectRateLimitedSignal.cjs +0 -62
- package/dist/rate-limiter/injectRateLimitedSignal.cjs.map +0 -1
- package/dist/rate-limiter/injectRateLimitedSignal.d.cts +0 -54
- package/dist/rate-limiter/injectRateLimitedSignal.js.map +0 -1
- package/dist/rate-limiter/injectRateLimitedValue.cjs +0 -17
- package/dist/rate-limiter/injectRateLimitedValue.cjs.map +0 -1
- package/dist/rate-limiter/injectRateLimitedValue.d.cts +0 -49
- package/dist/rate-limiter/injectRateLimitedValue.js.map +0 -1
- package/dist/rate-limiter/injectRateLimiter.cjs +0 -100
- package/dist/rate-limiter/injectRateLimiter.cjs.map +0 -1
- package/dist/rate-limiter/injectRateLimiter.d.cts +0 -103
- package/dist/rate-limiter/injectRateLimiter.js.map +0 -1
- package/dist/throttler/index.cjs +0 -17
- package/dist/throttler/index.d.cts +0 -6
- package/dist/throttler/injectThrottledCallback.cjs +0 -45
- package/dist/throttler/injectThrottledCallback.cjs.map +0 -1
- package/dist/throttler/injectThrottledCallback.d.cts +0 -42
- package/dist/throttler/injectThrottledCallback.js.map +0 -1
- package/dist/throttler/injectThrottledSignal.cjs +0 -69
- package/dist/throttler/injectThrottledSignal.cjs.map +0 -1
- package/dist/throttler/injectThrottledSignal.d.cts +0 -61
- package/dist/throttler/injectThrottledSignal.js.map +0 -1
- package/dist/throttler/injectThrottledValue.cjs +0 -17
- package/dist/throttler/injectThrottledValue.cjs.map +0 -1
- package/dist/throttler/injectThrottledValue.d.cts +0 -74
- package/dist/throttler/injectThrottledValue.js.map +0 -1
- package/dist/throttler/injectThrottler.cjs +0 -95
- package/dist/throttler/injectThrottler.cjs.map +0 -1
- package/dist/throttler/injectThrottler.d.cts +0 -98
- package/dist/throttler/injectThrottler.js.map +0 -1
- package/dist/types/index.cjs +0 -9
- package/dist/types/index.d.cts +0 -1
- package/dist/utils/index.cjs +0 -9
- package/dist/utils/index.d.cts +0 -1
- package/src/async-batcher/index.ts +0 -4
- package/src/async-batcher/injectAsyncBatchedCallback.ts +0 -48
- package/src/async-batcher/injectAsyncBatcher.ts +0 -126
- package/src/async-debouncer/index.ts +0 -4
- package/src/async-debouncer/injectAsyncDebouncedCallback.ts +0 -50
- package/src/async-debouncer/injectAsyncDebouncer.ts +0 -152
- package/src/async-queuer/index.ts +0 -4
- package/src/async-queuer/injectAsyncQueuedSignal.ts +0 -74
- package/src/async-queuer/injectAsyncQueuer.ts +0 -126
- package/src/async-rate-limiter/index.ts +0 -4
- package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts +0 -52
- package/src/async-rate-limiter/injectAsyncRateLimiter.ts +0 -115
- package/src/async-retryer/index.ts +0 -1
- package/src/async-throttler/index.ts +0 -4
- package/src/async-throttler/injectAsyncThrottledCallback.ts +0 -50
- package/src/async-throttler/injectAsyncThrottler.ts +0 -131
- package/src/batcher/index.ts +0 -4
- package/src/batcher/injectBatchedCallback.ts +0 -46
- package/src/batcher/injectBatcher.ts +0 -114
- package/src/debouncer/index.ts +0 -6
- package/src/debouncer/injectDebouncedCallback.ts +0 -46
- package/src/debouncer/injectDebouncedSignal.ts +0 -94
- package/src/debouncer/injectDebouncedValue.ts +0 -126
- package/src/debouncer/injectDebouncer.ts +0 -137
- package/src/index.ts +0 -40
- package/src/provider/index.ts +0 -2
- package/src/provider/pacer-context.ts +0 -46
- package/src/provider/pacer-provider.ts +0 -38
- package/src/queuer/index.ts +0 -5
- package/src/queuer/injectQueuedSignal.ts +0 -65
- package/src/queuer/injectQueuedValue.ts +0 -101
- package/src/queuer/injectQueuer.ts +0 -118
- package/src/rate-limiter/index.ts +0 -6
- package/src/rate-limiter/injectRateLimitedCallback.ts +0 -45
- package/src/rate-limiter/injectRateLimitedSignal.ts +0 -88
- package/src/rate-limiter/injectRateLimitedValue.ts +0 -99
- package/src/rate-limiter/injectRateLimiter.ts +0 -140
- package/src/throttler/index.ts +0 -6
- package/src/throttler/injectThrottledCallback.ts +0 -45
- package/src/throttler/injectThrottledSignal.ts +0 -95
- package/src/throttler/injectThrottledValue.ts +0 -124
- package/src/throttler/injectThrottler.ts +0 -137
- package/src/types/index.ts +0 -1
- package/src/utils/index.ts +0 -1
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
import { Signal } from "@angular/core";
|
|
2
|
-
import { Store } from "@tanstack/angular-store";
|
|
3
|
-
import { Queuer, QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
|
|
4
|
-
|
|
5
|
-
//#region src/queuer/injectQueuer.d.ts
|
|
6
|
-
interface AngularQueuerOptions<TValue, TSelected = {}> extends QueuerOptions<TValue> {
|
|
7
|
-
/**
|
|
8
|
-
* Optional callback invoked when the component is destroyed. Receives the queuer instance.
|
|
9
|
-
* When provided, replaces the default cleanup (stop); use it to call flush(), stop(), add logging, etc.
|
|
10
|
-
*/
|
|
11
|
-
onUnmount?: (queuer: AngularQueuer<TValue, TSelected>) => void;
|
|
12
|
-
}
|
|
13
|
-
interface AngularQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
|
|
14
|
-
/**
|
|
15
|
-
* Reactive state signal that will be updated when the queuer state changes
|
|
16
|
-
*
|
|
17
|
-
* Use this instead of `queuer.store.state`
|
|
18
|
-
*/
|
|
19
|
-
readonly state: Signal<Readonly<TSelected>>;
|
|
20
|
-
/**
|
|
21
|
-
* @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.
|
|
22
|
-
* The state on the store object is not reactive in Angular signals.
|
|
23
|
-
*/
|
|
24
|
-
readonly store: Store<Readonly<QueuerState<TValue>>>;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* An Angular function that creates and manages a Queuer instance.
|
|
28
|
-
*
|
|
29
|
-
* This is a lower-level function that provides direct access to the Queuer's functionality.
|
|
30
|
-
* This allows you to integrate it with any state management solution you prefer.
|
|
31
|
-
*
|
|
32
|
-
* The Queuer processes items synchronously in order, with optional delays between processing each item.
|
|
33
|
-
* The queuer includes an internal tick mechanism that can be started and stopped, making it useful as a scheduler.
|
|
34
|
-
*
|
|
35
|
-
* ## State Management and Selector
|
|
36
|
-
*
|
|
37
|
-
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
38
|
-
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
39
|
-
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
40
|
-
*
|
|
41
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
42
|
-
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
43
|
-
* full control over when your component tracks state changes.
|
|
44
|
-
*
|
|
45
|
-
* @example
|
|
46
|
-
* ```ts
|
|
47
|
-
* // Default behavior - no reactive state subscriptions
|
|
48
|
-
* const queue = injectQueuer(
|
|
49
|
-
* (item) => console.log('Processing:', item),
|
|
50
|
-
* { started: true, wait: 1000 }
|
|
51
|
-
* );
|
|
52
|
-
*
|
|
53
|
-
* // Opt-in to track queue contents changes
|
|
54
|
-
* const queue = injectQueuer(
|
|
55
|
-
* (item) => console.log('Processing:', item),
|
|
56
|
-
* { started: true, wait: 1000 },
|
|
57
|
-
* (state) => ({ items: state.items, size: state.size })
|
|
58
|
-
* );
|
|
59
|
-
*
|
|
60
|
-
* // Add items
|
|
61
|
-
* queue.addItem('task1');
|
|
62
|
-
*
|
|
63
|
-
* // Access the selected state
|
|
64
|
-
* const { items, isRunning } = queue.state();
|
|
65
|
-
* ```
|
|
66
|
-
*
|
|
67
|
-
* ## Cleanup on Destroy
|
|
68
|
-
*
|
|
69
|
-
* By default, the function stops the queuer when the component is destroyed.
|
|
70
|
-
* Use the `onUnmount` option to customize this. For example, to flush pending items instead:
|
|
71
|
-
*
|
|
72
|
-
* ```ts
|
|
73
|
-
* const queue = injectQueuer(fn, {
|
|
74
|
-
* started: true,
|
|
75
|
-
* onUnmount: (q) => q.flush()
|
|
76
|
-
* });
|
|
77
|
-
* ```
|
|
78
|
-
*/
|
|
79
|
-
declare function injectQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: AngularQueuerOptions<TValue, TSelected>, selector?: (state: QueuerState<TValue>) => TSelected): AngularQueuer<TValue, TSelected>;
|
|
80
|
-
//#endregion
|
|
81
|
-
export { AngularQueuer, AngularQueuerOptions, injectQueuer };
|
|
82
|
-
//# sourceMappingURL=injectQueuer.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectQueuer.js","names":[],"sources":["../../src/queuer/injectQueuer.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } from '@tanstack/angular-store'\nimport { Queuer } from '@tanstack/pacer/queuer'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\n\nexport interface AngularQueuerOptions<\n TValue,\n TSelected = {},\n> extends QueuerOptions<TValue> {\n /**\n * Optional callback invoked when the component is destroyed. Receives the queuer instance.\n * When provided, replaces the default cleanup (stop); use it to call flush(), stop(), add logging, etc.\n */\n onUnmount?: (queuer: AngularQueuer<TValue, TSelected>) => void\n}\n\nexport interface AngularQueuer<TValue, TSelected = {}> extends Omit<\n Queuer<TValue>,\n 'store'\n> {\n /**\n * Reactive state signal that will be updated when the queuer state changes\n *\n * Use this instead of `queuer.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.\n * The state on the store object is not reactive in Angular signals.\n */\n readonly store: Store<Readonly<QueuerState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Queuer instance.\n *\n * This is a lower-level function that provides direct access to the Queuer's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Queuer processes items synchronously in order, with optional delays between processing each item.\n * The queuer includes an internal tick mechanism that can be started and stopped, making it useful as a scheduler.\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const queue = injectQueuer(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 }\n * );\n *\n * // Opt-in to track queue contents changes\n * const queue = injectQueuer(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({ items: state.items, size: state.size })\n * );\n *\n * // Add items\n * queue.addItem('task1');\n *\n * // Access the selected state\n * const { items, isRunning } = queue.state();\n * ```\n *\n * ## Cleanup on Destroy\n *\n * By default, the function stops the queuer when the component is destroyed.\n * Use the `onUnmount` option to customize this. For example, to flush pending items instead:\n *\n * ```ts\n * const queue = injectQueuer(fn, {\n * started: true,\n * onUnmount: (q) => q.flush()\n * });\n * ```\n */\nexport function injectQueuer<TValue, TSelected = {}>(\n fn: (item: TValue) => void,\n options: AngularQueuerOptions<TValue, TSelected> = {},\n selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,\n): AngularQueuer<TValue, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().queuer,\n ...options,\n } as AngularQueuerOptions<TValue, TSelected>\n\n const queuer = new Queuer<TValue>(fn, mergedOptions)\n const state = injectSelector(queuer.store, selector)\n\n const result = {\n ...queuer,\n state,\n } as AngularQueuer<TValue, TSelected>\n\n const destroyRef = inject(DestroyRef, { optional: true })\n destroyRef?.onDestroy(() => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(result)\n } else {\n queuer.stop()\n }\n })\n\n return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyFA,SAAgB,aACd,IACA,UAAmD,EAAE,EACrD,kBAA6D,EAAE,GAC7B;CAClC,MAAM,gBAAgB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,SAAS,IAAI,OAAe,IAAI,cAAc;CACpD,MAAM,QAAQ,eAAe,OAAO,OAAO,SAAS;CAEpD,MAAM,SAAS;EACb,GAAG;EACH;EACD;CAGD,AADmB,OAAO,YAAY,EAAE,UAAU,MAAM,CAC9C,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;OAE/B,OAAO,MAAM;GAEf;CAEF,OAAO"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
-
const require_injectRateLimiter = require('./injectRateLimiter.cjs');
|
|
3
|
-
const require_injectRateLimitedCallback = require('./injectRateLimitedCallback.cjs');
|
|
4
|
-
const require_injectRateLimitedSignal = require('./injectRateLimitedSignal.cjs');
|
|
5
|
-
const require_injectRateLimitedValue = require('./injectRateLimitedValue.cjs');
|
|
6
|
-
|
|
7
|
-
exports.injectRateLimitedCallback = require_injectRateLimitedCallback.injectRateLimitedCallback;
|
|
8
|
-
exports.injectRateLimitedSignal = require_injectRateLimitedSignal.injectRateLimitedSignal;
|
|
9
|
-
exports.injectRateLimitedValue = require_injectRateLimitedValue.injectRateLimitedValue;
|
|
10
|
-
exports.injectRateLimiter = require_injectRateLimiter.injectRateLimiter;
|
|
11
|
-
var _tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
|
|
12
|
-
Object.keys(_tanstack_pacer_rate_limiter).forEach(function (k) {
|
|
13
|
-
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
14
|
-
enumerable: true,
|
|
15
|
-
get: function () { return _tanstack_pacer_rate_limiter[k]; }
|
|
16
|
-
});
|
|
17
|
-
});
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { injectRateLimitedCallback } from "./injectRateLimitedCallback.cjs";
|
|
2
|
-
import { AngularRateLimiter, AngularRateLimiterOptions, injectRateLimiter } from "./injectRateLimiter.cjs";
|
|
3
|
-
import { RateLimitedSignal, injectRateLimitedSignal } from "./injectRateLimitedSignal.cjs";
|
|
4
|
-
import { injectRateLimitedValue } from "./injectRateLimitedValue.cjs";
|
|
5
|
-
export * from "@tanstack/pacer/rate-limiter";
|
|
6
|
-
export { AngularRateLimiter, AngularRateLimiterOptions, RateLimitedSignal, injectRateLimitedCallback, injectRateLimitedSignal, injectRateLimitedValue, injectRateLimiter };
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
const require_injectRateLimiter = require('./injectRateLimiter.cjs');
|
|
2
|
-
|
|
3
|
-
//#region src/rate-limiter/injectRateLimitedCallback.ts
|
|
4
|
-
/**
|
|
5
|
-
* An Angular function that creates a rate-limited version of a callback function.
|
|
6
|
-
* This function is essentially a wrapper around `injectRateLimiter` that provides
|
|
7
|
-
* a simplified API for basic rate limiting needs.
|
|
8
|
-
*
|
|
9
|
-
* Rate limiting is a simple "hard limit" approach - it allows all calls until the limit
|
|
10
|
-
* is reached, then blocks subsequent calls until the window resets. Unlike throttling
|
|
11
|
-
* or debouncing, it does not attempt to space out or intelligently collapse calls.
|
|
12
|
-
*
|
|
13
|
-
* This function provides a simpler API compared to `injectRateLimiter`, making it ideal for basic
|
|
14
|
-
* rate limiting needs. However, it does not expose the underlying RateLimiter instance.
|
|
15
|
-
*
|
|
16
|
-
* For advanced usage requiring features like:
|
|
17
|
-
* - Manual cancellation/reset
|
|
18
|
-
* - Access to execution counts
|
|
19
|
-
* - State tracking
|
|
20
|
-
*
|
|
21
|
-
* Consider using the `injectRateLimiter` function instead.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```ts
|
|
25
|
-
* // Rate limit API calls to maximum 5 calls per minute
|
|
26
|
-
* const makeApiCall = injectRateLimitedCallback(
|
|
27
|
-
* (data: ApiData) => {
|
|
28
|
-
* return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
|
|
29
|
-
* },
|
|
30
|
-
* {
|
|
31
|
-
* limit: 5,
|
|
32
|
-
* window: 60000, // 1 minute
|
|
33
|
-
* windowType: 'sliding',
|
|
34
|
-
* }
|
|
35
|
-
* );
|
|
36
|
-
* ```
|
|
37
|
-
*/
|
|
38
|
-
function injectRateLimitedCallback(fn, options) {
|
|
39
|
-
const rateLimiter = require_injectRateLimiter.injectRateLimiter(fn, options);
|
|
40
|
-
return (...args) => rateLimiter.maybeExecute(...args);
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
//#endregion
|
|
44
|
-
exports.injectRateLimitedCallback = injectRateLimitedCallback;
|
|
45
|
-
//# sourceMappingURL=injectRateLimitedCallback.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedCallback.cjs","names":["injectRateLimiter"],"sources":["../../src/rate-limiter/injectRateLimitedCallback.ts"],"sourcesContent":["import { injectRateLimiter } from './injectRateLimiter'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a rate-limited version of a callback function.\n * This function is essentially a wrapper around `injectRateLimiter` that provides\n * a simplified API for basic rate limiting needs.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all calls until the limit\n * is reached, then blocks subsequent calls until the window resets. Unlike throttling\n * or debouncing, it does not attempt to space out or intelligently collapse calls.\n *\n * This function provides a simpler API compared to `injectRateLimiter`, making it ideal for basic\n * rate limiting needs. However, it does not expose the underlying RateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation/reset\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectRateLimiter` function instead.\n *\n * @example\n * ```ts\n * // Rate limit API calls to maximum 5 calls per minute\n * const makeApiCall = injectRateLimitedCallback(\n * (data: ApiData) => {\n * return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n * },\n * {\n * limit: 5,\n * window: 60000, // 1 minute\n * windowType: 'sliding',\n * }\n * );\n * ```\n */\nexport function injectRateLimitedCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: RateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => boolean {\n const rateLimiter = injectRateLimiter(fn, options)\n return (...args: Parameters<TFn>) => rateLimiter.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,0BACd,IACA,SACuC;CACvC,MAAM,cAAcA,4CAAkB,IAAI,QAAQ;CAClD,QAAQ,GAAG,SAA0B,YAAY,aAAa,GAAG,KAAK"}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import { AnyFunction } from "@tanstack/pacer/types";
|
|
2
|
-
import { RateLimiterOptions } from "@tanstack/pacer/rate-limiter";
|
|
3
|
-
|
|
4
|
-
//#region src/rate-limiter/injectRateLimitedCallback.d.ts
|
|
5
|
-
/**
|
|
6
|
-
* An Angular function that creates a rate-limited version of a callback function.
|
|
7
|
-
* This function is essentially a wrapper around `injectRateLimiter` that provides
|
|
8
|
-
* a simplified API for basic rate limiting needs.
|
|
9
|
-
*
|
|
10
|
-
* Rate limiting is a simple "hard limit" approach - it allows all calls until the limit
|
|
11
|
-
* is reached, then blocks subsequent calls until the window resets. Unlike throttling
|
|
12
|
-
* or debouncing, it does not attempt to space out or intelligently collapse calls.
|
|
13
|
-
*
|
|
14
|
-
* This function provides a simpler API compared to `injectRateLimiter`, making it ideal for basic
|
|
15
|
-
* rate limiting needs. However, it does not expose the underlying RateLimiter instance.
|
|
16
|
-
*
|
|
17
|
-
* For advanced usage requiring features like:
|
|
18
|
-
* - Manual cancellation/reset
|
|
19
|
-
* - Access to execution counts
|
|
20
|
-
* - State tracking
|
|
21
|
-
*
|
|
22
|
-
* Consider using the `injectRateLimiter` function instead.
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```ts
|
|
26
|
-
* // Rate limit API calls to maximum 5 calls per minute
|
|
27
|
-
* const makeApiCall = injectRateLimitedCallback(
|
|
28
|
-
* (data: ApiData) => {
|
|
29
|
-
* return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
|
|
30
|
-
* },
|
|
31
|
-
* {
|
|
32
|
-
* limit: 5,
|
|
33
|
-
* window: 60000, // 1 minute
|
|
34
|
-
* windowType: 'sliding',
|
|
35
|
-
* }
|
|
36
|
-
* );
|
|
37
|
-
* ```
|
|
38
|
-
*/
|
|
39
|
-
declare function injectRateLimitedCallback<TFn extends AnyFunction>(fn: TFn, options: RateLimiterOptions<TFn>): (...args: Parameters<TFn>) => boolean;
|
|
40
|
-
//#endregion
|
|
41
|
-
export { injectRateLimitedCallback };
|
|
42
|
-
//# sourceMappingURL=injectRateLimitedCallback.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedCallback.js","names":[],"sources":["../../src/rate-limiter/injectRateLimitedCallback.ts"],"sourcesContent":["import { injectRateLimiter } from './injectRateLimiter'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a rate-limited version of a callback function.\n * This function is essentially a wrapper around `injectRateLimiter` that provides\n * a simplified API for basic rate limiting needs.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all calls until the limit\n * is reached, then blocks subsequent calls until the window resets. Unlike throttling\n * or debouncing, it does not attempt to space out or intelligently collapse calls.\n *\n * This function provides a simpler API compared to `injectRateLimiter`, making it ideal for basic\n * rate limiting needs. However, it does not expose the underlying RateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation/reset\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectRateLimiter` function instead.\n *\n * @example\n * ```ts\n * // Rate limit API calls to maximum 5 calls per minute\n * const makeApiCall = injectRateLimitedCallback(\n * (data: ApiData) => {\n * return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n * },\n * {\n * limit: 5,\n * window: 60000, // 1 minute\n * windowType: 'sliding',\n * }\n * );\n * ```\n */\nexport function injectRateLimitedCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: RateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => boolean {\n const rateLimiter = injectRateLimiter(fn, options)\n return (...args: Parameters<TFn>) => rateLimiter.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,0BACd,IACA,SACuC;CACvC,MAAM,cAAc,kBAAkB,IAAI,QAAQ;CAClD,QAAQ,GAAG,SAA0B,YAAY,aAAa,GAAG,KAAK"}
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
const require_injectRateLimiter = require('./injectRateLimiter.cjs');
|
|
2
|
-
let _angular_core = require("@angular/core");
|
|
3
|
-
|
|
4
|
-
//#region src/rate-limiter/injectRateLimitedSignal.ts
|
|
5
|
-
/**
|
|
6
|
-
* An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality.
|
|
7
|
-
* This function provides both the current rate-limited value and methods to update it.
|
|
8
|
-
*
|
|
9
|
-
* Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
|
|
10
|
-
* subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
|
|
11
|
-
* or intelligently collapse updates.
|
|
12
|
-
*
|
|
13
|
-
* The function returns a callable object:
|
|
14
|
-
* - `rateLimited()`: Get the current rate-limited value
|
|
15
|
-
* - `rateLimited.set(...)`: Set or update the rate-limited value (rate-limited via maybeExecute)
|
|
16
|
-
* - `rateLimited.rateLimiter`: The rate limiter instance with additional control methods and state signals
|
|
17
|
-
*
|
|
18
|
-
* ## State Management and Selector
|
|
19
|
-
*
|
|
20
|
-
* The function uses TanStack Store for reactive state management via the underlying rate limiter instance.
|
|
21
|
-
* The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,
|
|
22
|
-
* optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
|
|
23
|
-
*
|
|
24
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
25
|
-
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
26
|
-
* full control over when your component tracks state changes.
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```ts
|
|
30
|
-
* // Default behavior - no reactive state subscriptions
|
|
31
|
-
* const rateLimited = injectRateLimitedSignal(0, {
|
|
32
|
-
* limit: 5,
|
|
33
|
-
* window: 60000,
|
|
34
|
-
* windowType: 'sliding'
|
|
35
|
-
* });
|
|
36
|
-
*
|
|
37
|
-
* // Opt-in to reactive updates when limit state changes
|
|
38
|
-
* const rateLimited = injectRateLimitedSignal(
|
|
39
|
-
* 0,
|
|
40
|
-
* { limit: 5, window: 60000 },
|
|
41
|
-
* (state) => ({ rejectionCount: state.rejectionCount })
|
|
42
|
-
* );
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
function injectRateLimitedSignal(value, initialOptions, selector) {
|
|
46
|
-
const rateLimitedValue = (0, _angular_core.signal)(value);
|
|
47
|
-
const rateLimiter = require_injectRateLimiter.injectRateLimiter((newValue) => {
|
|
48
|
-
if (typeof newValue === "function") rateLimitedValue.update(newValue);
|
|
49
|
-
else rateLimitedValue.set(newValue);
|
|
50
|
-
}, initialOptions, selector);
|
|
51
|
-
const set = (newValue) => {
|
|
52
|
-
rateLimiter.maybeExecute(newValue);
|
|
53
|
-
};
|
|
54
|
-
return Object.assign(() => rateLimitedValue(), {
|
|
55
|
-
set,
|
|
56
|
-
rateLimiter
|
|
57
|
-
});
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
//#endregion
|
|
61
|
-
exports.injectRateLimitedSignal = injectRateLimitedSignal;
|
|
62
|
-
//# sourceMappingURL=injectRateLimitedSignal.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedSignal.cjs","names":["injectRateLimiter"],"sources":["../../src/rate-limiter/injectRateLimitedSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectRateLimiter } from './injectRateLimiter'\nimport type { AngularRateLimiter } from './injectRateLimiter'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport interface RateLimitedSignal<TValue, TSelected = {}> {\n (): TValue\n set: Setter<TValue>\n rateLimiter: AngularRateLimiter<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality.\n * This function provides both the current rate-limited value and methods to update it.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates.\n *\n * The function returns a callable object:\n * - `rateLimited()`: Get the current rate-limited value\n * - `rateLimited.set(...)`: Set or update the rate-limited value (rate-limited via maybeExecute)\n * - `rateLimited.rateLimiter`: The rate limiter instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const rateLimited = injectRateLimitedSignal(0, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when limit state changes\n * const rateLimited = injectRateLimitedSignal(\n * 0,\n * { limit: 5, window: 60000 },\n * (state) => ({ rejectionCount: state.rejectionCount })\n * );\n * ```\n */\nexport function injectRateLimitedSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected> {\n const rateLimitedValue = signal<TValue>(value)\n\n const rateLimiter = injectRateLimiter(\n (newValue: TValue | ((prev: TValue) => TValue)) => {\n if (typeof newValue === 'function') {\n rateLimitedValue.update(newValue as (prev: TValue) => TValue)\n } else {\n rateLimitedValue.set(newValue)\n }\n },\n initialOptions,\n selector,\n )\n\n const set: Setter<TValue> = (\n newValue: TValue | ((prev: TValue) => TValue),\n ) => {\n rateLimiter.maybeExecute(newValue)\n }\n\n const rateLimited = Object.assign(() => rateLimitedValue(), {\n set,\n rateLimiter,\n }) as RateLimitedSignal<TValue, TSelected>\n\n return rateLimited\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,SAAgB,wBACd,OACA,gBACA,UACsC;CACtC,MAAM,6CAAkC,MAAM;CAE9C,MAAM,cAAcA,6CACjB,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,iBAAiB,OAAO,SAAqC;OAE7D,iBAAiB,IAAI,SAAS;IAGlC,gBACA,SACD;CAED,MAAM,OACJ,aACG;EACH,YAAY,aAAa,SAAS;;CAQpC,OALoB,OAAO,aAAa,kBAAkB,EAAE;EAC1D;EACA;EACD,CAEiB"}
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { AngularRateLimiter } from "./injectRateLimiter.cjs";
|
|
2
|
-
import { RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
|
|
3
|
-
|
|
4
|
-
//#region src/rate-limiter/injectRateLimitedSignal.d.ts
|
|
5
|
-
type Setter<T> = (value: T | ((prev: T) => T)) => void;
|
|
6
|
-
interface RateLimitedSignal<TValue, TSelected = {}> {
|
|
7
|
-
(): TValue;
|
|
8
|
-
set: Setter<TValue>;
|
|
9
|
-
rateLimiter: AngularRateLimiter<Setter<TValue>, TSelected>;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality.
|
|
13
|
-
* This function provides both the current rate-limited value and methods to update it.
|
|
14
|
-
*
|
|
15
|
-
* Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
|
|
16
|
-
* subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
|
|
17
|
-
* or intelligently collapse updates.
|
|
18
|
-
*
|
|
19
|
-
* The function returns a callable object:
|
|
20
|
-
* - `rateLimited()`: Get the current rate-limited value
|
|
21
|
-
* - `rateLimited.set(...)`: Set or update the rate-limited value (rate-limited via maybeExecute)
|
|
22
|
-
* - `rateLimited.rateLimiter`: The rate limiter instance with additional control methods and state signals
|
|
23
|
-
*
|
|
24
|
-
* ## State Management and Selector
|
|
25
|
-
*
|
|
26
|
-
* The function uses TanStack Store for reactive state management via the underlying rate limiter instance.
|
|
27
|
-
* The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,
|
|
28
|
-
* optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
|
|
29
|
-
*
|
|
30
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
31
|
-
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
32
|
-
* full control over when your component tracks state changes.
|
|
33
|
-
*
|
|
34
|
-
* @example
|
|
35
|
-
* ```ts
|
|
36
|
-
* // Default behavior - no reactive state subscriptions
|
|
37
|
-
* const rateLimited = injectRateLimitedSignal(0, {
|
|
38
|
-
* limit: 5,
|
|
39
|
-
* window: 60000,
|
|
40
|
-
* windowType: 'sliding'
|
|
41
|
-
* });
|
|
42
|
-
*
|
|
43
|
-
* // Opt-in to reactive updates when limit state changes
|
|
44
|
-
* const rateLimited = injectRateLimitedSignal(
|
|
45
|
-
* 0,
|
|
46
|
-
* { limit: 5, window: 60000 },
|
|
47
|
-
* (state) => ({ rejectionCount: state.rejectionCount })
|
|
48
|
-
* );
|
|
49
|
-
* ```
|
|
50
|
-
*/
|
|
51
|
-
declare function injectRateLimitedSignal<TValue, TSelected = {}>(value: TValue, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): RateLimitedSignal<TValue, TSelected>;
|
|
52
|
-
//#endregion
|
|
53
|
-
export { RateLimitedSignal, injectRateLimitedSignal };
|
|
54
|
-
//# sourceMappingURL=injectRateLimitedSignal.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedSignal.js","names":[],"sources":["../../src/rate-limiter/injectRateLimitedSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectRateLimiter } from './injectRateLimiter'\nimport type { AngularRateLimiter } from './injectRateLimiter'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport interface RateLimitedSignal<TValue, TSelected = {}> {\n (): TValue\n set: Setter<TValue>\n rateLimiter: AngularRateLimiter<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality.\n * This function provides both the current rate-limited value and methods to update it.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates.\n *\n * The function returns a callable object:\n * - `rateLimited()`: Get the current rate-limited value\n * - `rateLimited.set(...)`: Set or update the rate-limited value (rate-limited via maybeExecute)\n * - `rateLimited.rateLimiter`: The rate limiter instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const rateLimited = injectRateLimitedSignal(0, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when limit state changes\n * const rateLimited = injectRateLimitedSignal(\n * 0,\n * { limit: 5, window: 60000 },\n * (state) => ({ rejectionCount: state.rejectionCount })\n * );\n * ```\n */\nexport function injectRateLimitedSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected> {\n const rateLimitedValue = signal<TValue>(value)\n\n const rateLimiter = injectRateLimiter(\n (newValue: TValue | ((prev: TValue) => TValue)) => {\n if (typeof newValue === 'function') {\n rateLimitedValue.update(newValue as (prev: TValue) => TValue)\n } else {\n rateLimitedValue.set(newValue)\n }\n },\n initialOptions,\n selector,\n )\n\n const set: Setter<TValue> = (\n newValue: TValue | ((prev: TValue) => TValue),\n ) => {\n rateLimiter.maybeExecute(newValue)\n }\n\n const rateLimited = Object.assign(() => rateLimitedValue(), {\n set,\n rateLimiter,\n }) as RateLimitedSignal<TValue, TSelected>\n\n return rateLimited\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,SAAgB,wBACd,OACA,gBACA,UACsC;CACtC,MAAM,mBAAmB,OAAe,MAAM;CAE9C,MAAM,cAAc,mBACjB,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,iBAAiB,OAAO,SAAqC;OAE7D,iBAAiB,IAAI,SAAS;IAGlC,gBACA,SACD;CAED,MAAM,OACJ,aACG;EACH,YAAY,aAAa,SAAS;;CAQpC,OALoB,OAAO,aAAa,kBAAkB,EAAE;EAC1D;EACA;EACD,CAEiB"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
const require_injectRateLimitedSignal = require('./injectRateLimitedSignal.cjs');
|
|
2
|
-
let _angular_core = require("@angular/core");
|
|
3
|
-
|
|
4
|
-
//#region src/rate-limiter/injectRateLimitedValue.ts
|
|
5
|
-
function injectRateLimitedValue(value, initialValueOrOptions, initialOptionsOrSelector, maybeSelector) {
|
|
6
|
-
const hasInitialValue = initialOptionsOrSelector !== void 0 && !(typeof initialOptionsOrSelector === "function") || maybeSelector !== void 0;
|
|
7
|
-
const rateLimited = require_injectRateLimitedSignal.injectRateLimitedSignal(hasInitialValue ? initialValueOrOptions : void 0, hasInitialValue ? initialOptionsOrSelector : initialValueOrOptions, hasInitialValue ? maybeSelector : initialOptionsOrSelector);
|
|
8
|
-
(0, _angular_core.effect)(() => {
|
|
9
|
-
const latest = value();
|
|
10
|
-
rateLimited.set(latest);
|
|
11
|
-
});
|
|
12
|
-
return rateLimited;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
//#endregion
|
|
16
|
-
exports.injectRateLimitedValue = injectRateLimitedValue;
|
|
17
|
-
//# sourceMappingURL=injectRateLimitedValue.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedValue.cjs","names":["injectRateLimitedSignal"],"sources":["../../src/rate-limiter/injectRateLimitedValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectRateLimitedSignal } from './injectRateLimitedSignal'\nimport type { RateLimitedSignal } from './injectRateLimitedSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window.\n * Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal\n * and updates the rate-limited value accordingly.\n *\n * The rate-limited value will update according to the configured rate limit, blocking updates\n * once the limit is reached until the window resets.\n *\n * The function returns a rate-limited signal object containing:\n * - A Signal that provides the current rate-limited value\n * - The rate limiter instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const value = signal(0)\n * const rateLimited = injectRateLimitedValue(value, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding',\n * })\n *\n * // rateLimited() will update at most 5 times per 60 seconds\n * effect(() => {\n * updateUI(rateLimited())\n * })\n * ```\n */\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected>\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValue: TValue,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected>\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValueOrOptions: TValue | RateLimiterOptions<Setter<TValue>>,\n initialOptionsOrSelector?:\n | RateLimiterOptions<Setter<TValue>>\n | ((state: RateLimiterState) => TSelected),\n maybeSelector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected> {\n const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n const hasInitialValue =\n (initialOptionsOrSelector !== undefined && !hasSelector) ||\n maybeSelector !== undefined\n\n const initialValue = hasInitialValue\n ? (initialValueOrOptions as TValue)\n : (undefined as unknown as TValue)\n const initialOptions = hasInitialValue\n ? (initialOptionsOrSelector as RateLimiterOptions<Setter<TValue>>)\n : (initialValueOrOptions as RateLimiterOptions<Setter<TValue>>)\n const selector = hasInitialValue\n ? maybeSelector\n : (initialOptionsOrSelector as\n | ((state: RateLimiterState) => TSelected)\n | undefined)\n\n const rateLimited = injectRateLimitedSignal(\n initialValue,\n initialOptions,\n selector,\n )\n\n effect(() => {\n const latest = value()\n rateLimited.set(latest)\n })\n\n return rateLimited\n}\n"],"mappings":";;;;AA4DA,SAAgB,uBACd,OACA,uBACA,0BAGA,eACsC;CAGtC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,cAAcA,wDAZC,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;CAED,gCAAa;EACX,MAAM,SAAS,OAAO;EACtB,YAAY,IAAI,OAAO;GACvB;CAEF,OAAO"}
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
import { RateLimitedSignal } from "./injectRateLimitedSignal.cjs";
|
|
2
|
-
import { Signal } from "@angular/core";
|
|
3
|
-
import { RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
|
|
4
|
-
|
|
5
|
-
//#region src/rate-limiter/injectRateLimitedValue.d.ts
|
|
6
|
-
type Setter<T> = (value: T | ((prev: T) => T)) => void;
|
|
7
|
-
/**
|
|
8
|
-
* An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window.
|
|
9
|
-
* Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal
|
|
10
|
-
* and updates the rate-limited value accordingly.
|
|
11
|
-
*
|
|
12
|
-
* The rate-limited value will update according to the configured rate limit, blocking updates
|
|
13
|
-
* once the limit is reached until the window resets.
|
|
14
|
-
*
|
|
15
|
-
* The function returns a rate-limited signal object containing:
|
|
16
|
-
* - A Signal that provides the current rate-limited value
|
|
17
|
-
* - The rate limiter instance with control methods
|
|
18
|
-
*
|
|
19
|
-
* ## State Management and Selector
|
|
20
|
-
*
|
|
21
|
-
* The function uses TanStack Store for reactive state management via the underlying rate limiter instance.
|
|
22
|
-
* The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,
|
|
23
|
-
* optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
|
|
24
|
-
*
|
|
25
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
26
|
-
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
27
|
-
* full control over when your component tracks state changes.
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* ```ts
|
|
31
|
-
* // Default behavior - no reactive state subscriptions
|
|
32
|
-
* const value = signal(0)
|
|
33
|
-
* const rateLimited = injectRateLimitedValue(value, {
|
|
34
|
-
* limit: 5,
|
|
35
|
-
* window: 60000,
|
|
36
|
-
* windowType: 'sliding',
|
|
37
|
-
* })
|
|
38
|
-
*
|
|
39
|
-
* // rateLimited() will update at most 5 times per 60 seconds
|
|
40
|
-
* effect(() => {
|
|
41
|
-
* updateUI(rateLimited())
|
|
42
|
-
* })
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
declare function injectRateLimitedValue<TValue, TSelected = {}>(value: Signal<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): RateLimitedSignal<TValue, TSelected>;
|
|
46
|
-
declare function injectRateLimitedValue<TValue, TSelected = {}>(value: Signal<TValue>, initialValue: TValue, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): RateLimitedSignal<TValue, TSelected>;
|
|
47
|
-
//#endregion
|
|
48
|
-
export { injectRateLimitedValue };
|
|
49
|
-
//# sourceMappingURL=injectRateLimitedValue.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimitedValue.js","names":[],"sources":["../../src/rate-limiter/injectRateLimitedValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectRateLimitedSignal } from './injectRateLimitedSignal'\nimport type { RateLimitedSignal } from './injectRateLimitedSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window.\n * Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal\n * and updates the rate-limited value accordingly.\n *\n * The rate-limited value will update according to the configured rate limit, blocking updates\n * once the limit is reached until the window resets.\n *\n * The function returns a rate-limited signal object containing:\n * - A Signal that provides the current rate-limited value\n * - The rate limiter instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const value = signal(0)\n * const rateLimited = injectRateLimitedValue(value, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding',\n * })\n *\n * // rateLimited() will update at most 5 times per 60 seconds\n * effect(() => {\n * updateUI(rateLimited())\n * })\n * ```\n */\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected>\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValue: TValue,\n initialOptions: RateLimiterOptions<Setter<TValue>>,\n selector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected>\nexport function injectRateLimitedValue<TValue, TSelected = {}>(\n value: Signal<TValue>,\n initialValueOrOptions: TValue | RateLimiterOptions<Setter<TValue>>,\n initialOptionsOrSelector?:\n | RateLimiterOptions<Setter<TValue>>\n | ((state: RateLimiterState) => TSelected),\n maybeSelector?: (state: RateLimiterState) => TSelected,\n): RateLimitedSignal<TValue, TSelected> {\n const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n const hasInitialValue =\n (initialOptionsOrSelector !== undefined && !hasSelector) ||\n maybeSelector !== undefined\n\n const initialValue = hasInitialValue\n ? (initialValueOrOptions as TValue)\n : (undefined as unknown as TValue)\n const initialOptions = hasInitialValue\n ? (initialOptionsOrSelector as RateLimiterOptions<Setter<TValue>>)\n : (initialValueOrOptions as RateLimiterOptions<Setter<TValue>>)\n const selector = hasInitialValue\n ? maybeSelector\n : (initialOptionsOrSelector as\n | ((state: RateLimiterState) => TSelected)\n | undefined)\n\n const rateLimited = injectRateLimitedSignal(\n initialValue,\n initialOptions,\n selector,\n )\n\n effect(() => {\n const latest = value()\n rateLimited.set(latest)\n })\n\n return rateLimited\n}\n"],"mappings":";;;;AA4DA,SAAgB,uBACd,OACA,uBACA,0BAGA,eACsC;CAGtC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,cAAc,wBAZC,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;CAED,aAAa;EACX,MAAM,SAAS,OAAO;EACtB,YAAY,IAAI,OAAO;GACvB;CAEF,OAAO"}
|
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
const require_pacer_context = require('../provider/pacer-context.cjs');
|
|
2
|
-
let _angular_core = require("@angular/core");
|
|
3
|
-
let _tanstack_angular_store = require("@tanstack/angular-store");
|
|
4
|
-
let _tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
|
|
5
|
-
|
|
6
|
-
//#region src/rate-limiter/injectRateLimiter.ts
|
|
7
|
-
/**
|
|
8
|
-
* An Angular function that creates and manages a RateLimiter instance.
|
|
9
|
-
*
|
|
10
|
-
* This is a lower-level function that provides direct access to the RateLimiter's functionality.
|
|
11
|
-
* This allows you to integrate it with any state management solution you prefer.
|
|
12
|
-
*
|
|
13
|
-
* Rate limiting is a simple "hard limit" approach that allows executions until a maximum count is reached within
|
|
14
|
-
* a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
|
|
15
|
-
* it does not attempt to space out or collapse executions intelligently.
|
|
16
|
-
*
|
|
17
|
-
* The rate limiter supports two types of windows:
|
|
18
|
-
* - 'fixed': A strict window that resets after the window period. All executions within the window count
|
|
19
|
-
* towards the limit, and the window resets completely after the period.
|
|
20
|
-
* - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
|
|
21
|
-
* consistent rate of execution over time.
|
|
22
|
-
*
|
|
23
|
-
* For smoother execution patterns:
|
|
24
|
-
* - Use throttling when you want consistent spacing between executions (e.g. UI updates)
|
|
25
|
-
* - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
|
|
26
|
-
* - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
|
|
27
|
-
*
|
|
28
|
-
* ## State Management and Selector
|
|
29
|
-
*
|
|
30
|
-
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
31
|
-
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
32
|
-
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
33
|
-
*
|
|
34
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
35
|
-
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
36
|
-
* full control over when your component tracks state changes.
|
|
37
|
-
*
|
|
38
|
-
* Available state properties:
|
|
39
|
-
* - `executionCount`: Number of function executions that have been completed
|
|
40
|
-
* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
|
|
41
|
-
* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
|
|
42
|
-
*
|
|
43
|
-
* ## Cleanup on Destroy
|
|
44
|
-
*
|
|
45
|
-
* Use the `onUnmount` option to run a callback when the component is destroyed.
|
|
46
|
-
*
|
|
47
|
-
* @example
|
|
48
|
-
* ```ts
|
|
49
|
-
* // Default behavior - no reactive state subscriptions
|
|
50
|
-
* const rateLimiter = injectRateLimiter(apiCall, {
|
|
51
|
-
* limit: 5,
|
|
52
|
-
* window: 60000,
|
|
53
|
-
* windowType: 'sliding',
|
|
54
|
-
* });
|
|
55
|
-
*
|
|
56
|
-
* // Opt-in to track execution count changes
|
|
57
|
-
* const rateLimiter = injectRateLimiter(
|
|
58
|
-
* apiCall,
|
|
59
|
-
* {
|
|
60
|
-
* limit: 5,
|
|
61
|
-
* window: 60000,
|
|
62
|
-
* windowType: 'sliding',
|
|
63
|
-
* },
|
|
64
|
-
* (state) => ({ executionCount: state.executionCount })
|
|
65
|
-
* );
|
|
66
|
-
*
|
|
67
|
-
* // Monitor rate limit status
|
|
68
|
-
* const handleClick = () => {
|
|
69
|
-
* const remaining = rateLimiter.getRemainingInWindow();
|
|
70
|
-
* if (remaining > 0) {
|
|
71
|
-
* rateLimiter.maybeExecute(data);
|
|
72
|
-
* } else {
|
|
73
|
-
* showRateLimitWarning();
|
|
74
|
-
* }
|
|
75
|
-
* };
|
|
76
|
-
*
|
|
77
|
-
* // Access the selected state (will be empty object {} unless selector provided)
|
|
78
|
-
* const { executionCount, rejectionCount } = rateLimiter.state();
|
|
79
|
-
* ```
|
|
80
|
-
*/
|
|
81
|
-
function injectRateLimiter(fn, options, selector = () => ({})) {
|
|
82
|
-
const mergedOptions = {
|
|
83
|
-
...require_pacer_context.injectPacerOptions().rateLimiter,
|
|
84
|
-
...options
|
|
85
|
-
};
|
|
86
|
-
const rateLimiter = new _tanstack_pacer_rate_limiter.RateLimiter(fn, mergedOptions);
|
|
87
|
-
const state = (0, _tanstack_angular_store.injectSelector)(rateLimiter.store, selector);
|
|
88
|
-
const result = {
|
|
89
|
-
...rateLimiter,
|
|
90
|
-
state
|
|
91
|
-
};
|
|
92
|
-
(0, _angular_core.inject)(_angular_core.DestroyRef, { optional: true })?.onDestroy(() => {
|
|
93
|
-
if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
|
|
94
|
-
});
|
|
95
|
-
return result;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
//#endregion
|
|
99
|
-
exports.injectRateLimiter = injectRateLimiter;
|
|
100
|
-
//# sourceMappingURL=injectRateLimiter.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"injectRateLimiter.cjs","names":["injectPacerOptions","RateLimiter","DestroyRef"],"sources":["../../src/rate-limiter/injectRateLimiter.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } from '@tanstack/angular-store'\nimport { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n RateLimiterOptions,\n RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\nexport interface AngularRateLimiterOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends RateLimiterOptions<TFn> {\n /**\n * Optional callback invoked when the component is destroyed. Receives the rate limiter instance.\n */\n onUnmount?: (rateLimiter: AngularRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface AngularRateLimiter<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\n /**\n * Reactive state signal that will be updated when the rate limiter state changes\n *\n * Use this instead of `rateLimiter.store.state`\n */\n readonly state: Signal<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 in Angular signals.\n */\n readonly store: Store<Readonly<RateLimiterState>>\n}\n\n/**\n * An Angular function that creates and manages a RateLimiter instance.\n *\n * This is a lower-level function that provides direct access to the RateLimiter's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n * towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n * consistent rate of execution over time.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n *\n * ## Cleanup on Destroy\n *\n * Use the `onUnmount` option to run a callback when the component is destroyed.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = injectRateLimiter(apiCall, {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding',\n * });\n *\n * // Opt-in to track execution count changes\n * const rateLimiter = injectRateLimiter(\n * apiCall,\n * {\n * limit: 5,\n * window: 60000,\n * windowType: 'sliding',\n * },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n * const remaining = rateLimiter.getRemainingInWindow();\n * if (remaining > 0) {\n * rateLimiter.maybeExecute(data);\n * } else {\n * showRateLimitWarning();\n * }\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, rejectionCount } = rateLimiter.state();\n * ```\n */\nexport function injectRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: AngularRateLimiterOptions<TFn, TSelected>,\n selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): AngularRateLimiter<TFn, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().rateLimiter,\n ...options,\n } as AngularRateLimiterOptions<TFn, TSelected>\n\n const rateLimiter = new RateLimiter<TFn>(fn, mergedOptions)\n const state = injectSelector(rateLimiter.store, selector)\n\n const result = {\n ...rateLimiter,\n state,\n } as AngularRateLimiter<TFn, TSelected>\n\n const destroyRef = inject(DestroyRef, { optional: true })\n destroyRef?.onDestroy(() => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(result)\n }\n })\n\n return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiHA,SAAgB,kBACd,IACA,SACA,kBAA0D,EAAE,GACxB;CACpC,MAAM,gBAAgB;EACpB,GAAGA,0CAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,cAAc,IAAIC,yCAAiB,IAAI,cAAc;CAC3D,MAAM,oDAAuB,YAAY,OAAO,SAAS;CAEzD,MAAM,SAAS;EACb,GAAG;EACH;EACD;CAGD,0BAD0BC,0BAAY,EAAE,UAAU,MAAM,CAC9C,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;GAEjC;CAEF,OAAO"}
|