@tanstack/angular-pacer 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +165 -0
- package/dist/async-batcher/index.cjs +13 -0
- package/dist/async-batcher/index.d.cts +4 -0
- package/dist/async-batcher/index.d.ts +4 -0
- package/dist/async-batcher/index.js +6 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.cjs +49 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.cjs.map +1 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.d.cts +45 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.d.ts +45 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.js +49 -0
- package/dist/async-batcher/injectAsyncBatchedCallback.js.map +1 -0
- package/dist/async-batcher/injectAsyncBatcher.cjs +61 -0
- package/dist/async-batcher/injectAsyncBatcher.cjs.map +1 -0
- package/dist/async-batcher/injectAsyncBatcher.d.cts +63 -0
- package/dist/async-batcher/injectAsyncBatcher.d.ts +63 -0
- package/dist/async-batcher/injectAsyncBatcher.js +61 -0
- package/dist/async-batcher/injectAsyncBatcher.js.map +1 -0
- package/dist/async-debouncer/index.cjs +13 -0
- package/dist/async-debouncer/index.d.cts +4 -0
- package/dist/async-debouncer/index.d.ts +4 -0
- package/dist/async-debouncer/index.js +6 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs +49 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.cjs.map +1 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.d.cts +43 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.d.ts +43 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.js +49 -0
- package/dist/async-debouncer/injectAsyncDebouncedCallback.js.map +1 -0
- package/dist/async-debouncer/injectAsyncDebouncer.cjs +83 -0
- package/dist/async-debouncer/injectAsyncDebouncer.cjs.map +1 -0
- package/dist/async-debouncer/injectAsyncDebouncer.d.cts +86 -0
- package/dist/async-debouncer/injectAsyncDebouncer.d.ts +86 -0
- package/dist/async-debouncer/injectAsyncDebouncer.js +83 -0
- package/dist/async-debouncer/injectAsyncDebouncer.js.map +1 -0
- package/dist/async-queuer/index.cjs +13 -0
- package/dist/async-queuer/index.d.cts +4 -0
- package/dist/async-queuer/index.d.ts +4 -0
- package/dist/async-queuer/index.js +6 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.cjs +53 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.cjs.map +1 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.d.cts +55 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.d.ts +55 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.js +53 -0
- package/dist/async-queuer/injectAsyncQueuedSignal.js.map +1 -0
- package/dist/async-queuer/injectAsyncQueuer.cjs +61 -0
- package/dist/async-queuer/injectAsyncQueuer.cjs.map +1 -0
- package/dist/async-queuer/injectAsyncQueuer.d.cts +63 -0
- package/dist/async-queuer/injectAsyncQueuer.d.ts +63 -0
- package/dist/async-queuer/injectAsyncQueuer.js +61 -0
- package/dist/async-queuer/injectAsyncQueuer.js.map +1 -0
- package/dist/async-rate-limiter/index.cjs +13 -0
- package/dist/async-rate-limiter/index.d.cts +4 -0
- package/dist/async-rate-limiter/index.d.ts +4 -0
- package/dist/async-rate-limiter/index.js +6 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs +52 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.cjs.map +1 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.cts +46 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.d.ts +46 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js +52 -0
- package/dist/async-rate-limiter/injectAsyncRateLimitedCallback.js.map +1 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs +57 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.cjs.map +1 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.d.cts +60 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.d.ts +60 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.js +57 -0
- package/dist/async-rate-limiter/injectAsyncRateLimiter.js.map +1 -0
- package/dist/async-retryer/index.cjs +9 -0
- package/dist/async-retryer/index.d.cts +1 -0
- package/dist/async-retryer/index.d.ts +1 -0
- package/dist/async-retryer/index.js +3 -0
- package/dist/async-throttler/index.cjs +13 -0
- package/dist/async-throttler/index.d.cts +4 -0
- package/dist/async-throttler/index.d.ts +4 -0
- package/dist/async-throttler/index.js +6 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.cjs +50 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.cjs.map +1 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.d.cts +44 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.d.ts +44 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.js +50 -0
- package/dist/async-throttler/injectAsyncThrottledCallback.js.map +1 -0
- package/dist/async-throttler/injectAsyncThrottler.cjs +62 -0
- package/dist/async-throttler/injectAsyncThrottler.cjs.map +1 -0
- package/dist/async-throttler/injectAsyncThrottler.d.cts +65 -0
- package/dist/async-throttler/injectAsyncThrottler.d.ts +65 -0
- package/dist/async-throttler/injectAsyncThrottler.js +62 -0
- package/dist/async-throttler/injectAsyncThrottler.js.map +1 -0
- package/dist/batcher/index.cjs +13 -0
- package/dist/batcher/index.d.cts +4 -0
- package/dist/batcher/index.d.ts +4 -0
- package/dist/batcher/index.js +6 -0
- package/dist/batcher/injectBatchedCallback.cjs +47 -0
- package/dist/batcher/injectBatchedCallback.cjs.map +1 -0
- package/dist/batcher/injectBatchedCallback.d.cts +43 -0
- package/dist/batcher/injectBatchedCallback.d.ts +43 -0
- package/dist/batcher/injectBatchedCallback.js +47 -0
- package/dist/batcher/injectBatchedCallback.js.map +1 -0
- package/dist/batcher/injectBatcher.cjs +56 -0
- package/dist/batcher/injectBatcher.cjs.map +1 -0
- package/dist/batcher/injectBatcher.d.cts +58 -0
- package/dist/batcher/injectBatcher.d.ts +58 -0
- package/dist/batcher/injectBatcher.js +56 -0
- package/dist/batcher/injectBatcher.js.map +1 -0
- package/dist/debouncer/index.cjs +17 -0
- package/dist/debouncer/index.d.cts +6 -0
- package/dist/debouncer/index.d.ts +6 -0
- package/dist/debouncer/index.js +8 -0
- package/dist/debouncer/injectDebouncedCallback.cjs +46 -0
- package/dist/debouncer/injectDebouncedCallback.cjs.map +1 -0
- package/dist/debouncer/injectDebouncedCallback.d.cts +43 -0
- package/dist/debouncer/injectDebouncedCallback.d.ts +43 -0
- package/dist/debouncer/injectDebouncedCallback.js +46 -0
- package/dist/debouncer/injectDebouncedCallback.js.map +1 -0
- package/dist/debouncer/injectDebouncedSignal.cjs +68 -0
- package/dist/debouncer/injectDebouncedSignal.cjs.map +1 -0
- package/dist/debouncer/injectDebouncedSignal.d.cts +65 -0
- package/dist/debouncer/injectDebouncedSignal.d.ts +65 -0
- package/dist/debouncer/injectDebouncedSignal.js +68 -0
- package/dist/debouncer/injectDebouncedSignal.js.map +1 -0
- package/dist/debouncer/injectDebouncedValue.cjs +17 -0
- package/dist/debouncer/injectDebouncedValue.cjs.map +1 -0
- package/dist/debouncer/injectDebouncedValue.d.cts +76 -0
- package/dist/debouncer/injectDebouncedValue.d.ts +76 -0
- package/dist/debouncer/injectDebouncedValue.js +17 -0
- package/dist/debouncer/injectDebouncedValue.js.map +1 -0
- package/dist/debouncer/injectDebouncer.cjs +76 -0
- package/dist/debouncer/injectDebouncer.cjs.map +1 -0
- package/dist/debouncer/injectDebouncer.d.cts +79 -0
- package/dist/debouncer/injectDebouncer.d.ts +79 -0
- package/dist/debouncer/injectDebouncer.js +76 -0
- package/dist/debouncer/injectDebouncer.js.map +1 -0
- package/dist/index.cjs +65 -0
- package/dist/index.d.cts +30 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.js +32 -0
- package/dist/provider/index.cjs +7 -0
- package/dist/provider/index.d.cts +3 -0
- package/dist/provider/index.d.ts +3 -0
- package/dist/provider/index.js +4 -0
- package/dist/provider/pacer-context.cjs +20 -0
- package/dist/provider/pacer-context.cjs.map +1 -0
- package/dist/provider/pacer-context.d.cts +21 -0
- package/dist/provider/pacer-context.d.ts +21 -0
- package/dist/provider/pacer-context.js +19 -0
- package/dist/provider/pacer-context.js.map +1 -0
- package/dist/provider/pacer-provider.cjs +41 -0
- package/dist/provider/pacer-provider.cjs.map +1 -0
- package/dist/provider/pacer-provider.d.cts +36 -0
- package/dist/provider/pacer-provider.d.ts +36 -0
- package/dist/provider/pacer-provider.js +41 -0
- package/dist/provider/pacer-provider.js.map +1 -0
- package/dist/queuer/index.cjs +15 -0
- package/dist/queuer/index.d.cts +5 -0
- package/dist/queuer/index.d.ts +5 -0
- package/dist/queuer/index.js +7 -0
- package/dist/queuer/injectQueuedSignal.cjs +47 -0
- package/dist/queuer/injectQueuedSignal.cjs.map +1 -0
- package/dist/queuer/injectQueuedSignal.d.cts +49 -0
- package/dist/queuer/injectQueuedSignal.d.ts +49 -0
- package/dist/queuer/injectQueuedSignal.js +47 -0
- package/dist/queuer/injectQueuedSignal.js.map +1 -0
- package/dist/queuer/injectQueuedValue.cjs +23 -0
- package/dist/queuer/injectQueuedValue.cjs.map +1 -0
- package/dist/queuer/injectQueuedValue.d.cts +34 -0
- package/dist/queuer/injectQueuedValue.d.ts +34 -0
- package/dist/queuer/injectQueuedValue.js +23 -0
- package/dist/queuer/injectQueuedValue.js.map +1 -0
- package/dist/queuer/injectQueuer.cjs +61 -0
- package/dist/queuer/injectQueuer.cjs.map +1 -0
- package/dist/queuer/injectQueuer.d.cts +63 -0
- package/dist/queuer/injectQueuer.d.ts +63 -0
- package/dist/queuer/injectQueuer.js +61 -0
- package/dist/queuer/injectQueuer.js.map +1 -0
- package/dist/rate-limiter/index.cjs +17 -0
- package/dist/rate-limiter/index.d.cts +6 -0
- package/dist/rate-limiter/index.d.ts +6 -0
- package/dist/rate-limiter/index.js +8 -0
- package/dist/rate-limiter/injectRateLimitedCallback.cjs +45 -0
- package/dist/rate-limiter/injectRateLimitedCallback.cjs.map +1 -0
- package/dist/rate-limiter/injectRateLimitedCallback.d.cts +42 -0
- package/dist/rate-limiter/injectRateLimitedCallback.d.ts +42 -0
- package/dist/rate-limiter/injectRateLimitedCallback.js +45 -0
- package/dist/rate-limiter/injectRateLimitedCallback.js.map +1 -0
- package/dist/rate-limiter/injectRateLimitedSignal.cjs +62 -0
- package/dist/rate-limiter/injectRateLimitedSignal.cjs.map +1 -0
- package/dist/rate-limiter/injectRateLimitedSignal.d.cts +59 -0
- package/dist/rate-limiter/injectRateLimitedSignal.d.ts +59 -0
- package/dist/rate-limiter/injectRateLimitedSignal.js +62 -0
- package/dist/rate-limiter/injectRateLimitedSignal.js.map +1 -0
- package/dist/rate-limiter/injectRateLimitedValue.cjs +17 -0
- package/dist/rate-limiter/injectRateLimitedValue.cjs.map +1 -0
- package/dist/rate-limiter/injectRateLimitedValue.d.cts +49 -0
- package/dist/rate-limiter/injectRateLimitedValue.d.ts +49 -0
- package/dist/rate-limiter/injectRateLimitedValue.js +17 -0
- package/dist/rate-limiter/injectRateLimitedValue.js.map +1 -0
- package/dist/rate-limiter/injectRateLimiter.cjs +90 -0
- package/dist/rate-limiter/injectRateLimiter.cjs.map +1 -0
- package/dist/rate-limiter/injectRateLimiter.d.cts +93 -0
- package/dist/rate-limiter/injectRateLimiter.d.ts +93 -0
- package/dist/rate-limiter/injectRateLimiter.js +90 -0
- package/dist/rate-limiter/injectRateLimiter.js.map +1 -0
- package/dist/throttler/index.cjs +17 -0
- package/dist/throttler/index.d.cts +6 -0
- package/dist/throttler/index.d.ts +6 -0
- package/dist/throttler/index.js +8 -0
- package/dist/throttler/injectThrottledCallback.cjs +45 -0
- package/dist/throttler/injectThrottledCallback.cjs.map +1 -0
- package/dist/throttler/injectThrottledCallback.d.cts +42 -0
- package/dist/throttler/injectThrottledCallback.d.ts +42 -0
- package/dist/throttler/injectThrottledCallback.js +45 -0
- package/dist/throttler/injectThrottledCallback.js.map +1 -0
- package/dist/throttler/injectThrottledSignal.cjs +69 -0
- package/dist/throttler/injectThrottledSignal.cjs.map +1 -0
- package/dist/throttler/injectThrottledSignal.d.cts +66 -0
- package/dist/throttler/injectThrottledSignal.d.ts +66 -0
- package/dist/throttler/injectThrottledSignal.js +69 -0
- package/dist/throttler/injectThrottledSignal.js.map +1 -0
- package/dist/throttler/injectThrottledValue.cjs +17 -0
- package/dist/throttler/injectThrottledValue.cjs.map +1 -0
- package/dist/throttler/injectThrottledValue.d.cts +74 -0
- package/dist/throttler/injectThrottledValue.d.ts +74 -0
- package/dist/throttler/injectThrottledValue.js +17 -0
- package/dist/throttler/injectThrottledValue.js.map +1 -0
- package/dist/throttler/injectThrottler.cjs +76 -0
- package/dist/throttler/injectThrottler.cjs.map +1 -0
- package/dist/throttler/injectThrottler.d.cts +79 -0
- package/dist/throttler/injectThrottler.d.ts +79 -0
- package/dist/throttler/injectThrottler.js +76 -0
- package/dist/throttler/injectThrottler.js.map +1 -0
- package/dist/types/index.cjs +9 -0
- package/dist/types/index.d.cts +1 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.js +3 -0
- package/dist/utils/index.cjs +9 -0
- package/dist/utils/index.d.cts +1 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +3 -0
- package/package.json +121 -0
- package/src/async-batcher/index.ts +4 -0
- package/src/async-batcher/injectAsyncBatchedCallback.ts +48 -0
- package/src/async-batcher/injectAsyncBatcher.ts +87 -0
- package/src/async-debouncer/index.ts +4 -0
- package/src/async-debouncer/injectAsyncDebouncedCallback.ts +50 -0
- package/src/async-debouncer/injectAsyncDebouncer.ts +113 -0
- package/src/async-queuer/index.ts +4 -0
- package/src/async-queuer/injectAsyncQueuedSignal.ts +82 -0
- package/src/async-queuer/injectAsyncQueuer.ts +87 -0
- package/src/async-rate-limiter/index.ts +4 -0
- package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts +52 -0
- package/src/async-rate-limiter/injectAsyncRateLimiter.ts +87 -0
- package/src/async-retryer/index.ts +1 -0
- package/src/async-throttler/index.ts +4 -0
- package/src/async-throttler/injectAsyncThrottledCallback.ts +50 -0
- package/src/async-throttler/injectAsyncThrottler.ts +92 -0
- package/src/batcher/index.ts +4 -0
- package/src/batcher/injectBatchedCallback.ts +46 -0
- package/src/batcher/injectBatcher.ts +79 -0
- package/src/debouncer/index.ts +6 -0
- package/src/debouncer/injectDebouncedCallback.ts +46 -0
- package/src/debouncer/injectDebouncedSignal.ts +101 -0
- package/src/debouncer/injectDebouncedValue.ts +126 -0
- package/src/debouncer/injectDebouncer.ts +102 -0
- package/src/index.ts +40 -0
- package/src/provider/index.ts +2 -0
- package/src/provider/pacer-context.ts +46 -0
- package/src/provider/pacer-provider.ts +38 -0
- package/src/queuer/index.ts +5 -0
- package/src/queuer/injectQueuedSignal.ts +70 -0
- package/src/queuer/injectQueuedValue.ts +101 -0
- package/src/queuer/injectQueuer.ts +83 -0
- package/src/rate-limiter/index.ts +6 -0
- package/src/rate-limiter/injectRateLimitedCallback.ts +45 -0
- package/src/rate-limiter/injectRateLimitedSignal.ts +95 -0
- package/src/rate-limiter/injectRateLimitedValue.ts +99 -0
- package/src/rate-limiter/injectRateLimiter.ts +116 -0
- package/src/throttler/index.ts +6 -0
- package/src/throttler/injectThrottledCallback.ts +45 -0
- package/src/throttler/injectThrottledSignal.ts +102 -0
- package/src/throttler/injectThrottledValue.ts +124 -0
- package/src/throttler/injectThrottler.ts +102 -0
- package/src/types/index.ts +1 -0
- package/src/utils/index.ts +1 -0
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
const require_pacer_context = require('../provider/pacer-context.cjs');
|
|
2
|
+
let _tanstack_angular_store = require("@tanstack/angular-store");
|
|
3
|
+
let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
|
|
4
|
+
|
|
5
|
+
//#region src/batcher/injectBatcher.ts
|
|
6
|
+
/**
|
|
7
|
+
* An Angular function that creates and manages a Batcher instance.
|
|
8
|
+
*
|
|
9
|
+
* This is a lower-level function that provides direct access to the Batcher's functionality.
|
|
10
|
+
* This allows you to integrate it with any state management solution you prefer.
|
|
11
|
+
*
|
|
12
|
+
* The Batcher collects items and processes them in batches based on configurable conditions:
|
|
13
|
+
* - Maximum batch size
|
|
14
|
+
* - Time-based batching (process after X milliseconds)
|
|
15
|
+
* - Custom batch processing logic via getShouldExecute
|
|
16
|
+
*
|
|
17
|
+
* ## State Management and Selector
|
|
18
|
+
*
|
|
19
|
+
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
20
|
+
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
21
|
+
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
22
|
+
*
|
|
23
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
24
|
+
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
25
|
+
* full control over when your component tracks state changes.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* // Default behavior - no reactive state subscriptions
|
|
30
|
+
* const batcher = injectBatcher(
|
|
31
|
+
* (items) => console.log('Processing batch:', items),
|
|
32
|
+
* { maxSize: 5, wait: 2000 }
|
|
33
|
+
* );
|
|
34
|
+
*
|
|
35
|
+
* // Add items
|
|
36
|
+
* batcher.addItem('task1');
|
|
37
|
+
*
|
|
38
|
+
* // Access the selected state
|
|
39
|
+
* const { items, isPending } = batcher.state();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
function injectBatcher(fn, options = {}, selector = () => ({})) {
|
|
43
|
+
const batcher = new _tanstack_pacer_batcher.Batcher(fn, {
|
|
44
|
+
...require_pacer_context.injectPacerOptions().batcher,
|
|
45
|
+
...options
|
|
46
|
+
});
|
|
47
|
+
const state = (0, _tanstack_angular_store.injectStore)(batcher.store, selector);
|
|
48
|
+
return {
|
|
49
|
+
...batcher,
|
|
50
|
+
state
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
//#endregion
|
|
55
|
+
exports.injectBatcher = injectBatcher;
|
|
56
|
+
//# sourceMappingURL=injectBatcher.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectBatcher.cjs","names":["Batcher","injectPacerOptions"],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\n /**\n * Reactive state signal that will be updated when the batcher state changes\n *\n * Use this instead of `batcher.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n * The state on the store object is not reactive in Angular signals.\n */\n readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => void,\n options: BatcherOptions<TValue> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().batcher,\n ...options,\n } as BatcherOptions<TValue>\n\n const batcher = new Batcher<TValue>(fn, mergedOptions)\n const state = injectStore(batcher.store, selector)\n\n return {\n ...batcher,\n state,\n } as AngularBatcher<TValue, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,cACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC8B;CAMnC,MAAM,UAAU,IAAIA,gCAAgB,IALd;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAEqD;CACtD,MAAM,iDAAoB,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { Signal } from "@angular/core";
|
|
2
|
+
import { Store } from "@tanstack/store";
|
|
3
|
+
import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
|
|
4
|
+
|
|
5
|
+
//#region src/batcher/injectBatcher.d.ts
|
|
6
|
+
interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
|
|
7
|
+
/**
|
|
8
|
+
* Reactive state signal that will be updated when the batcher state changes
|
|
9
|
+
*
|
|
10
|
+
* Use this instead of `batcher.store.state`
|
|
11
|
+
*/
|
|
12
|
+
readonly state: Signal<Readonly<TSelected>>;
|
|
13
|
+
/**
|
|
14
|
+
* @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
|
|
15
|
+
* The state on the store object is not reactive in Angular signals.
|
|
16
|
+
*/
|
|
17
|
+
readonly store: Store<Readonly<BatcherState<TValue>>>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* An Angular function that creates and manages a Batcher instance.
|
|
21
|
+
*
|
|
22
|
+
* This is a lower-level function that provides direct access to the Batcher's functionality.
|
|
23
|
+
* This allows you to integrate it with any state management solution you prefer.
|
|
24
|
+
*
|
|
25
|
+
* The Batcher collects items and processes them in batches based on configurable conditions:
|
|
26
|
+
* - Maximum batch size
|
|
27
|
+
* - Time-based batching (process after X milliseconds)
|
|
28
|
+
* - Custom batch processing logic via getShouldExecute
|
|
29
|
+
*
|
|
30
|
+
* ## State Management and Selector
|
|
31
|
+
*
|
|
32
|
+
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
33
|
+
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
34
|
+
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
35
|
+
*
|
|
36
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
37
|
+
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
38
|
+
* full control over when your component tracks state changes.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* // Default behavior - no reactive state subscriptions
|
|
43
|
+
* const batcher = injectBatcher(
|
|
44
|
+
* (items) => console.log('Processing batch:', items),
|
|
45
|
+
* { maxSize: 5, wait: 2000 }
|
|
46
|
+
* );
|
|
47
|
+
*
|
|
48
|
+
* // Add items
|
|
49
|
+
* batcher.addItem('task1');
|
|
50
|
+
*
|
|
51
|
+
* // Access the selected state
|
|
52
|
+
* const { items, isPending } = batcher.state();
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
|
|
56
|
+
//#endregion
|
|
57
|
+
export { AngularBatcher, injectBatcher };
|
|
58
|
+
//# sourceMappingURL=injectBatcher.d.cts.map
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { Signal } from "@angular/core";
|
|
2
|
+
import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
|
|
3
|
+
import { Store } from "@tanstack/store";
|
|
4
|
+
|
|
5
|
+
//#region src/batcher/injectBatcher.d.ts
|
|
6
|
+
interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
|
|
7
|
+
/**
|
|
8
|
+
* Reactive state signal that will be updated when the batcher state changes
|
|
9
|
+
*
|
|
10
|
+
* Use this instead of `batcher.store.state`
|
|
11
|
+
*/
|
|
12
|
+
readonly state: Signal<Readonly<TSelected>>;
|
|
13
|
+
/**
|
|
14
|
+
* @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
|
|
15
|
+
* The state on the store object is not reactive in Angular signals.
|
|
16
|
+
*/
|
|
17
|
+
readonly store: Store<Readonly<BatcherState<TValue>>>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* An Angular function that creates and manages a Batcher instance.
|
|
21
|
+
*
|
|
22
|
+
* This is a lower-level function that provides direct access to the Batcher's functionality.
|
|
23
|
+
* This allows you to integrate it with any state management solution you prefer.
|
|
24
|
+
*
|
|
25
|
+
* The Batcher collects items and processes them in batches based on configurable conditions:
|
|
26
|
+
* - Maximum batch size
|
|
27
|
+
* - Time-based batching (process after X milliseconds)
|
|
28
|
+
* - Custom batch processing logic via getShouldExecute
|
|
29
|
+
*
|
|
30
|
+
* ## State Management and Selector
|
|
31
|
+
*
|
|
32
|
+
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
33
|
+
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
34
|
+
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
35
|
+
*
|
|
36
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
37
|
+
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
38
|
+
* full control over when your component tracks state changes.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* // Default behavior - no reactive state subscriptions
|
|
43
|
+
* const batcher = injectBatcher(
|
|
44
|
+
* (items) => console.log('Processing batch:', items),
|
|
45
|
+
* { maxSize: 5, wait: 2000 }
|
|
46
|
+
* );
|
|
47
|
+
*
|
|
48
|
+
* // Add items
|
|
49
|
+
* batcher.addItem('task1');
|
|
50
|
+
*
|
|
51
|
+
* // Access the selected state
|
|
52
|
+
* const { items, isPending } = batcher.state();
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
|
|
56
|
+
//#endregion
|
|
57
|
+
export { AngularBatcher, injectBatcher };
|
|
58
|
+
//# sourceMappingURL=injectBatcher.d.ts.map
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { injectPacerOptions } from "../provider/pacer-context.js";
|
|
2
|
+
import { injectStore } from "@tanstack/angular-store";
|
|
3
|
+
import { Batcher } from "@tanstack/pacer/batcher";
|
|
4
|
+
|
|
5
|
+
//#region src/batcher/injectBatcher.ts
|
|
6
|
+
/**
|
|
7
|
+
* An Angular function that creates and manages a Batcher instance.
|
|
8
|
+
*
|
|
9
|
+
* This is a lower-level function that provides direct access to the Batcher's functionality.
|
|
10
|
+
* This allows you to integrate it with any state management solution you prefer.
|
|
11
|
+
*
|
|
12
|
+
* The Batcher collects items and processes them in batches based on configurable conditions:
|
|
13
|
+
* - Maximum batch size
|
|
14
|
+
* - Time-based batching (process after X milliseconds)
|
|
15
|
+
* - Custom batch processing logic via getShouldExecute
|
|
16
|
+
*
|
|
17
|
+
* ## State Management and Selector
|
|
18
|
+
*
|
|
19
|
+
* The function uses TanStack Store for state management and wraps it with Angular signals.
|
|
20
|
+
* The `selector` parameter allows you to specify which state changes will trigger signal updates,
|
|
21
|
+
* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
|
|
22
|
+
*
|
|
23
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
24
|
+
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
25
|
+
* full control over when your component tracks state changes.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* // Default behavior - no reactive state subscriptions
|
|
30
|
+
* const batcher = injectBatcher(
|
|
31
|
+
* (items) => console.log('Processing batch:', items),
|
|
32
|
+
* { maxSize: 5, wait: 2000 }
|
|
33
|
+
* );
|
|
34
|
+
*
|
|
35
|
+
* // Add items
|
|
36
|
+
* batcher.addItem('task1');
|
|
37
|
+
*
|
|
38
|
+
* // Access the selected state
|
|
39
|
+
* const { items, isPending } = batcher.state();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
function injectBatcher(fn, options = {}, selector = () => ({})) {
|
|
43
|
+
const batcher = new Batcher(fn, {
|
|
44
|
+
...injectPacerOptions().batcher,
|
|
45
|
+
...options
|
|
46
|
+
});
|
|
47
|
+
const state = injectStore(batcher.store, selector);
|
|
48
|
+
return {
|
|
49
|
+
...batcher,
|
|
50
|
+
state
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
//#endregion
|
|
55
|
+
export { injectBatcher };
|
|
56
|
+
//# sourceMappingURL=injectBatcher.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectBatcher.js","names":[],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n Batcher<TValue>,\n 'store'\n> {\n /**\n * Reactive state signal that will be updated when the batcher state changes\n *\n * Use this instead of `batcher.store.state`\n */\n readonly state: Signal<Readonly<TSelected>>\n /**\n * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n * The state on the store object is not reactive in Angular signals.\n */\n readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n * (items) => console.log('Processing batch:', items),\n * { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n fn: (items: Array<TValue>) => void,\n options: BatcherOptions<TValue> = {},\n selector: (state: BatcherState<TValue>) => TSelected = () =>\n ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n const mergedOptions = {\n ...injectPacerOptions().batcher,\n ...options,\n } as BatcherOptions<TValue>\n\n const batcher = new Batcher<TValue>(fn, mergedOptions)\n const state = injectStore(batcher.store, selector)\n\n return {\n ...batcher,\n state,\n } as AngularBatcher<TValue, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,cACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC8B;CAMnC,MAAM,UAAU,IAAI,QAAgB,IALd;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ,CAEqD;CACtD,MAAM,QAAQ,YAAY,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_injectDebouncer = require('./injectDebouncer.cjs');
|
|
3
|
+
const require_injectDebouncedCallback = require('./injectDebouncedCallback.cjs');
|
|
4
|
+
const require_injectDebouncedSignal = require('./injectDebouncedSignal.cjs');
|
|
5
|
+
const require_injectDebouncedValue = require('./injectDebouncedValue.cjs');
|
|
6
|
+
|
|
7
|
+
exports.injectDebouncedCallback = require_injectDebouncedCallback.injectDebouncedCallback;
|
|
8
|
+
exports.injectDebouncedSignal = require_injectDebouncedSignal.injectDebouncedSignal;
|
|
9
|
+
exports.injectDebouncedValue = require_injectDebouncedValue.injectDebouncedValue;
|
|
10
|
+
exports.injectDebouncer = require_injectDebouncer.injectDebouncer;
|
|
11
|
+
var _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
|
|
12
|
+
Object.keys(_tanstack_pacer_debouncer).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_debouncer[k]; }
|
|
16
|
+
});
|
|
17
|
+
});
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { injectDebouncedCallback } from "./injectDebouncedCallback.cjs";
|
|
2
|
+
import { AngularDebouncer, injectDebouncer } from "./injectDebouncer.cjs";
|
|
3
|
+
import { DebouncedSignal, injectDebouncedSignal } from "./injectDebouncedSignal.cjs";
|
|
4
|
+
import { injectDebouncedValue } from "./injectDebouncedValue.cjs";
|
|
5
|
+
export * from "@tanstack/pacer/debouncer";
|
|
6
|
+
export { AngularDebouncer, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { injectDebouncedCallback } from "./injectDebouncedCallback.js";
|
|
2
|
+
import { AngularDebouncer, injectDebouncer } from "./injectDebouncer.js";
|
|
3
|
+
import { DebouncedSignal, injectDebouncedSignal } from "./injectDebouncedSignal.js";
|
|
4
|
+
import { injectDebouncedValue } from "./injectDebouncedValue.js";
|
|
5
|
+
export * from "@tanstack/pacer/debouncer";
|
|
6
|
+
export { AngularDebouncer, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { injectDebouncer } from "./injectDebouncer.js";
|
|
2
|
+
import { injectDebouncedCallback } from "./injectDebouncedCallback.js";
|
|
3
|
+
import { injectDebouncedSignal } from "./injectDebouncedSignal.js";
|
|
4
|
+
import { injectDebouncedValue } from "./injectDebouncedValue.js";
|
|
5
|
+
|
|
6
|
+
export * from "@tanstack/pacer/debouncer"
|
|
7
|
+
|
|
8
|
+
export { injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
const require_injectDebouncer = require('./injectDebouncer.cjs');
|
|
2
|
+
|
|
3
|
+
//#region src/debouncer/injectDebouncedCallback.ts
|
|
4
|
+
/**
|
|
5
|
+
* An Angular function that creates a debounced version of a callback function.
|
|
6
|
+
* This function is essentially a wrapper around `injectDebouncer` that provides
|
|
7
|
+
* a simplified API for basic debouncing needs.
|
|
8
|
+
*
|
|
9
|
+
* The debounced function will only execute after the specified wait time has elapsed
|
|
10
|
+
* since its last invocation. If called again before the wait time expires, the timer
|
|
11
|
+
* resets and starts waiting again.
|
|
12
|
+
*
|
|
13
|
+
* This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic
|
|
14
|
+
* debouncing needs. However, it does not expose the underlying Debouncer instance.
|
|
15
|
+
*
|
|
16
|
+
* For advanced usage requiring features like:
|
|
17
|
+
* - Manual cancellation
|
|
18
|
+
* - Access to execution counts
|
|
19
|
+
* - State tracking
|
|
20
|
+
*
|
|
21
|
+
* Consider using the `injectDebouncer` function instead.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* // Debounce a search handler
|
|
26
|
+
* const handleSearch = injectDebouncedCallback((query: string) => {
|
|
27
|
+
* fetchSearchResults(query);
|
|
28
|
+
* }, {
|
|
29
|
+
* wait: 500 // Wait 500ms between executions
|
|
30
|
+
* });
|
|
31
|
+
*
|
|
32
|
+
* // Use in an input
|
|
33
|
+
* <input
|
|
34
|
+
* type="search"
|
|
35
|
+
* (input)="handleSearch($event.target.value)"
|
|
36
|
+
* />
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
function injectDebouncedCallback(fn, options) {
|
|
40
|
+
const debouncer = require_injectDebouncer.injectDebouncer(fn, options);
|
|
41
|
+
return (...args) => debouncer.maybeExecute(...args);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
//#endregion
|
|
45
|
+
exports.injectDebouncedCallback = injectDebouncedCallback;
|
|
46
|
+
//# sourceMappingURL=injectDebouncedCallback.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectDebouncedCallback.cjs","names":["injectDebouncer"],"sources":["../../src/debouncer/injectDebouncedCallback.ts"],"sourcesContent":["import { injectDebouncer } from './injectDebouncer'\nimport type { DebouncerOptions } from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a debounced version of a callback function.\n * This function is essentially a wrapper around `injectDebouncer` that provides\n * a simplified API for basic debouncing needs.\n *\n * The debounced function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again.\n *\n * This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic\n * debouncing needs. However, it does not expose the underlying Debouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectDebouncer` function instead.\n *\n * @example\n * ```ts\n * // Debounce a search handler\n * const handleSearch = injectDebouncedCallback((query: string) => {\n * fetchSearchResults(query);\n * }, {\n * wait: 500 // Wait 500ms between executions\n * });\n *\n * // Use in an input\n * <input\n * type=\"search\"\n * (input)=\"handleSearch($event.target.value)\"\n * />\n * ```\n */\nexport function injectDebouncedCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n const debouncer = injectDebouncer(fn, options)\n return (...args: Parameters<TFn>) => debouncer.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,wBACd,IACA,SACoC;CACpC,MAAM,YAAYA,wCAAgB,IAAI,QAAQ;AAC9C,SAAQ,GAAG,SAA0B,UAAU,aAAa,GAAG,KAAK"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { AnyFunction } from "@tanstack/pacer/types";
|
|
2
|
+
import { DebouncerOptions } from "@tanstack/pacer/debouncer";
|
|
3
|
+
|
|
4
|
+
//#region src/debouncer/injectDebouncedCallback.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* An Angular function that creates a debounced version of a callback function.
|
|
7
|
+
* This function is essentially a wrapper around `injectDebouncer` that provides
|
|
8
|
+
* a simplified API for basic debouncing needs.
|
|
9
|
+
*
|
|
10
|
+
* The debounced function will only execute after the specified wait time has elapsed
|
|
11
|
+
* since its last invocation. If called again before the wait time expires, the timer
|
|
12
|
+
* resets and starts waiting again.
|
|
13
|
+
*
|
|
14
|
+
* This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic
|
|
15
|
+
* debouncing needs. However, it does not expose the underlying Debouncer instance.
|
|
16
|
+
*
|
|
17
|
+
* For advanced usage requiring features like:
|
|
18
|
+
* - Manual cancellation
|
|
19
|
+
* - Access to execution counts
|
|
20
|
+
* - State tracking
|
|
21
|
+
*
|
|
22
|
+
* Consider using the `injectDebouncer` function instead.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* // Debounce a search handler
|
|
27
|
+
* const handleSearch = injectDebouncedCallback((query: string) => {
|
|
28
|
+
* fetchSearchResults(query);
|
|
29
|
+
* }, {
|
|
30
|
+
* wait: 500 // Wait 500ms between executions
|
|
31
|
+
* });
|
|
32
|
+
*
|
|
33
|
+
* // Use in an input
|
|
34
|
+
* <input
|
|
35
|
+
* type="search"
|
|
36
|
+
* (input)="handleSearch($event.target.value)"
|
|
37
|
+
* />
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
declare function injectDebouncedCallback<TFn extends AnyFunction>(fn: TFn, options: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
|
|
41
|
+
//#endregion
|
|
42
|
+
export { injectDebouncedCallback };
|
|
43
|
+
//# sourceMappingURL=injectDebouncedCallback.d.cts.map
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { DebouncerOptions } from "@tanstack/pacer/debouncer";
|
|
2
|
+
import { AnyFunction } from "@tanstack/pacer/types";
|
|
3
|
+
|
|
4
|
+
//#region src/debouncer/injectDebouncedCallback.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* An Angular function that creates a debounced version of a callback function.
|
|
7
|
+
* This function is essentially a wrapper around `injectDebouncer` that provides
|
|
8
|
+
* a simplified API for basic debouncing needs.
|
|
9
|
+
*
|
|
10
|
+
* The debounced function will only execute after the specified wait time has elapsed
|
|
11
|
+
* since its last invocation. If called again before the wait time expires, the timer
|
|
12
|
+
* resets and starts waiting again.
|
|
13
|
+
*
|
|
14
|
+
* This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic
|
|
15
|
+
* debouncing needs. However, it does not expose the underlying Debouncer instance.
|
|
16
|
+
*
|
|
17
|
+
* For advanced usage requiring features like:
|
|
18
|
+
* - Manual cancellation
|
|
19
|
+
* - Access to execution counts
|
|
20
|
+
* - State tracking
|
|
21
|
+
*
|
|
22
|
+
* Consider using the `injectDebouncer` function instead.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* // Debounce a search handler
|
|
27
|
+
* const handleSearch = injectDebouncedCallback((query: string) => {
|
|
28
|
+
* fetchSearchResults(query);
|
|
29
|
+
* }, {
|
|
30
|
+
* wait: 500 // Wait 500ms between executions
|
|
31
|
+
* });
|
|
32
|
+
*
|
|
33
|
+
* // Use in an input
|
|
34
|
+
* <input
|
|
35
|
+
* type="search"
|
|
36
|
+
* (input)="handleSearch($event.target.value)"
|
|
37
|
+
* />
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
declare function injectDebouncedCallback<TFn extends AnyFunction>(fn: TFn, options: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
|
|
41
|
+
//#endregion
|
|
42
|
+
export { injectDebouncedCallback };
|
|
43
|
+
//# sourceMappingURL=injectDebouncedCallback.d.ts.map
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { injectDebouncer } from "./injectDebouncer.js";
|
|
2
|
+
|
|
3
|
+
//#region src/debouncer/injectDebouncedCallback.ts
|
|
4
|
+
/**
|
|
5
|
+
* An Angular function that creates a debounced version of a callback function.
|
|
6
|
+
* This function is essentially a wrapper around `injectDebouncer` that provides
|
|
7
|
+
* a simplified API for basic debouncing needs.
|
|
8
|
+
*
|
|
9
|
+
* The debounced function will only execute after the specified wait time has elapsed
|
|
10
|
+
* since its last invocation. If called again before the wait time expires, the timer
|
|
11
|
+
* resets and starts waiting again.
|
|
12
|
+
*
|
|
13
|
+
* This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic
|
|
14
|
+
* debouncing needs. However, it does not expose the underlying Debouncer instance.
|
|
15
|
+
*
|
|
16
|
+
* For advanced usage requiring features like:
|
|
17
|
+
* - Manual cancellation
|
|
18
|
+
* - Access to execution counts
|
|
19
|
+
* - State tracking
|
|
20
|
+
*
|
|
21
|
+
* Consider using the `injectDebouncer` function instead.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* // Debounce a search handler
|
|
26
|
+
* const handleSearch = injectDebouncedCallback((query: string) => {
|
|
27
|
+
* fetchSearchResults(query);
|
|
28
|
+
* }, {
|
|
29
|
+
* wait: 500 // Wait 500ms between executions
|
|
30
|
+
* });
|
|
31
|
+
*
|
|
32
|
+
* // Use in an input
|
|
33
|
+
* <input
|
|
34
|
+
* type="search"
|
|
35
|
+
* (input)="handleSearch($event.target.value)"
|
|
36
|
+
* />
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
function injectDebouncedCallback(fn, options) {
|
|
40
|
+
const debouncer = injectDebouncer(fn, options);
|
|
41
|
+
return (...args) => debouncer.maybeExecute(...args);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
//#endregion
|
|
45
|
+
export { injectDebouncedCallback };
|
|
46
|
+
//# sourceMappingURL=injectDebouncedCallback.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectDebouncedCallback.js","names":[],"sources":["../../src/debouncer/injectDebouncedCallback.ts"],"sourcesContent":["import { injectDebouncer } from './injectDebouncer'\nimport type { DebouncerOptions } from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a debounced version of a callback function.\n * This function is essentially a wrapper around `injectDebouncer` that provides\n * a simplified API for basic debouncing needs.\n *\n * The debounced function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again.\n *\n * This function provides a simpler API compared to `injectDebouncer`, making it ideal for basic\n * debouncing needs. However, it does not expose the underlying Debouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectDebouncer` function instead.\n *\n * @example\n * ```ts\n * // Debounce a search handler\n * const handleSearch = injectDebouncedCallback((query: string) => {\n * fetchSearchResults(query);\n * }, {\n * wait: 500 // Wait 500ms between executions\n * });\n *\n * // Use in an input\n * <input\n * type=\"search\"\n * (input)=\"handleSearch($event.target.value)\"\n * />\n * ```\n */\nexport function injectDebouncedCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n const debouncer = injectDebouncer(fn, options)\n return (...args: Parameters<TFn>) => debouncer.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,SAAgB,wBACd,IACA,SACoC;CACpC,MAAM,YAAY,gBAAgB,IAAI,QAAQ;AAC9C,SAAQ,GAAG,SAA0B,UAAU,aAAa,GAAG,KAAK"}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
const require_injectDebouncer = require('./injectDebouncer.cjs');
|
|
2
|
+
let _angular_core = require("@angular/core");
|
|
3
|
+
|
|
4
|
+
//#region src/debouncer/injectDebouncedSignal.ts
|
|
5
|
+
/**
|
|
6
|
+
* An Angular function that creates a debounced state signal, combining Angular's signal with debouncing functionality.
|
|
7
|
+
* This function provides both the current debounced value and methods to update it.
|
|
8
|
+
*
|
|
9
|
+
* The state value is only updated after the specified wait time has elapsed since the last update attempt.
|
|
10
|
+
* If another update is attempted before the wait time expires, the timer resets and starts waiting again.
|
|
11
|
+
* This is useful for handling frequent state updates that should be throttled, like search input values
|
|
12
|
+
* or window resize dimensions.
|
|
13
|
+
*
|
|
14
|
+
* The function returns a callable object:
|
|
15
|
+
* - `debounced()`: Get the current debounced value
|
|
16
|
+
* - `debounced.set(...)`: Set or update the debounced value (debounced via maybeExecute)
|
|
17
|
+
* - `debounced.debouncer`: The debouncer instance with additional control methods and state signals
|
|
18
|
+
*
|
|
19
|
+
* ## State Management and Selector
|
|
20
|
+
*
|
|
21
|
+
* The function uses TanStack Store for reactive state management via the underlying debouncer instance.
|
|
22
|
+
* The `selector` parameter allows you to specify which debouncer 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. Only when you provide a selector will
|
|
28
|
+
* the reactive system track the selected state values.
|
|
29
|
+
*
|
|
30
|
+
* Available debouncer state properties:
|
|
31
|
+
* - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
|
|
32
|
+
* - `executionCount`: Number of function executions that have been completed
|
|
33
|
+
* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
|
|
34
|
+
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
35
|
+
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const debouncedQuery = injectDebouncedSignal('', { wait: 500 })
|
|
40
|
+
*
|
|
41
|
+
* // Get value
|
|
42
|
+
* console.log(debouncedQuery())
|
|
43
|
+
*
|
|
44
|
+
* // Set/update value (debounced)
|
|
45
|
+
* debouncedQuery.set('hello')
|
|
46
|
+
*
|
|
47
|
+
* // Access debouncer
|
|
48
|
+
* console.log(debouncedQuery.debouncer.state().isPending)
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
function injectDebouncedSignal(value, initialOptions, selector) {
|
|
52
|
+
const debouncedValue = (0, _angular_core.signal)(value);
|
|
53
|
+
const debouncer = require_injectDebouncer.injectDebouncer((newValue) => {
|
|
54
|
+
if (typeof newValue === "function") debouncedValue.update(newValue);
|
|
55
|
+
else debouncedValue.set(newValue);
|
|
56
|
+
}, initialOptions, selector);
|
|
57
|
+
const set = (newValue) => {
|
|
58
|
+
debouncer.maybeExecute(newValue);
|
|
59
|
+
};
|
|
60
|
+
return Object.assign(() => debouncedValue(), {
|
|
61
|
+
set,
|
|
62
|
+
debouncer
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
//#endregion
|
|
67
|
+
exports.injectDebouncedSignal = injectDebouncedSignal;
|
|
68
|
+
//# sourceMappingURL=injectDebouncedSignal.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectDebouncedSignal.cjs","names":["injectDebouncer"],"sources":["../../src/debouncer/injectDebouncedSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectDebouncer } from './injectDebouncer'\nimport type { AngularDebouncer } from './injectDebouncer'\nimport type {\n DebouncerOptions,\n DebouncerState,\n} from '@tanstack/pacer/debouncer'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport type DebouncedSignal<TValue, TSelected = {}> = ((\n ...args: []\n) => TValue) & {\n /**\n * Set or update the debounced value. This calls `debouncer.maybeExecute(...)`.\n */\n readonly set: Setter<TValue>\n /**\n * The debouncer instance with additional control methods and state signals.\n */\n readonly debouncer: AngularDebouncer<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a debounced state signal, combining Angular's signal with debouncing functionality.\n * This function provides both the current debounced value and methods to update it.\n *\n * The state value is only updated after the specified wait time has elapsed since the last update attempt.\n * If another update is attempted before the wait time expires, the timer resets and starts waiting again.\n * This is useful for handling frequent state updates that should be throttled, like search input values\n * or window resize dimensions.\n *\n * The function returns a callable object:\n * - `debounced()`: Get the current debounced value\n * - `debounced.set(...)`: Set or update the debounced value (debounced via maybeExecute)\n * - `debounced.debouncer`: The debouncer 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 debouncer instance.\n * The `selector` parameter allows you to specify which debouncer 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. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available debouncer state properties:\n * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * const debouncedQuery = injectDebouncedSignal('', { wait: 500 })\n *\n * // Get value\n * console.log(debouncedQuery())\n *\n * // Set/update value (debounced)\n * debouncedQuery.set('hello')\n *\n * // Access debouncer\n * console.log(debouncedQuery.debouncer.state().isPending)\n * ```\n */\nexport function injectDebouncedSignal<TValue, TSelected = {}>(\n value: TValue,\n initialOptions: DebouncerOptions<Setter<TValue>>,\n selector?: (state: DebouncerState<Setter<TValue>>) => TSelected,\n): DebouncedSignal<TValue, TSelected> {\n const debouncedValue = signal<TValue>(value)\n\n const debouncer = injectDebouncer(\n (newValue: TValue | ((prev: TValue) => TValue)) => {\n if (typeof newValue === 'function') {\n debouncedValue.update(newValue as (prev: TValue) => TValue)\n } else {\n debouncedValue.set(newValue)\n }\n },\n initialOptions,\n selector,\n )\n\n const set: Setter<TValue> = (\n newValue: TValue | ((prev: TValue) => TValue),\n ) => {\n debouncer.maybeExecute(newValue)\n }\n\n const debounced = Object.assign(() => debouncedValue(), {\n set,\n debouncer,\n }) as DebouncedSignal<TValue, TSelected>\n\n return debounced\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqEA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,2CAAgC,MAAM;CAE5C,MAAM,YAAYA,yCACf,aAAkD;AACjD,MAAI,OAAO,aAAa,WACtB,gBAAe,OAAO,SAAqC;MAE3D,gBAAe,IAAI,SAAS;IAGhC,gBACA,SACD;CAED,MAAM,OACJ,aACG;AACH,YAAU,aAAa,SAAS;;AAQlC,QALkB,OAAO,aAAa,gBAAgB,EAAE;EACtD;EACA;EACD,CAAC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { AngularDebouncer } from "./injectDebouncer.cjs";
|
|
2
|
+
import { DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
|
|
3
|
+
|
|
4
|
+
//#region src/debouncer/injectDebouncedSignal.d.ts
|
|
5
|
+
type Setter<T> = (value: T | ((prev: T) => T)) => void;
|
|
6
|
+
type DebouncedSignal<TValue, TSelected = {}> = ((...args: []) => TValue) & {
|
|
7
|
+
/**
|
|
8
|
+
* Set or update the debounced value. This calls `debouncer.maybeExecute(...)`.
|
|
9
|
+
*/
|
|
10
|
+
readonly set: Setter<TValue>;
|
|
11
|
+
/**
|
|
12
|
+
* The debouncer instance with additional control methods and state signals.
|
|
13
|
+
*/
|
|
14
|
+
readonly debouncer: AngularDebouncer<Setter<TValue>, TSelected>;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* An Angular function that creates a debounced state signal, combining Angular's signal with debouncing functionality.
|
|
18
|
+
* This function provides both the current debounced value and methods to update it.
|
|
19
|
+
*
|
|
20
|
+
* The state value is only updated after the specified wait time has elapsed since the last update attempt.
|
|
21
|
+
* If another update is attempted before the wait time expires, the timer resets and starts waiting again.
|
|
22
|
+
* This is useful for handling frequent state updates that should be throttled, like search input values
|
|
23
|
+
* or window resize dimensions.
|
|
24
|
+
*
|
|
25
|
+
* The function returns a callable object:
|
|
26
|
+
* - `debounced()`: Get the current debounced value
|
|
27
|
+
* - `debounced.set(...)`: Set or update the debounced value (debounced via maybeExecute)
|
|
28
|
+
* - `debounced.debouncer`: The debouncer instance with additional control methods and state signals
|
|
29
|
+
*
|
|
30
|
+
* ## State Management and Selector
|
|
31
|
+
*
|
|
32
|
+
* The function uses TanStack Store for reactive state management via the underlying debouncer instance.
|
|
33
|
+
* The `selector` parameter allows you to specify which debouncer state changes will trigger signal updates,
|
|
34
|
+
* optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
|
|
35
|
+
*
|
|
36
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
37
|
+
* tracking by providing a selector function. This prevents unnecessary updates and gives you
|
|
38
|
+
* full control over when your component tracks state changes. Only when you provide a selector will
|
|
39
|
+
* the reactive system track the selected state values.
|
|
40
|
+
*
|
|
41
|
+
* Available debouncer state properties:
|
|
42
|
+
* - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
|
|
43
|
+
* - `executionCount`: Number of function executions that have been completed
|
|
44
|
+
* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
|
|
45
|
+
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
46
|
+
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const debouncedQuery = injectDebouncedSignal('', { wait: 500 })
|
|
51
|
+
*
|
|
52
|
+
* // Get value
|
|
53
|
+
* console.log(debouncedQuery())
|
|
54
|
+
*
|
|
55
|
+
* // Set/update value (debounced)
|
|
56
|
+
* debouncedQuery.set('hello')
|
|
57
|
+
*
|
|
58
|
+
* // Access debouncer
|
|
59
|
+
* console.log(debouncedQuery.debouncer.state().isPending)
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
declare function injectDebouncedSignal<TValue, TSelected = {}>(value: TValue, initialOptions: DebouncerOptions<Setter<TValue>>, selector?: (state: DebouncerState<Setter<TValue>>) => TSelected): DebouncedSignal<TValue, TSelected>;
|
|
63
|
+
//#endregion
|
|
64
|
+
export { DebouncedSignal, injectDebouncedSignal };
|
|
65
|
+
//# sourceMappingURL=injectDebouncedSignal.d.cts.map
|