@tanstack/preact-pacer 0.22.1 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -2
- package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -5
- package/dist/async-batcher/useAsyncBatchedCallback.js +1 -2
- package/dist/async-batcher/useAsyncBatcher.d.ts +4 -8
- package/dist/async-batcher/useAsyncBatcher.js +1 -3
- package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +6 -7
- package/dist/async-debouncer/useAsyncDebouncedCallback.js +5 -4
- package/dist/async-debouncer/useAsyncDebouncer.d.ts +4 -7
- package/dist/async-debouncer/useAsyncDebouncer.js +1 -2
- package/dist/async-queuer/useAsyncQueuedState.d.ts +4 -7
- package/dist/async-queuer/useAsyncQueuedState.js +3 -4
- package/dist/async-queuer/useAsyncQueuer.d.ts +6 -9
- package/dist/async-queuer/useAsyncQueuer.js +3 -4
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -5
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js +1 -2
- package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +4 -7
- package/dist/async-rate-limiter/useAsyncRateLimiter.js +1 -2
- package/dist/async-throttler/useAsyncThrottledCallback.d.ts +7 -9
- package/dist/async-throttler/useAsyncThrottledCallback.js +6 -6
- package/dist/async-throttler/useAsyncThrottler.d.ts +4 -7
- package/dist/async-throttler/useAsyncThrottler.js +1 -2
- package/dist/batcher/useBatchedCallback.d.ts +2 -5
- package/dist/batcher/useBatchedCallback.js +1 -2
- package/dist/batcher/useBatcher.d.ts +6 -11
- package/dist/batcher/useBatcher.js +3 -6
- package/dist/debouncer/useDebouncedCallback.d.ts +2 -5
- package/dist/debouncer/useDebouncedCallback.js +1 -2
- package/dist/debouncer/useDebouncedState.d.ts +2 -5
- package/dist/debouncer/useDebouncedState.js +1 -2
- package/dist/debouncer/useDebouncedValue.d.ts +2 -5
- package/dist/debouncer/useDebouncedValue.js +1 -2
- package/dist/debouncer/useDebouncer.d.ts +4 -7
- package/dist/debouncer/useDebouncer.js +1 -2
- package/dist/provider/PacerProvider.d.ts +6 -13
- package/dist/provider/PacerProvider.js +1 -2
- package/dist/queuer/useQueuedState.d.ts +2 -5
- package/dist/queuer/useQueuedState.js +1 -2
- package/dist/queuer/useQueuedValue.d.ts +2 -5
- package/dist/queuer/useQueuedValue.js +1 -2
- package/dist/queuer/useQueuer.d.ts +4 -7
- package/dist/queuer/useQueuer.js +1 -2
- package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -5
- package/dist/rate-limiter/useRateLimitedCallback.js +1 -2
- package/dist/rate-limiter/useRateLimitedState.d.ts +2 -5
- package/dist/rate-limiter/useRateLimitedState.js +1 -2
- package/dist/rate-limiter/useRateLimitedValue.d.ts +2 -5
- package/dist/rate-limiter/useRateLimitedValue.js +1 -2
- package/dist/rate-limiter/useRateLimiter.d.ts +4 -7
- package/dist/rate-limiter/useRateLimiter.js +1 -2
- package/dist/throttler/useThrottledCallback.d.ts +2 -5
- package/dist/throttler/useThrottledCallback.js +1 -2
- package/dist/throttler/useThrottledState.d.ts +2 -5
- package/dist/throttler/useThrottledState.js +1 -2
- package/dist/throttler/useThrottledValue.d.ts +2 -5
- package/dist/throttler/useThrottledValue.js +1 -2
- package/dist/throttler/useThrottler.d.ts +4 -7
- package/dist/throttler/useThrottler.js +1 -2
- package/package.json +24 -72
- package/dist/async-batcher/index.cjs +0 -13
- package/dist/async-batcher/index.d.cts +0 -4
- package/dist/async-batcher/useAsyncBatchedCallback.cjs +0 -51
- package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +0 -1
- package/dist/async-batcher/useAsyncBatchedCallback.d.cts +0 -44
- package/dist/async-batcher/useAsyncBatchedCallback.js.map +0 -1
- package/dist/async-batcher/useAsyncBatcher.cjs +0 -217
- package/dist/async-batcher/useAsyncBatcher.cjs.map +0 -1
- package/dist/async-batcher/useAsyncBatcher.d.cts +0 -224
- package/dist/async-batcher/useAsyncBatcher.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/useAsyncDebouncedCallback.cjs +0 -50
- package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +0 -1
- package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +0 -46
- package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +0 -1
- package/dist/async-debouncer/useAsyncDebouncer.cjs +0 -195
- package/dist/async-debouncer/useAsyncDebouncer.cjs.map +0 -1
- package/dist/async-debouncer/useAsyncDebouncer.d.cts +0 -203
- package/dist/async-debouncer/useAsyncDebouncer.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/useAsyncQueuedState.cjs +0 -154
- package/dist/async-queuer/useAsyncQueuedState.cjs.map +0 -1
- package/dist/async-queuer/useAsyncQueuedState.d.cts +0 -151
- package/dist/async-queuer/useAsyncQueuedState.js.map +0 -1
- package/dist/async-queuer/useAsyncQueuer.cjs +0 -217
- package/dist/async-queuer/useAsyncQueuer.cjs.map +0 -1
- package/dist/async-queuer/useAsyncQueuer.d.cts +0 -224
- package/dist/async-queuer/useAsyncQueuer.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/useAsyncRateLimitedCallback.cjs +0 -65
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +0 -1
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +0 -61
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +0 -1
- package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +0 -209
- package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +0 -1
- package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +0 -220
- package/dist/async-rate-limiter/useAsyncRateLimiter.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/useAsyncThrottledCallback.cjs +0 -48
- package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +0 -1
- package/dist/async-throttler/useAsyncThrottledCallback.d.cts +0 -44
- package/dist/async-throttler/useAsyncThrottledCallback.js.map +0 -1
- package/dist/async-throttler/useAsyncThrottler.cjs +0 -206
- package/dist/async-throttler/useAsyncThrottler.cjs.map +0 -1
- package/dist/async-throttler/useAsyncThrottler.d.cts +0 -214
- package/dist/async-throttler/useAsyncThrottler.js.map +0 -1
- package/dist/batcher/index.cjs +0 -13
- package/dist/batcher/index.d.cts +0 -4
- package/dist/batcher/useBatchedCallback.cjs +0 -47
- package/dist/batcher/useBatchedCallback.cjs.map +0 -1
- package/dist/batcher/useBatchedCallback.d.cts +0 -42
- package/dist/batcher/useBatchedCallback.js.map +0 -1
- package/dist/batcher/useBatcher.cjs +0 -165
- package/dist/batcher/useBatcher.cjs.map +0 -1
- package/dist/batcher/useBatcher.d.cts +0 -175
- package/dist/batcher/useBatcher.js.map +0 -1
- package/dist/debouncer/index.cjs +0 -17
- package/dist/debouncer/index.d.cts +0 -6
- package/dist/debouncer/useDebouncedCallback.cjs +0 -48
- package/dist/debouncer/useDebouncedCallback.cjs.map +0 -1
- package/dist/debouncer/useDebouncedCallback.d.cts +0 -44
- package/dist/debouncer/useDebouncedCallback.js.map +0 -1
- package/dist/debouncer/useDebouncedState.cjs +0 -89
- package/dist/debouncer/useDebouncedState.cjs.map +0 -1
- package/dist/debouncer/useDebouncedState.d.cts +0 -81
- package/dist/debouncer/useDebouncedState.js.map +0 -1
- package/dist/debouncer/useDebouncedValue.cjs +0 -96
- package/dist/debouncer/useDebouncedValue.cjs.map +0 -1
- package/dist/debouncer/useDebouncedValue.d.cts +0 -90
- package/dist/debouncer/useDebouncedValue.js.map +0 -1
- package/dist/debouncer/useDebouncer.cjs +0 -141
- package/dist/debouncer/useDebouncer.cjs.map +0 -1
- package/dist/debouncer/useDebouncer.d.cts +0 -152
- package/dist/debouncer/useDebouncer.js.map +0 -1
- package/dist/index.cjs +0 -67
- package/dist/index.d.cts +0 -30
- package/dist/provider/PacerProvider.cjs +0 -26
- package/dist/provider/PacerProvider.cjs.map +0 -1
- package/dist/provider/PacerProvider.d.cts +0 -33
- package/dist/provider/PacerProvider.js.map +0 -1
- package/dist/provider/index.cjs +0 -6
- package/dist/provider/index.d.cts +0 -2
- package/dist/queuer/index.cjs +0 -15
- package/dist/queuer/index.d.cts +0 -5
- package/dist/queuer/useQueuedState.cjs +0 -129
- package/dist/queuer/useQueuedState.cjs.map +0 -1
- package/dist/queuer/useQueuedState.d.cts +0 -122
- package/dist/queuer/useQueuedState.js.map +0 -1
- package/dist/queuer/useQueuedValue.cjs +0 -115
- package/dist/queuer/useQueuedValue.cjs.map +0 -1
- package/dist/queuer/useQueuedValue.d.cts +0 -105
- package/dist/queuer/useQueuedValue.js.map +0 -1
- package/dist/queuer/useQueuer.cjs +0 -176
- package/dist/queuer/useQueuer.cjs.map +0 -1
- package/dist/queuer/useQueuer.d.cts +0 -186
- package/dist/queuer/useQueuer.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/useRateLimitedCallback.cjs +0 -65
- package/dist/rate-limiter/useRateLimitedCallback.cjs.map +0 -1
- package/dist/rate-limiter/useRateLimitedCallback.d.cts +0 -61
- package/dist/rate-limiter/useRateLimitedCallback.js.map +0 -1
- package/dist/rate-limiter/useRateLimitedState.cjs +0 -115
- package/dist/rate-limiter/useRateLimitedState.cjs.map +0 -1
- package/dist/rate-limiter/useRateLimitedState.d.cts +0 -107
- package/dist/rate-limiter/useRateLimitedState.js.map +0 -1
- package/dist/rate-limiter/useRateLimitedValue.cjs +0 -102
- package/dist/rate-limiter/useRateLimitedValue.cjs.map +0 -1
- package/dist/rate-limiter/useRateLimitedValue.d.cts +0 -96
- package/dist/rate-limiter/useRateLimitedValue.js.map +0 -1
- package/dist/rate-limiter/useRateLimiter.cjs +0 -167
- package/dist/rate-limiter/useRateLimiter.cjs.map +0 -1
- package/dist/rate-limiter/useRateLimiter.d.cts +0 -179
- package/dist/rate-limiter/useRateLimiter.js.map +0 -1
- package/dist/throttler/index.cjs +0 -17
- package/dist/throttler/index.d.cts +0 -6
- package/dist/throttler/useThrottledCallback.cjs +0 -49
- package/dist/throttler/useThrottledCallback.cjs.map +0 -1
- package/dist/throttler/useThrottledCallback.d.cts +0 -45
- package/dist/throttler/useThrottledCallback.js.map +0 -1
- package/dist/throttler/useThrottledState.cjs +0 -100
- package/dist/throttler/useThrottledState.cjs.map +0 -1
- package/dist/throttler/useThrottledState.d.cts +0 -92
- package/dist/throttler/useThrottledState.js.map +0 -1
- package/dist/throttler/useThrottledValue.cjs +0 -91
- package/dist/throttler/useThrottledValue.cjs.map +0 -1
- package/dist/throttler/useThrottledValue.d.cts +0 -85
- package/dist/throttler/useThrottledValue.js.map +0 -1
- package/dist/throttler/useThrottler.cjs +0 -146
- package/dist/throttler/useThrottler.cjs.map +0 -1
- package/dist/throttler/useThrottler.d.cts +0 -157
- package/dist/throttler/useThrottler.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/useAsyncBatchedCallback.ts +0 -53
- package/src/async-batcher/useAsyncBatcher.ts +0 -293
- package/src/async-debouncer/index.ts +0 -5
- package/src/async-debouncer/useAsyncDebouncedCallback.ts +0 -54
- package/src/async-debouncer/useAsyncDebouncer.ts +0 -274
- package/src/async-queuer/index.ts +0 -4
- package/src/async-queuer/useAsyncQueuedState.ts +0 -165
- package/src/async-queuer/useAsyncQueuer.ts +0 -293
- package/src/async-rate-limiter/index.ts +0 -5
- package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +0 -69
- package/src/async-rate-limiter/useAsyncRateLimiter.ts +0 -294
- package/src/async-retryer/index.ts +0 -2
- package/src/async-throttler/index.ts +0 -5
- package/src/async-throttler/useAsyncThrottledCallback.ts +0 -52
- package/src/async-throttler/useAsyncThrottler.ts +0 -285
- package/src/batcher/index.ts +0 -4
- package/src/batcher/useBatchedCallback.ts +0 -46
- package/src/batcher/useBatcher.ts +0 -241
- package/src/debouncer/index.ts +0 -7
- package/src/debouncer/useDebouncedCallback.ts +0 -51
- package/src/debouncer/useDebouncedState.ts +0 -106
- package/src/debouncer/useDebouncedValue.ts +0 -109
- package/src/debouncer/useDebouncer.ts +0 -219
- package/src/index.ts +0 -56
- package/src/provider/PacerProvider.tsx +0 -70
- package/src/provider/index.ts +0 -1
- package/src/queuer/index.ts +0 -5
- package/src/queuer/useQueuedState.ts +0 -133
- package/src/queuer/useQueuedValue.ts +0 -129
- package/src/queuer/useQueuer.ts +0 -251
- package/src/rate-limiter/index.ts +0 -6
- package/src/rate-limiter/useRateLimitedCallback.ts +0 -68
- package/src/rate-limiter/useRateLimitedState.ts +0 -124
- package/src/rate-limiter/useRateLimitedValue.ts +0 -110
- package/src/rate-limiter/useRateLimiter.ts +0 -244
- package/src/throttler/index.ts +0 -7
- package/src/throttler/useThrottledCallback.ts +0 -52
- package/src/throttler/useThrottledState.ts +0 -118
- package/src/throttler/useThrottledValue.ts +0 -104
- package/src/throttler/useThrottler.ts +0 -224
- package/src/types/index.ts +0 -1
- package/src/utils/index.ts +0 -1
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
const require_useThrottledState = require('./useThrottledState.cjs');
|
|
2
|
-
let preact_hooks = require("preact/hooks");
|
|
3
|
-
|
|
4
|
-
//#region src/throttler/useThrottledValue.ts
|
|
5
|
-
/**
|
|
6
|
-
* A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.
|
|
7
|
-
* This hook uses Preact's useState internally to manage the throttled state.
|
|
8
|
-
*
|
|
9
|
-
* Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
|
|
10
|
-
* This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
|
|
11
|
-
*
|
|
12
|
-
* The hook returns a tuple containing:
|
|
13
|
-
* - The throttled value that updates according to the leading/trailing edge behavior specified in the options
|
|
14
|
-
* - The throttler instance with control methods
|
|
15
|
-
*
|
|
16
|
-
* For more direct control over throttling behavior without Preact state management,
|
|
17
|
-
* consider using the lower-level useThrottler hook instead.
|
|
18
|
-
*
|
|
19
|
-
* ## State Management and Selector
|
|
20
|
-
*
|
|
21
|
-
* The hook uses TanStack Store for reactive state management via the underlying throttler instance.
|
|
22
|
-
* The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,
|
|
23
|
-
* optimizing performance by preventing unnecessary re-renders 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 re-renders and gives you
|
|
27
|
-
* full control over when your component updates. Only when you provide a selector will the
|
|
28
|
-
* component re-render when the selected state values change.
|
|
29
|
-
*
|
|
30
|
-
* Available throttler state properties:
|
|
31
|
-
* - `executionCount`: Number of function executions that have been completed
|
|
32
|
-
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
33
|
-
* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
|
|
34
|
-
* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
|
|
35
|
-
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
36
|
-
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
37
|
-
*
|
|
38
|
-
* @example
|
|
39
|
-
* ```tsx
|
|
40
|
-
* // Default behavior - no reactive state subscriptions
|
|
41
|
-
* const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });
|
|
42
|
-
*
|
|
43
|
-
* // Opt-in to re-render when execution count changes (optimized for tracking executions)
|
|
44
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
45
|
-
* rawValue,
|
|
46
|
-
* { wait: 1000 },
|
|
47
|
-
* (state) => ({ executionCount: state.executionCount })
|
|
48
|
-
* );
|
|
49
|
-
*
|
|
50
|
-
* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
|
|
51
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
52
|
-
* rawValue,
|
|
53
|
-
* { wait: 1000 },
|
|
54
|
-
* (state) => ({
|
|
55
|
-
* isPending: state.isPending,
|
|
56
|
-
* status: state.status
|
|
57
|
-
* })
|
|
58
|
-
* );
|
|
59
|
-
*
|
|
60
|
-
* // Opt-in to re-render when timing information changes (optimized for timing displays)
|
|
61
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
62
|
-
* rawValue,
|
|
63
|
-
* { wait: 1000 },
|
|
64
|
-
* (state) => ({
|
|
65
|
-
* lastExecutionTime: state.lastExecutionTime,
|
|
66
|
-
* nextExecutionTime: state.nextExecutionTime
|
|
67
|
-
* })
|
|
68
|
-
* );
|
|
69
|
-
*
|
|
70
|
-
* // With custom leading/trailing behavior
|
|
71
|
-
* const [throttledValue, throttler] = useThrottledValue(rawValue, {
|
|
72
|
-
* wait: 1000,
|
|
73
|
-
* leading: true, // Update immediately on first change
|
|
74
|
-
* trailing: false // Skip trailing edge updates
|
|
75
|
-
* });
|
|
76
|
-
*
|
|
77
|
-
* // Access the selected throttler state (will be empty object {} unless selector provided)
|
|
78
|
-
* const { executionCount, isPending } = throttler.state;
|
|
79
|
-
* ```
|
|
80
|
-
*/
|
|
81
|
-
function useThrottledValue(value, options, selector) {
|
|
82
|
-
const [throttledValue, setThrottledValue, throttler] = require_useThrottledState.useThrottledState(value, options, selector);
|
|
83
|
-
(0, preact_hooks.useEffect)(() => {
|
|
84
|
-
setThrottledValue(value);
|
|
85
|
-
}, [value, setThrottledValue]);
|
|
86
|
-
return [throttledValue, throttler];
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
//#endregion
|
|
90
|
-
exports.useThrottledValue = useThrottledValue;
|
|
91
|
-
//# sourceMappingURL=useThrottledValue.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottledValue.cjs","names":["useThrottledState"],"sources":["../../src/throttler/useThrottledValue.ts"],"sourcesContent":["import { useEffect } from 'preact/hooks'\nimport { useThrottledState } from './useThrottledState'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'\nimport type { ThrottlerState } from '@tanstack/pacer/throttler'\n\n/**\n * A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.\n * This hook uses Preact's useState internally to manage the throttled state.\n *\n * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.\n * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.\n *\n * The hook returns a tuple containing:\n * - The throttled value that updates according to the leading/trailing edge behavior specified in the options\n * - The throttler instance with control methods\n *\n * For more direct control over throttling behavior without Preact state management,\n * consider using the lower-level useThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available throttler state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking executions)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With custom leading/trailing behavior\n * const [throttledValue, throttler] = useThrottledValue(rawValue, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access the selected throttler state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottledValue<\n TValue,\n TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n>(\n value: TValue,\n options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,\n selector?: (\n state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n ) => TSelected,\n): [TValue, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>] {\n const [throttledValue, setThrottledValue, throttler] = useThrottledState(\n value,\n options,\n selector,\n )\n\n useEffect(() => {\n ;(setThrottledValue as (value: TValue) => void)(value)\n }, [value, setThrottledValue])\n\n return [throttledValue, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFA,SAAgB,kBAId,OACA,SACA,UAGsE;CACtE,MAAM,CAAC,gBAAgB,mBAAmB,aAAaA,4CACrD,OACA,SACA,SACD;CAED,kCAAgB;EACb,AAAC,kBAA8C,MAAM;IACrD,CAAC,OAAO,kBAAkB,CAAC;CAE9B,OAAO,CAAC,gBAAgB,UAAU"}
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
import { PreactThrottler, PreactThrottlerOptions } from "./useThrottler.cjs";
|
|
2
|
-
import { Dispatch, StateUpdater } from "preact/hooks";
|
|
3
|
-
import { ThrottlerState } from "@tanstack/pacer/throttler";
|
|
4
|
-
|
|
5
|
-
//#region src/throttler/useThrottledValue.d.ts
|
|
6
|
-
/**
|
|
7
|
-
* A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.
|
|
8
|
-
* This hook uses Preact's useState internally to manage the throttled state.
|
|
9
|
-
*
|
|
10
|
-
* Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
|
|
11
|
-
* This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
|
|
12
|
-
*
|
|
13
|
-
* The hook returns a tuple containing:
|
|
14
|
-
* - The throttled value that updates according to the leading/trailing edge behavior specified in the options
|
|
15
|
-
* - The throttler instance with control methods
|
|
16
|
-
*
|
|
17
|
-
* For more direct control over throttling behavior without Preact state management,
|
|
18
|
-
* consider using the lower-level useThrottler hook instead.
|
|
19
|
-
*
|
|
20
|
-
* ## State Management and Selector
|
|
21
|
-
*
|
|
22
|
-
* The hook uses TanStack Store for reactive state management via the underlying throttler instance.
|
|
23
|
-
* The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,
|
|
24
|
-
* optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
|
|
25
|
-
*
|
|
26
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
27
|
-
* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
|
|
28
|
-
* full control over when your component updates. Only when you provide a selector will the
|
|
29
|
-
* component re-render when the selected state values change.
|
|
30
|
-
*
|
|
31
|
-
* Available throttler state properties:
|
|
32
|
-
* - `executionCount`: Number of function executions that have been completed
|
|
33
|
-
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
34
|
-
* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
|
|
35
|
-
* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
|
|
36
|
-
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
37
|
-
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
38
|
-
*
|
|
39
|
-
* @example
|
|
40
|
-
* ```tsx
|
|
41
|
-
* // Default behavior - no reactive state subscriptions
|
|
42
|
-
* const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });
|
|
43
|
-
*
|
|
44
|
-
* // Opt-in to re-render when execution count changes (optimized for tracking executions)
|
|
45
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
46
|
-
* rawValue,
|
|
47
|
-
* { wait: 1000 },
|
|
48
|
-
* (state) => ({ executionCount: state.executionCount })
|
|
49
|
-
* );
|
|
50
|
-
*
|
|
51
|
-
* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
|
|
52
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
53
|
-
* rawValue,
|
|
54
|
-
* { wait: 1000 },
|
|
55
|
-
* (state) => ({
|
|
56
|
-
* isPending: state.isPending,
|
|
57
|
-
* status: state.status
|
|
58
|
-
* })
|
|
59
|
-
* );
|
|
60
|
-
*
|
|
61
|
-
* // Opt-in to re-render when timing information changes (optimized for timing displays)
|
|
62
|
-
* const [throttledValue, throttler] = useThrottledValue(
|
|
63
|
-
* rawValue,
|
|
64
|
-
* { wait: 1000 },
|
|
65
|
-
* (state) => ({
|
|
66
|
-
* lastExecutionTime: state.lastExecutionTime,
|
|
67
|
-
* nextExecutionTime: state.nextExecutionTime
|
|
68
|
-
* })
|
|
69
|
-
* );
|
|
70
|
-
*
|
|
71
|
-
* // With custom leading/trailing behavior
|
|
72
|
-
* const [throttledValue, throttler] = useThrottledValue(rawValue, {
|
|
73
|
-
* wait: 1000,
|
|
74
|
-
* leading: true, // Update immediately on first change
|
|
75
|
-
* trailing: false // Skip trailing edge updates
|
|
76
|
-
* });
|
|
77
|
-
*
|
|
78
|
-
* // Access the selected throttler state (will be empty object {} unless selector provided)
|
|
79
|
-
* const { executionCount, isPending } = throttler.state;
|
|
80
|
-
* ```
|
|
81
|
-
*/
|
|
82
|
-
declare function useThrottledValue<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>, selector?: (state: ThrottlerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>];
|
|
83
|
-
//#endregion
|
|
84
|
-
export { useThrottledValue };
|
|
85
|
-
//# sourceMappingURL=useThrottledValue.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottledValue.js","names":[],"sources":["../../src/throttler/useThrottledValue.ts"],"sourcesContent":["import { useEffect } from 'preact/hooks'\nimport { useThrottledState } from './useThrottledState'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'\nimport type { ThrottlerState } from '@tanstack/pacer/throttler'\n\n/**\n * A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.\n * This hook uses Preact's useState internally to manage the throttled state.\n *\n * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.\n * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.\n *\n * The hook returns a tuple containing:\n * - The throttled value that updates according to the leading/trailing edge behavior specified in the options\n * - The throttler instance with control methods\n *\n * For more direct control over throttling behavior without Preact state management,\n * consider using the lower-level useThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available throttler state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking executions)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [throttledValue, throttler] = useThrottledValue(\n * rawValue,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With custom leading/trailing behavior\n * const [throttledValue, throttler] = useThrottledValue(rawValue, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access the selected throttler state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottledValue<\n TValue,\n TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n>(\n value: TValue,\n options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,\n selector?: (\n state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n ) => TSelected,\n): [TValue, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>] {\n const [throttledValue, setThrottledValue, throttler] = useThrottledState(\n value,\n options,\n selector,\n )\n\n useEffect(() => {\n ;(setThrottledValue as (value: TValue) => void)(value)\n }, [value, setThrottledValue])\n\n return [throttledValue, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFA,SAAgB,kBAId,OACA,SACA,UAGsE;CACtE,MAAM,CAAC,gBAAgB,mBAAmB,aAAa,kBACrD,OACA,SACA,SACD;CAED,gBAAgB;EACb,AAAC,kBAA8C,MAAM;IACrD,CAAC,OAAO,kBAAkB,CAAC;CAE9B,OAAO,CAAC,gBAAgB,UAAU"}
|
|
@@ -1,146 +0,0 @@
|
|
|
1
|
-
const require_PacerProvider = require('../provider/PacerProvider.cjs');
|
|
2
|
-
let preact_hooks = require("preact/hooks");
|
|
3
|
-
let _tanstack_preact_store = require("@tanstack/preact-store");
|
|
4
|
-
let _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
|
|
5
|
-
|
|
6
|
-
//#region src/throttler/useThrottler.ts
|
|
7
|
-
/**
|
|
8
|
-
* A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
|
|
9
|
-
*
|
|
10
|
-
* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
|
|
11
|
-
* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
|
|
12
|
-
* integrates directly with Preact's useState, see useThrottledState.
|
|
13
|
-
*
|
|
14
|
-
* Throttling ensures a function executes at most once within a specified time window,
|
|
15
|
-
* regardless of how many times it is called. This is useful for rate-limiting
|
|
16
|
-
* expensive operations or UI updates.
|
|
17
|
-
*
|
|
18
|
-
* ## State Management and Selector
|
|
19
|
-
*
|
|
20
|
-
* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
|
|
21
|
-
* in two ways:
|
|
22
|
-
*
|
|
23
|
-
* **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
|
|
24
|
-
*
|
|
25
|
-
* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
|
|
26
|
-
* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
|
|
27
|
-
* in child components.
|
|
28
|
-
*
|
|
29
|
-
* **2. Using the `selector` parameter (For hook-level subscriptions)**
|
|
30
|
-
*
|
|
31
|
-
* The `selector` parameter allows you to specify which state changes will trigger a re-render
|
|
32
|
-
* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
|
|
33
|
-
* state changes occur.
|
|
34
|
-
*
|
|
35
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
36
|
-
* tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
|
|
37
|
-
* re-renders and gives you full control over when your component updates.
|
|
38
|
-
*
|
|
39
|
-
* Available state properties:
|
|
40
|
-
* - `executionCount`: Number of function executions that have been completed
|
|
41
|
-
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
42
|
-
* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
|
|
43
|
-
* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
|
|
44
|
-
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
45
|
-
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
46
|
-
*
|
|
47
|
-
* ## Unmount behavior
|
|
48
|
-
*
|
|
49
|
-
* By default, the hook cancels any pending execution when the component unmounts.
|
|
50
|
-
* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
|
|
51
|
-
*
|
|
52
|
-
* ```tsx
|
|
53
|
-
* const throttler = useThrottler(fn, {
|
|
54
|
-
* wait: 1000,
|
|
55
|
-
* onUnmount: (t) => t.flush()
|
|
56
|
-
* });
|
|
57
|
-
* ```
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* ```tsx
|
|
61
|
-
* // Default behavior - no reactive state subscriptions
|
|
62
|
-
* const [value, setValue] = useState(0);
|
|
63
|
-
* const throttler = useThrottler(setValue, { wait: 1000 });
|
|
64
|
-
*
|
|
65
|
-
* // Subscribe to state changes deep in component tree using Subscribe HOC
|
|
66
|
-
* <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
|
|
67
|
-
* {({ isPending }) => (
|
|
68
|
-
* <div>{isPending ? 'Processing...' : 'Ready'}</div>
|
|
69
|
-
* )}
|
|
70
|
-
* </throttler.Subscribe>
|
|
71
|
-
*
|
|
72
|
-
* // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)
|
|
73
|
-
* const [value, setValue] = useState(0);
|
|
74
|
-
* const throttler = useThrottler(
|
|
75
|
-
* setValue,
|
|
76
|
-
* { wait: 1000 },
|
|
77
|
-
* (state) => ({ executionCount: state.executionCount })
|
|
78
|
-
* );
|
|
79
|
-
*
|
|
80
|
-
* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
|
|
81
|
-
* const [value, setValue] = useState(0);
|
|
82
|
-
* const throttler = useThrottler(
|
|
83
|
-
* setValue,
|
|
84
|
-
* { wait: 1000 },
|
|
85
|
-
* (state) => ({
|
|
86
|
-
* isPending: state.isPending,
|
|
87
|
-
* status: state.status
|
|
88
|
-
* })
|
|
89
|
-
* );
|
|
90
|
-
*
|
|
91
|
-
* // Opt-in to re-render when timing information changes (optimized for timing displays)
|
|
92
|
-
* const [value, setValue] = useState(0);
|
|
93
|
-
* const throttler = useThrottler(
|
|
94
|
-
* setValue,
|
|
95
|
-
* { wait: 1000 },
|
|
96
|
-
* (state) => ({
|
|
97
|
-
* lastExecutionTime: state.lastExecutionTime,
|
|
98
|
-
* nextExecutionTime: state.nextExecutionTime
|
|
99
|
-
* })
|
|
100
|
-
* );
|
|
101
|
-
*
|
|
102
|
-
* // With any state manager
|
|
103
|
-
* const throttler = useThrottler(
|
|
104
|
-
* (value) => stateManager.setState(value),
|
|
105
|
-
* {
|
|
106
|
-
* wait: 2000,
|
|
107
|
-
* leading: true, // Execute immediately on first call
|
|
108
|
-
* trailing: false // Skip trailing edge updates
|
|
109
|
-
* }
|
|
110
|
-
* );
|
|
111
|
-
*
|
|
112
|
-
* // Access the selected state (will be empty object {} unless selector provided)
|
|
113
|
-
* const { executionCount, isPending } = throttler.state;
|
|
114
|
-
* ```
|
|
115
|
-
*/
|
|
116
|
-
function useThrottler(fn, options, selector = () => ({})) {
|
|
117
|
-
const mergedOptions = {
|
|
118
|
-
...require_PacerProvider.useDefaultPacerOptions().throttler,
|
|
119
|
-
...options
|
|
120
|
-
};
|
|
121
|
-
const [throttler] = (0, preact_hooks.useState)(() => {
|
|
122
|
-
const throttlerInstance = new _tanstack_pacer_throttler.Throttler(fn, mergedOptions);
|
|
123
|
-
throttlerInstance.Subscribe = function Subscribe(props) {
|
|
124
|
-
const selected = (0, _tanstack_preact_store.useSelector)(throttlerInstance.store, props.selector, { compare: _tanstack_preact_store.shallow });
|
|
125
|
-
return typeof props.children === "function" ? props.children(selected) : props.children;
|
|
126
|
-
};
|
|
127
|
-
return throttlerInstance;
|
|
128
|
-
});
|
|
129
|
-
throttler.fn = fn;
|
|
130
|
-
throttler.setOptions(mergedOptions);
|
|
131
|
-
const state = (0, _tanstack_preact_store.useSelector)(throttler.store, selector, { compare: _tanstack_preact_store.shallow });
|
|
132
|
-
(0, preact_hooks.useEffect)(() => {
|
|
133
|
-
return () => {
|
|
134
|
-
if (mergedOptions.onUnmount) mergedOptions.onUnmount(throttler);
|
|
135
|
-
else throttler.cancel();
|
|
136
|
-
};
|
|
137
|
-
}, []);
|
|
138
|
-
return (0, preact_hooks.useMemo)(() => ({
|
|
139
|
-
...throttler,
|
|
140
|
-
state
|
|
141
|
-
}), [throttler, state]);
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
//#endregion
|
|
145
|
-
exports.useThrottler = useThrottler;
|
|
146
|
-
//# sourceMappingURL=useThrottler.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottler.cjs","names":["useDefaultPacerOptions","Throttler","shallow"],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactThrottlerOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends ThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: PreactThrottler<TFn, TSelected>) => void\n}\n\nexport interface PreactThrottler<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.\n *\n * This is useful for opting into state re-renders for specific parts of the throttler state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: ThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the throttler state changes\n *\n * Use this instead of `throttler.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Preact's useState, see useThrottledState.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = useThrottler(fn, {\n * wait: 1000,\n * onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Processing...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n *\n * // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With any state manager\n * const throttler = useThrottler(\n * (value) => stateManager.setState(value),\n * {\n * wait: 2000,\n * leading: true, // Execute immediately on first call\n * trailing: false // Skip trailing edge updates\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottler<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: PreactThrottlerOptions<TFn, TSelected>,\n selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().throttler,\n ...options,\n } as PreactThrottlerOptions<TFn, TSelected>\n const [throttler] = useState(() => {\n const throttlerInstance = new Throttler<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactThrottler<TFn, TSelected>\n\n throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: ThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(throttlerInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return throttlerInstance\n })\n\n throttler.fn = fn\n throttler.setOptions(mergedOptions)\n\n const state = useSelector(throttler.store, selector, { compare: shallow })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(throttler)\n } else {\n throttler.cancel()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...throttler,\n state,\n }) as PreactThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n [throttler, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuKA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,8CAA4B;EACjC,MAAM,oBAAoB,IAAIC,oCAC5B,IACA,cACD;EAED,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,mDAAuB,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAASC,gCACV,CAAC;GAEF,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;EAGZ,OAAO;GACP;CAEF,UAAU,KAAK;CACf,UAAU,WAAW,cAAc;CAEnC,MAAM,gDAAoB,UAAU,OAAO,UAAU,EAAE,SAASA,gCAAS,CAAC;CAG1E,kCAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,UAAU;QAElC,UAAU,QAAQ;;IAGrB,EAAE,CAAC;CAGN,wCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
|
|
@@ -1,157 +0,0 @@
|
|
|
1
|
-
import { Store } from "@tanstack/preact-store";
|
|
2
|
-
import { ComponentChildren } from "preact";
|
|
3
|
-
import { AnyFunction } from "@tanstack/pacer/types";
|
|
4
|
-
import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
5
|
-
|
|
6
|
-
//#region src/throttler/useThrottler.d.ts
|
|
7
|
-
interface PreactThrottlerOptions<TFn extends AnyFunction, TSelected = {}> extends ThrottlerOptions<TFn> {
|
|
8
|
-
/**
|
|
9
|
-
* Optional callback invoked when the component unmounts. Receives the throttler instance.
|
|
10
|
-
* When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
|
|
11
|
-
*/
|
|
12
|
-
onUnmount?: (throttler: PreactThrottler<TFn, TSelected>) => void;
|
|
13
|
-
}
|
|
14
|
-
interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
|
|
15
|
-
/**
|
|
16
|
-
* A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.
|
|
17
|
-
*
|
|
18
|
-
* This is useful for opting into state re-renders for specific parts of the throttler state
|
|
19
|
-
* deep in your component tree without needing to pass a selector to the hook.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
|
|
23
|
-
* {({ isPending }) => (
|
|
24
|
-
* <div>{isPending ? 'Loading...' : 'Ready'}</div>
|
|
25
|
-
* )}
|
|
26
|
-
* </throttler.Subscribe>
|
|
27
|
-
*/
|
|
28
|
-
Subscribe: <TSelected>(props: {
|
|
29
|
-
selector: (state: ThrottlerState<TFn>) => TSelected;
|
|
30
|
-
children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
|
|
31
|
-
}) => ComponentChildren;
|
|
32
|
-
/**
|
|
33
|
-
* Reactive state that will be updated and re-rendered when the throttler state changes
|
|
34
|
-
*
|
|
35
|
-
* Use this instead of `throttler.store.state`
|
|
36
|
-
*/
|
|
37
|
-
readonly state: Readonly<TSelected>;
|
|
38
|
-
/**
|
|
39
|
-
* @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
|
|
40
|
-
* The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
|
|
41
|
-
* Although, you can make the state reactive by using the `useSelector` in your own usage.
|
|
42
|
-
*/
|
|
43
|
-
readonly store: Store<Readonly<ThrottlerState<TFn>>>;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
|
|
47
|
-
*
|
|
48
|
-
* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
|
|
49
|
-
* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
|
|
50
|
-
* integrates directly with Preact's useState, see useThrottledState.
|
|
51
|
-
*
|
|
52
|
-
* Throttling ensures a function executes at most once within a specified time window,
|
|
53
|
-
* regardless of how many times it is called. This is useful for rate-limiting
|
|
54
|
-
* expensive operations or UI updates.
|
|
55
|
-
*
|
|
56
|
-
* ## State Management and Selector
|
|
57
|
-
*
|
|
58
|
-
* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
|
|
59
|
-
* in two ways:
|
|
60
|
-
*
|
|
61
|
-
* **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
|
|
62
|
-
*
|
|
63
|
-
* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
|
|
64
|
-
* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
|
|
65
|
-
* in child components.
|
|
66
|
-
*
|
|
67
|
-
* **2. Using the `selector` parameter (For hook-level subscriptions)**
|
|
68
|
-
*
|
|
69
|
-
* The `selector` parameter allows you to specify which state changes will trigger a re-render
|
|
70
|
-
* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
|
|
71
|
-
* state changes occur.
|
|
72
|
-
*
|
|
73
|
-
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
74
|
-
* tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
|
|
75
|
-
* re-renders and gives you full control over when your component updates.
|
|
76
|
-
*
|
|
77
|
-
* Available state properties:
|
|
78
|
-
* - `executionCount`: Number of function executions that have been completed
|
|
79
|
-
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
80
|
-
* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
|
|
81
|
-
* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
|
|
82
|
-
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
83
|
-
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
84
|
-
*
|
|
85
|
-
* ## Unmount behavior
|
|
86
|
-
*
|
|
87
|
-
* By default, the hook cancels any pending execution when the component unmounts.
|
|
88
|
-
* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
|
|
89
|
-
*
|
|
90
|
-
* ```tsx
|
|
91
|
-
* const throttler = useThrottler(fn, {
|
|
92
|
-
* wait: 1000,
|
|
93
|
-
* onUnmount: (t) => t.flush()
|
|
94
|
-
* });
|
|
95
|
-
* ```
|
|
96
|
-
*
|
|
97
|
-
* @example
|
|
98
|
-
* ```tsx
|
|
99
|
-
* // Default behavior - no reactive state subscriptions
|
|
100
|
-
* const [value, setValue] = useState(0);
|
|
101
|
-
* const throttler = useThrottler(setValue, { wait: 1000 });
|
|
102
|
-
*
|
|
103
|
-
* // Subscribe to state changes deep in component tree using Subscribe HOC
|
|
104
|
-
* <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
|
|
105
|
-
* {({ isPending }) => (
|
|
106
|
-
* <div>{isPending ? 'Processing...' : 'Ready'}</div>
|
|
107
|
-
* )}
|
|
108
|
-
* </throttler.Subscribe>
|
|
109
|
-
*
|
|
110
|
-
* // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)
|
|
111
|
-
* const [value, setValue] = useState(0);
|
|
112
|
-
* const throttler = useThrottler(
|
|
113
|
-
* setValue,
|
|
114
|
-
* { wait: 1000 },
|
|
115
|
-
* (state) => ({ executionCount: state.executionCount })
|
|
116
|
-
* );
|
|
117
|
-
*
|
|
118
|
-
* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
|
|
119
|
-
* const [value, setValue] = useState(0);
|
|
120
|
-
* const throttler = useThrottler(
|
|
121
|
-
* setValue,
|
|
122
|
-
* { wait: 1000 },
|
|
123
|
-
* (state) => ({
|
|
124
|
-
* isPending: state.isPending,
|
|
125
|
-
* status: state.status
|
|
126
|
-
* })
|
|
127
|
-
* );
|
|
128
|
-
*
|
|
129
|
-
* // Opt-in to re-render when timing information changes (optimized for timing displays)
|
|
130
|
-
* const [value, setValue] = useState(0);
|
|
131
|
-
* const throttler = useThrottler(
|
|
132
|
-
* setValue,
|
|
133
|
-
* { wait: 1000 },
|
|
134
|
-
* (state) => ({
|
|
135
|
-
* lastExecutionTime: state.lastExecutionTime,
|
|
136
|
-
* nextExecutionTime: state.nextExecutionTime
|
|
137
|
-
* })
|
|
138
|
-
* );
|
|
139
|
-
*
|
|
140
|
-
* // With any state manager
|
|
141
|
-
* const throttler = useThrottler(
|
|
142
|
-
* (value) => stateManager.setState(value),
|
|
143
|
-
* {
|
|
144
|
-
* wait: 2000,
|
|
145
|
-
* leading: true, // Execute immediately on first call
|
|
146
|
-
* trailing: false // Skip trailing edge updates
|
|
147
|
-
* }
|
|
148
|
-
* );
|
|
149
|
-
*
|
|
150
|
-
* // Access the selected state (will be empty object {} unless selector provided)
|
|
151
|
-
* const { executionCount, isPending } = throttler.state;
|
|
152
|
-
* ```
|
|
153
|
-
*/
|
|
154
|
-
declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: PreactThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
|
|
155
|
-
//#endregion
|
|
156
|
-
export { PreactThrottler, PreactThrottlerOptions, useThrottler };
|
|
157
|
-
//# sourceMappingURL=useThrottler.d.cts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottler.js","names":[],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n ThrottlerOptions,\n ThrottlerState,\n} from '@tanstack/pacer/throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactThrottlerOptions<\n TFn extends AnyFunction,\n TSelected = {},\n> extends ThrottlerOptions<TFn> {\n /**\n * Optional callback invoked when the component unmounts. Receives the throttler instance.\n * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n */\n onUnmount?: (throttler: PreactThrottler<TFn, TSelected>) => void\n}\n\nexport interface PreactThrottler<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n /**\n * A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.\n *\n * This is useful for opting into state re-renders for specific parts of the throttler state\n * deep in your component tree without needing to pass a selector to the hook.\n *\n * @example\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Loading...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n */\n Subscribe: <TSelected>(props: {\n selector: (state: ThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) => ComponentChildren\n /**\n * Reactive state that will be updated and re-rendered when the throttler state changes\n *\n * Use this instead of `throttler.store.state`\n */\n readonly state: Readonly<TSelected>\n /**\n * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n * Although, you can make the state reactive by using the `useSelector` in your own usage.\n */\n readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Preact's useState, see useThrottledState.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = useThrottler(fn, {\n * wait: 1000,\n * onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n * {({ isPending }) => (\n * <div>{isPending ? 'Processing...' : 'Ready'}</div>\n * )}\n * </throttler.Subscribe>\n *\n * // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({\n * isPending: state.isPending,\n * status: state.status\n * })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n * setValue,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With any state manager\n * const throttler = useThrottler(\n * (value) => stateManager.setState(value),\n * {\n * wait: 2000,\n * leading: true, // Execute immediately on first call\n * trailing: false // Skip trailing edge updates\n * }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottler<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: PreactThrottlerOptions<TFn, TSelected>,\n selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().throttler,\n ...options,\n } as PreactThrottlerOptions<TFn, TSelected>\n const [throttler] = useState(() => {\n const throttlerInstance = new Throttler<TFn>(\n fn,\n mergedOptions,\n ) as unknown as PreactThrottler<TFn, TSelected>\n\n throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n selector: (state: ThrottlerState<TFn>) => TSelected\n children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n }) {\n const selected = useSelector(throttlerInstance.store, props.selector, {\n compare: shallow,\n })\n\n return typeof props.children === 'function'\n ? props.children(selected)\n : props.children\n }\n\n return throttlerInstance\n })\n\n throttler.fn = fn\n throttler.setOptions(mergedOptions)\n\n const state = useSelector(throttler.store, selector, { compare: shallow })\n\n /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n useEffect(() => {\n return () => {\n if (mergedOptions.onUnmount) {\n mergedOptions.onUnmount(throttler)\n } else {\n throttler.cancel()\n }\n }\n }, [])\n /* eslint-enable react-hooks/exhaustive-deps */\n\n return useMemo(\n () =>\n ({\n ...throttler,\n state,\n }) as PreactThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n [throttler, state],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuKA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,CAAC,aAAa,eAAe;EACjC,MAAM,oBAAoB,IAAI,UAC5B,IACA,cACD;EAED,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,YAAY,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAAS,SACV,CAAC;GAEF,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;EAGZ,OAAO;GACP;CAEF,UAAU,KAAK;CACf,UAAU,WAAW,cAAc;CAEnC,MAAM,QAAQ,YAAY,UAAU,OAAO,UAAU,EAAE,SAAS,SAAS,CAAC;CAG1E,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,UAAU;QAElC,UAAU,QAAQ;;IAGrB,EAAE,CAAC;CAGN,OAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
|
package/dist/types/index.cjs
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
var _tanstack_pacer_types = require("@tanstack/pacer/types");
|
|
4
|
-
Object.keys(_tanstack_pacer_types).forEach(function (k) {
|
|
5
|
-
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function () { return _tanstack_pacer_types[k]; }
|
|
8
|
-
});
|
|
9
|
-
});
|
package/dist/types/index.d.cts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "@tanstack/pacer/types";
|
package/dist/utils/index.cjs
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
var _tanstack_pacer_utils = require("@tanstack/pacer/utils");
|
|
4
|
-
Object.keys(_tanstack_pacer_utils).forEach(function (k) {
|
|
5
|
-
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function () { return _tanstack_pacer_utils[k]; }
|
|
8
|
-
});
|
|
9
|
-
});
|
package/dist/utils/index.d.cts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "@tanstack/pacer/utils";
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
import { useCallback } from 'preact/hooks'
|
|
2
|
-
import { useAsyncBatcher } from './useAsyncBatcher'
|
|
3
|
-
import type { PreactAsyncBatcherOptions } from './useAsyncBatcher'
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* A Preact hook that creates a batched version of an async callback function.
|
|
7
|
-
* This hook is a convenient wrapper around the `useAsyncBatcher` hook,
|
|
8
|
-
* providing a stable, batched async function reference for use in Preact components.
|
|
9
|
-
*
|
|
10
|
-
* The batched async function will collect individual calls into batches and execute them
|
|
11
|
-
* when batch conditions are met (max size reached, wait time elapsed, or custom logic).
|
|
12
|
-
* The returned function always returns a promise that resolves with undefined (since the
|
|
13
|
-
* batch function processes multiple items together).
|
|
14
|
-
*
|
|
15
|
-
* This hook provides a simpler API compared to `useAsyncBatcher`, making it ideal for basic
|
|
16
|
-
* async batching needs. However, it does not expose the underlying AsyncBatcher instance.
|
|
17
|
-
*
|
|
18
|
-
* For advanced usage requiring features like:
|
|
19
|
-
* - Manual batch execution
|
|
20
|
-
* - Access to batch results and state
|
|
21
|
-
* - Custom useCallback dependencies
|
|
22
|
-
*
|
|
23
|
-
* Consider using the `useAsyncBatcher` hook instead.
|
|
24
|
-
*
|
|
25
|
-
* @example
|
|
26
|
-
* ```tsx
|
|
27
|
-
* // Batch API requests
|
|
28
|
-
* const batchApiCall = useAsyncBatchedCallback(async (requests: ApiRequest[]) => {
|
|
29
|
-
* const results = await Promise.all(requests.map(req => fetch(req.url)));
|
|
30
|
-
* return results.map(res => res.json());
|
|
31
|
-
* }, {
|
|
32
|
-
* maxSize: 10, // Process when 10 requests collected
|
|
33
|
-
* wait: 1000 // Or after 1 second
|
|
34
|
-
* });
|
|
35
|
-
*
|
|
36
|
-
* // Use in event handlers
|
|
37
|
-
* <button onClick={() => batchApiCall({ url: '/api/analytics', data: eventData })}>
|
|
38
|
-
* Track Event
|
|
39
|
-
* </button>
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
export function useAsyncBatchedCallback<TValue>(
|
|
43
|
-
fn: (items: Array<TValue>) => Promise<unknown>,
|
|
44
|
-
options: PreactAsyncBatcherOptions<TValue, {}>,
|
|
45
|
-
): (item: TValue) => Promise<void> {
|
|
46
|
-
const asyncBatchedFn = useAsyncBatcher(fn, options).addItem
|
|
47
|
-
return useCallback(
|
|
48
|
-
async (item: TValue) => {
|
|
49
|
-
await asyncBatchedFn(item)
|
|
50
|
-
},
|
|
51
|
-
[asyncBatchedFn],
|
|
52
|
-
)
|
|
53
|
-
}
|