@tanstack/preact-pacer 0.19.4 → 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/dist/async-batcher/index.cjs +1 -0
- package/dist/async-batcher/index.d.cts +2 -2
- package/dist/async-batcher/index.d.ts +2 -2
- package/dist/async-batcher/useAsyncBatchedCallback.cjs +2 -2
- package/dist/async-batcher/useAsyncBatchedCallback.cjs.map +1 -1
- package/dist/async-batcher/useAsyncBatchedCallback.d.cts +2 -3
- package/dist/async-batcher/useAsyncBatchedCallback.d.ts +2 -3
- package/dist/async-batcher/useAsyncBatchedCallback.js +2 -2
- package/dist/async-batcher/useAsyncBatchedCallback.js.map +1 -1
- package/dist/async-batcher/useAsyncBatcher.cjs +28 -0
- package/dist/async-batcher/useAsyncBatcher.cjs.map +1 -1
- package/dist/async-batcher/useAsyncBatcher.d.cts +28 -2
- package/dist/async-batcher/useAsyncBatcher.d.ts +28 -2
- package/dist/async-batcher/useAsyncBatcher.js +29 -1
- package/dist/async-batcher/useAsyncBatcher.js.map +1 -1
- package/dist/async-debouncer/index.cjs +1 -0
- package/dist/async-debouncer/index.d.cts +2 -2
- package/dist/async-debouncer/index.d.ts +2 -2
- package/dist/async-debouncer/useAsyncDebouncedCallback.cjs.map +1 -1
- package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts +2 -2
- package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts +2 -2
- package/dist/async-debouncer/useAsyncDebouncedCallback.js.map +1 -1
- package/dist/async-debouncer/useAsyncDebouncer.cjs +24 -2
- package/dist/async-debouncer/useAsyncDebouncer.cjs.map +1 -1
- package/dist/async-debouncer/useAsyncDebouncer.d.cts +28 -3
- package/dist/async-debouncer/useAsyncDebouncer.d.ts +27 -2
- package/dist/async-debouncer/useAsyncDebouncer.js +24 -2
- package/dist/async-debouncer/useAsyncDebouncer.js.map +1 -1
- package/dist/async-queuer/index.cjs +1 -0
- package/dist/async-queuer/index.d.cts +2 -2
- package/dist/async-queuer/index.d.ts +2 -2
- package/dist/async-queuer/useAsyncQueuedState.cjs.map +1 -1
- package/dist/async-queuer/useAsyncQueuedState.d.cts +3 -3
- package/dist/async-queuer/useAsyncQueuedState.d.ts +3 -3
- package/dist/async-queuer/useAsyncQueuedState.js.map +1 -1
- package/dist/async-queuer/useAsyncQueuer.cjs +28 -0
- package/dist/async-queuer/useAsyncQueuer.cjs.map +1 -1
- package/dist/async-queuer/useAsyncQueuer.d.cts +28 -2
- package/dist/async-queuer/useAsyncQueuer.d.ts +28 -2
- package/dist/async-queuer/useAsyncQueuer.js +29 -1
- package/dist/async-queuer/useAsyncQueuer.js.map +1 -1
- package/dist/async-rate-limiter/index.cjs +1 -0
- package/dist/async-rate-limiter/index.d.cts +2 -2
- package/dist/async-rate-limiter/index.d.ts +2 -2
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map +1 -1
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.cts +2 -2
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.d.ts +2 -2
- package/dist/async-rate-limiter/useAsyncRateLimitedCallback.js.map +1 -1
- package/dist/async-rate-limiter/useAsyncRateLimiter.cjs +12 -0
- package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map +1 -1
- package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts +15 -2
- package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts +15 -2
- package/dist/async-rate-limiter/useAsyncRateLimiter.js +13 -1
- package/dist/async-rate-limiter/useAsyncRateLimiter.js.map +1 -1
- package/dist/async-throttler/index.cjs +1 -0
- package/dist/async-throttler/index.d.cts +2 -2
- package/dist/async-throttler/index.d.ts +2 -2
- package/dist/async-throttler/useAsyncThrottledCallback.cjs.map +1 -1
- package/dist/async-throttler/useAsyncThrottledCallback.d.cts +2 -2
- package/dist/async-throttler/useAsyncThrottledCallback.d.ts +2 -2
- package/dist/async-throttler/useAsyncThrottledCallback.js.map +1 -1
- package/dist/async-throttler/useAsyncThrottler.cjs +26 -2
- package/dist/async-throttler/useAsyncThrottler.cjs.map +1 -1
- package/dist/async-throttler/useAsyncThrottler.d.cts +27 -2
- package/dist/async-throttler/useAsyncThrottler.d.ts +27 -2
- package/dist/async-throttler/useAsyncThrottler.js +26 -2
- package/dist/async-throttler/useAsyncThrottler.js.map +1 -1
- package/dist/batcher/index.cjs +1 -0
- package/dist/batcher/index.d.cts +2 -2
- package/dist/batcher/index.d.ts +2 -2
- package/dist/batcher/useBatchedCallback.cjs +1 -1
- package/dist/batcher/useBatchedCallback.cjs.map +1 -1
- package/dist/batcher/useBatchedCallback.d.cts +2 -3
- package/dist/batcher/useBatchedCallback.d.ts +2 -3
- package/dist/batcher/useBatchedCallback.js +1 -1
- package/dist/batcher/useBatchedCallback.js.map +1 -1
- package/dist/batcher/useBatcher.cjs +19 -0
- package/dist/batcher/useBatcher.cjs.map +1 -1
- package/dist/batcher/useBatcher.d.cts +22 -2
- package/dist/batcher/useBatcher.d.ts +22 -2
- package/dist/batcher/useBatcher.js +20 -1
- package/dist/batcher/useBatcher.js.map +1 -1
- package/dist/debouncer/index.cjs +1 -0
- package/dist/debouncer/index.d.cts +2 -2
- package/dist/debouncer/index.d.ts +2 -2
- package/dist/debouncer/useDebouncedCallback.cjs.map +1 -1
- package/dist/debouncer/useDebouncedCallback.d.cts +2 -2
- package/dist/debouncer/useDebouncedCallback.d.ts +2 -2
- package/dist/debouncer/useDebouncedCallback.js.map +1 -1
- package/dist/debouncer/useDebouncedState.cjs.map +1 -1
- package/dist/debouncer/useDebouncedState.d.cts +3 -3
- package/dist/debouncer/useDebouncedState.d.ts +3 -3
- package/dist/debouncer/useDebouncedState.js.map +1 -1
- package/dist/debouncer/useDebouncedValue.cjs.map +1 -1
- package/dist/debouncer/useDebouncedValue.d.cts +3 -3
- package/dist/debouncer/useDebouncedValue.d.ts +3 -3
- package/dist/debouncer/useDebouncedValue.js.map +1 -1
- package/dist/debouncer/useDebouncer.cjs +15 -2
- package/dist/debouncer/useDebouncer.cjs.map +1 -1
- package/dist/debouncer/useDebouncer.d.cts +21 -2
- package/dist/debouncer/useDebouncer.d.ts +21 -2
- package/dist/debouncer/useDebouncer.js +15 -2
- package/dist/debouncer/useDebouncer.js.map +1 -1
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +11 -11
- package/dist/index.d.ts +11 -11
- package/dist/provider/PacerProvider.d.cts +2 -2
- package/dist/provider/PacerProvider.d.ts +2 -2
- package/dist/provider/index.cjs +1 -0
- package/dist/queuer/index.cjs +1 -0
- package/dist/queuer/index.d.cts +2 -2
- package/dist/queuer/index.d.ts +2 -2
- package/dist/queuer/useQueuedState.cjs.map +1 -1
- package/dist/queuer/useQueuedState.d.cts +3 -3
- package/dist/queuer/useQueuedState.d.ts +3 -3
- package/dist/queuer/useQueuedState.js.map +1 -1
- package/dist/queuer/useQueuedValue.cjs.map +1 -1
- package/dist/queuer/useQueuedValue.d.cts +3 -3
- package/dist/queuer/useQueuedValue.d.ts +3 -3
- package/dist/queuer/useQueuedValue.js.map +1 -1
- package/dist/queuer/useQueuer.cjs +19 -0
- package/dist/queuer/useQueuer.cjs.map +1 -1
- package/dist/queuer/useQueuer.d.cts +22 -2
- package/dist/queuer/useQueuer.d.ts +22 -2
- package/dist/queuer/useQueuer.js +20 -1
- package/dist/queuer/useQueuer.js.map +1 -1
- package/dist/rate-limiter/index.cjs +1 -0
- package/dist/rate-limiter/index.d.cts +2 -2
- package/dist/rate-limiter/index.d.ts +2 -2
- package/dist/rate-limiter/useRateLimitedCallback.cjs.map +1 -1
- package/dist/rate-limiter/useRateLimitedCallback.d.cts +2 -2
- package/dist/rate-limiter/useRateLimitedCallback.d.ts +2 -2
- package/dist/rate-limiter/useRateLimitedCallback.js.map +1 -1
- package/dist/rate-limiter/useRateLimitedState.cjs.map +1 -1
- package/dist/rate-limiter/useRateLimitedState.d.cts +3 -3
- package/dist/rate-limiter/useRateLimitedState.d.ts +3 -3
- package/dist/rate-limiter/useRateLimitedState.js.map +1 -1
- package/dist/rate-limiter/useRateLimitedValue.cjs.map +1 -1
- package/dist/rate-limiter/useRateLimitedValue.d.cts +3 -3
- package/dist/rate-limiter/useRateLimitedValue.d.ts +3 -3
- package/dist/rate-limiter/useRateLimitedValue.js.map +1 -1
- package/dist/rate-limiter/useRateLimiter.cjs +5 -0
- package/dist/rate-limiter/useRateLimiter.cjs.map +1 -1
- package/dist/rate-limiter/useRateLimiter.d.cts +9 -2
- package/dist/rate-limiter/useRateLimiter.d.ts +9 -2
- package/dist/rate-limiter/useRateLimiter.js +6 -1
- package/dist/rate-limiter/useRateLimiter.js.map +1 -1
- package/dist/throttler/index.cjs +1 -0
- package/dist/throttler/index.d.cts +2 -2
- package/dist/throttler/index.d.ts +2 -2
- package/dist/throttler/useThrottledCallback.cjs.map +1 -1
- package/dist/throttler/useThrottledCallback.d.cts +2 -2
- package/dist/throttler/useThrottledCallback.d.ts +2 -2
- package/dist/throttler/useThrottledCallback.js.map +1 -1
- package/dist/throttler/useThrottledState.cjs.map +1 -1
- package/dist/throttler/useThrottledState.d.cts +3 -3
- package/dist/throttler/useThrottledState.d.ts +3 -3
- package/dist/throttler/useThrottledState.js.map +1 -1
- package/dist/throttler/useThrottledValue.cjs.map +1 -1
- package/dist/throttler/useThrottledValue.d.cts +3 -3
- package/dist/throttler/useThrottledValue.d.ts +3 -3
- package/dist/throttler/useThrottledValue.js.map +1 -1
- package/dist/throttler/useThrottler.cjs +15 -2
- package/dist/throttler/useThrottler.cjs.map +1 -1
- package/dist/throttler/useThrottler.d.cts +21 -2
- package/dist/throttler/useThrottler.d.ts +21 -2
- package/dist/throttler/useThrottler.js +15 -2
- package/dist/throttler/useThrottler.js.map +1 -1
- package/package.json +36 -35
- package/src/async-batcher/useAsyncBatchedCallback.ts +7 -8
- package/src/async-batcher/useAsyncBatcher.ts +46 -4
- package/src/async-debouncer/useAsyncDebouncedCallback.ts +2 -2
- package/src/async-debouncer/useAsyncDebouncer.ts +40 -5
- package/src/async-queuer/useAsyncQueuedState.ts +5 -5
- package/src/async-queuer/useAsyncQueuer.ts +46 -4
- package/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +2 -2
- package/src/async-rate-limiter/useAsyncRateLimiter.ts +32 -3
- package/src/async-throttler/useAsyncThrottledCallback.ts +2 -2
- package/src/async-throttler/useAsyncThrottler.ts +42 -5
- package/src/batcher/useBatchedCallback.ts +6 -10
- package/src/batcher/useBatcher.ts +39 -3
- package/src/debouncer/useDebouncedCallback.ts +2 -2
- package/src/debouncer/useDebouncedState.ts +3 -6
- package/src/debouncer/useDebouncedValue.ts +3 -6
- package/src/debouncer/useDebouncer.ts +33 -5
- package/src/queuer/useQueuedState.ts +3 -3
- package/src/queuer/useQueuedValue.ts +3 -3
- package/src/queuer/useQueuer.ts +39 -3
- package/src/rate-limiter/useRateLimitedCallback.ts +2 -2
- package/src/rate-limiter/useRateLimitedState.ts +6 -6
- package/src/rate-limiter/useRateLimitedValue.ts +6 -6
- package/src/rate-limiter/useRateLimiter.ts +24 -4
- package/src/throttler/useThrottledCallback.ts +2 -2
- package/src/throttler/useThrottledState.ts +3 -6
- package/src/throttler/useThrottledValue.ts +3 -6
- package/src/throttler/useThrottler.ts +33 -5
|
@@ -1,5 +1,5 @@
|
|
|
1
|
+
import { PreactThrottlerOptions } from "./useThrottler.cjs";
|
|
1
2
|
import { AnyFunction } from "@tanstack/pacer/types";
|
|
2
|
-
import { ThrottlerOptions } from "@tanstack/pacer/throttler";
|
|
3
3
|
|
|
4
4
|
//#region src/throttler/useThrottledCallback.d.ts
|
|
5
5
|
/**
|
|
@@ -39,7 +39,7 @@ import { ThrottlerOptions } from "@tanstack/pacer/throttler";
|
|
|
39
39
|
* }, [handleResize]);
|
|
40
40
|
* ```
|
|
41
41
|
*/
|
|
42
|
-
declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options:
|
|
42
|
+
declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options: PreactThrottlerOptions<TFn, {}>): (...args: Parameters<TFn>) => void;
|
|
43
43
|
//#endregion
|
|
44
44
|
export { useThrottledCallback };
|
|
45
45
|
//# sourceMappingURL=useThrottledCallback.d.cts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { PreactThrottlerOptions } from "./useThrottler.js";
|
|
2
2
|
import { AnyFunction } from "@tanstack/pacer/types";
|
|
3
3
|
|
|
4
4
|
//#region src/throttler/useThrottledCallback.d.ts
|
|
@@ -39,7 +39,7 @@ import { AnyFunction } from "@tanstack/pacer/types";
|
|
|
39
39
|
* }, [handleResize]);
|
|
40
40
|
* ```
|
|
41
41
|
*/
|
|
42
|
-
declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options:
|
|
42
|
+
declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options: PreactThrottlerOptions<TFn, {}>): (...args: Parameters<TFn>) => void;
|
|
43
43
|
//#endregion
|
|
44
44
|
export { useThrottledCallback };
|
|
45
45
|
//# sourceMappingURL=useThrottledCallback.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottledCallback.js","names":[],"sources":["../../src/throttler/useThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type {
|
|
1
|
+
{"version":3,"file":"useThrottledCallback.js","names":[],"sources":["../../src/throttler/useThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { PreactThrottlerOptions } from './useThrottler'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of a callback function.\n * This hook is essentially a wrapper around the basic `throttle` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The throttled function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed.\n *\n * This hook provides a simpler API compared to `useThrottler`, making it ideal for basic\n * throttling needs. However, it does not expose the underlying Throttler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useThrottler` hook instead.\n *\n * @example\n * ```tsx\n * // Throttle a window resize handler\n * const handleResize = useThrottledCallback(() => {\n * updateLayoutMeasurements();\n * }, {\n * wait: 100 // Execute at most once every 100ms\n * });\n *\n * // Use in an event listener\n * useEffect(() => {\n * window.addEventListener('resize', handleResize);\n * return () => window.removeEventListener('resize', handleResize);\n * }, [handleResize]);\n * ```\n */\nexport function useThrottledCallback<TFn extends AnyFunction>(\n fn: TFn,\n options: PreactThrottlerOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => void {\n const throttledFn = useThrottler(fn, options).maybeExecute\n return useCallback(\n (...args: Parameters<TFn>) => throttledFn(...args),\n [throttledFn],\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,qBACd,IACA,SACoC;CACpC,MAAM,cAAc,aAAa,IAAI,QAAQ,CAAC;AAC9C,QAAO,aACJ,GAAG,SAA0B,YAAY,GAAG,KAAK,EAClD,CAAC,YAAY,CACd"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottledState.cjs","names":["useThrottler"],"sources":["../../src/throttler/useThrottledState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler } from './useThrottler'\nimport type {
|
|
1
|
+
{"version":3,"file":"useThrottledState.cjs","names":["useThrottler"],"sources":["../../src/throttler/useThrottledState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'\nimport type { ThrottlerState } from '@tanstack/pacer/throttler'\n\n/**\n * A Preact hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Preact's useState with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without 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 [value, setValue, throttler] = useThrottledState(0, { wait: 1000 });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking executions)\n * const [value, setValue, throttler] = useThrottledState(\n * 0,\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, throttler] = useThrottledState(\n * 0,\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, throttler] = useThrottledState(\n * 0,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = useThrottledState(0, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access throttler methods if needed\n * const handleReset = () => {\n * setValue(0);\n * throttler.cancel(); // Cancel any pending updates\n * };\n *\n * // Access the selected throttler state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\n\nexport function useThrottledState<\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): [\n TValue,\n Dispatch<StateUpdater<TValue>>,\n PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>,\n] {\n const [throttledValue, setThrottledValue] = useState<TValue>(value)\n const throttler = useThrottler(\n setThrottledValue,\n options,\n selector as (\n state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n ) => TSelected,\n )\n return [\n throttledValue,\n throttler.maybeExecute as Dispatch<StateUpdater<TValue>>,\n throttler,\n ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0FA,SAAgB,kBAId,OACA,SACA,UAOA;CACA,MAAM,CAAC,gBAAgB,gDAAsC,MAAM;CACnE,MAAM,YAAYA,kCAChB,mBACA,SACA,SAGD;AACD,QAAO;EACL;EACA,UAAU;EACV;EACD"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { PreactThrottler } from "./useThrottler.cjs";
|
|
1
|
+
import { PreactThrottler, PreactThrottlerOptions } from "./useThrottler.cjs";
|
|
2
2
|
import { Dispatch, StateUpdater } from "preact/hooks";
|
|
3
|
-
import {
|
|
3
|
+
import { ThrottlerState } from "@tanstack/pacer/throttler";
|
|
4
4
|
|
|
5
5
|
//#region src/throttler/useThrottledState.d.ts
|
|
6
6
|
/**
|
|
@@ -86,7 +86,7 @@ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
|
86
86
|
* const { executionCount, isPending } = throttler.state;
|
|
87
87
|
* ```
|
|
88
88
|
*/
|
|
89
|
-
declare function useThrottledState<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options:
|
|
89
|
+
declare function useThrottledState<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>, selector?: (state: ThrottlerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, Dispatch<StateUpdater<TValue>>, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>];
|
|
90
90
|
//#endregion
|
|
91
91
|
export { useThrottledState };
|
|
92
92
|
//# sourceMappingURL=useThrottledState.d.cts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { PreactThrottler } from "./useThrottler.js";
|
|
1
|
+
import { PreactThrottler, PreactThrottlerOptions } from "./useThrottler.js";
|
|
2
2
|
import { Dispatch, StateUpdater } from "preact/hooks";
|
|
3
|
-
import {
|
|
3
|
+
import { ThrottlerState } from "@tanstack/pacer/throttler";
|
|
4
4
|
|
|
5
5
|
//#region src/throttler/useThrottledState.d.ts
|
|
6
6
|
/**
|
|
@@ -86,7 +86,7 @@ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
|
86
86
|
* const { executionCount, isPending } = throttler.state;
|
|
87
87
|
* ```
|
|
88
88
|
*/
|
|
89
|
-
declare function useThrottledState<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options:
|
|
89
|
+
declare function useThrottledState<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>, selector?: (state: ThrottlerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, Dispatch<StateUpdater<TValue>>, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>];
|
|
90
90
|
//#endregion
|
|
91
91
|
export { useThrottledState };
|
|
92
92
|
//# sourceMappingURL=useThrottledState.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottledState.js","names":[],"sources":["../../src/throttler/useThrottledState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler } from './useThrottler'\nimport type {
|
|
1
|
+
{"version":3,"file":"useThrottledState.js","names":[],"sources":["../../src/throttler/useThrottledState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'\nimport type { ThrottlerState } from '@tanstack/pacer/throttler'\n\n/**\n * A Preact hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Preact's useState with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without 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 [value, setValue, throttler] = useThrottledState(0, { wait: 1000 });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking executions)\n * const [value, setValue, throttler] = useThrottledState(\n * 0,\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, throttler] = useThrottledState(\n * 0,\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, throttler] = useThrottledState(\n * 0,\n * { wait: 1000 },\n * (state) => ({\n * lastExecutionTime: state.lastExecutionTime,\n * nextExecutionTime: state.nextExecutionTime\n * })\n * );\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = useThrottledState(0, {\n * wait: 1000,\n * leading: true, // Update immediately on first change\n * trailing: false // Skip trailing edge updates\n * });\n *\n * // Access throttler methods if needed\n * const handleReset = () => {\n * setValue(0);\n * throttler.cancel(); // Cancel any pending updates\n * };\n *\n * // Access the selected throttler state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\n\nexport function useThrottledState<\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): [\n TValue,\n Dispatch<StateUpdater<TValue>>,\n PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>,\n] {\n const [throttledValue, setThrottledValue] = useState<TValue>(value)\n const throttler = useThrottler(\n setThrottledValue,\n options,\n selector as (\n state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,\n ) => TSelected,\n )\n return [\n throttledValue,\n throttler.maybeExecute as Dispatch<StateUpdater<TValue>>,\n throttler,\n ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0FA,SAAgB,kBAId,OACA,SACA,UAOA;CACA,MAAM,CAAC,gBAAgB,qBAAqB,SAAiB,MAAM;CACnE,MAAM,YAAY,aAChB,mBACA,SACA,SAGD;AACD,QAAO;EACL;EACA,UAAU;EACV;EACD"}
|
|
@@ -1 +1 @@
|
|
|
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 } from './useThrottler'\nimport type {
|
|
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;AAED,mCAAgB;AACb,EAAC,kBAA8C,MAAM;IACrD,CAAC,OAAO,kBAAkB,CAAC;AAE9B,QAAO,CAAC,gBAAgB,UAAU"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { PreactThrottler } from "./useThrottler.cjs";
|
|
1
|
+
import { PreactThrottler, PreactThrottlerOptions } from "./useThrottler.cjs";
|
|
2
2
|
import { Dispatch, StateUpdater } from "preact/hooks";
|
|
3
|
-
import {
|
|
3
|
+
import { ThrottlerState } from "@tanstack/pacer/throttler";
|
|
4
4
|
|
|
5
5
|
//#region src/throttler/useThrottledValue.d.ts
|
|
6
6
|
/**
|
|
@@ -79,7 +79,7 @@ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
|
79
79
|
* const { executionCount, isPending } = throttler.state;
|
|
80
80
|
* ```
|
|
81
81
|
*/
|
|
82
|
-
declare function useThrottledValue<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options:
|
|
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
83
|
//#endregion
|
|
84
84
|
export { useThrottledValue };
|
|
85
85
|
//# sourceMappingURL=useThrottledValue.d.cts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { PreactThrottler } from "./useThrottler.js";
|
|
1
|
+
import { PreactThrottler, PreactThrottlerOptions } from "./useThrottler.js";
|
|
2
2
|
import { Dispatch, StateUpdater } from "preact/hooks";
|
|
3
|
-
import {
|
|
3
|
+
import { ThrottlerState } from "@tanstack/pacer/throttler";
|
|
4
4
|
|
|
5
5
|
//#region src/throttler/useThrottledValue.d.ts
|
|
6
6
|
/**
|
|
@@ -79,7 +79,7 @@ import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
|
79
79
|
* const { executionCount, isPending } = throttler.state;
|
|
80
80
|
* ```
|
|
81
81
|
*/
|
|
82
|
-
declare function useThrottledValue<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options:
|
|
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
83
|
//#endregion
|
|
84
84
|
export { useThrottledValue };
|
|
85
85
|
//# sourceMappingURL=useThrottledValue.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
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 } from './useThrottler'\nimport type {
|
|
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;AAED,iBAAgB;AACb,EAAC,kBAA8C,MAAM;IACrD,CAAC,OAAO,kBAAkB,CAAC;AAE9B,QAAO,CAAC,gBAAgB,UAAU"}
|
|
@@ -44,6 +44,18 @@ let _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
|
|
|
44
44
|
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
45
45
|
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
46
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
|
+
*
|
|
47
59
|
* @example
|
|
48
60
|
* ```tsx
|
|
49
61
|
* // Default behavior - no reactive state subscriptions
|
|
@@ -119,9 +131,10 @@ function useThrottler(fn, options, selector = () => ({})) {
|
|
|
119
131
|
const state = (0, _tanstack_preact_store.useStore)(throttler.store, selector);
|
|
120
132
|
(0, preact_hooks.useEffect)(() => {
|
|
121
133
|
return () => {
|
|
122
|
-
|
|
134
|
+
if (mergedOptions.onUnmount) mergedOptions.onUnmount(throttler);
|
|
135
|
+
else throttler.cancel();
|
|
123
136
|
};
|
|
124
|
-
}, [
|
|
137
|
+
}, []);
|
|
125
138
|
return (0, preact_hooks.useMemo)(() => ({
|
|
126
139
|
...throttler,
|
|
127
140
|
state
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useThrottler.cjs","names":["useDefaultPacerOptions","Throttler"],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { useStore } 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 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 `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` 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 * @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:
|
|
1
|
+
{"version":3,"file":"useThrottler.cjs","names":["useDefaultPacerOptions","Throttler"],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { useStore } 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 `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` 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 = useStore(throttlerInstance.store, props.selector)\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 = useStore(throttler.store, selector)\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;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,gDAAoB,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;CAEnC,MAAM,6CAAiB,UAAU,OAAO,SAAS;AAGjD,mCAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,UAAU;OAElC,WAAU,QAAQ;;IAGrB,EAAE,CAAC;AAGN,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
|
|
@@ -4,6 +4,13 @@ import { AnyFunction } from "@tanstack/pacer/types";
|
|
|
4
4
|
import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
|
|
5
5
|
|
|
6
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
|
+
}
|
|
7
14
|
interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
|
|
8
15
|
/**
|
|
9
16
|
* A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.
|
|
@@ -75,6 +82,18 @@ interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<
|
|
|
75
82
|
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
76
83
|
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
77
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
|
+
*
|
|
78
97
|
* @example
|
|
79
98
|
* ```tsx
|
|
80
99
|
* // Default behavior - no reactive state subscriptions
|
|
@@ -132,7 +151,7 @@ interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<
|
|
|
132
151
|
* const { executionCount, isPending } = throttler.state;
|
|
133
152
|
* ```
|
|
134
153
|
*/
|
|
135
|
-
declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options:
|
|
154
|
+
declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: PreactThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
|
|
136
155
|
//#endregion
|
|
137
|
-
export { PreactThrottler, useThrottler };
|
|
156
|
+
export { PreactThrottler, PreactThrottlerOptions, useThrottler };
|
|
138
157
|
//# sourceMappingURL=useThrottler.d.cts.map
|
|
@@ -4,6 +4,13 @@ import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/thr
|
|
|
4
4
|
import { AnyFunction } from "@tanstack/pacer/types";
|
|
5
5
|
|
|
6
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
|
+
}
|
|
7
14
|
interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
|
|
8
15
|
/**
|
|
9
16
|
* A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.
|
|
@@ -75,6 +82,18 @@ interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<
|
|
|
75
82
|
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
76
83
|
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
77
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
|
+
*
|
|
78
97
|
* @example
|
|
79
98
|
* ```tsx
|
|
80
99
|
* // Default behavior - no reactive state subscriptions
|
|
@@ -132,7 +151,7 @@ interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<
|
|
|
132
151
|
* const { executionCount, isPending } = throttler.state;
|
|
133
152
|
* ```
|
|
134
153
|
*/
|
|
135
|
-
declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options:
|
|
154
|
+
declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: PreactThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
|
|
136
155
|
//#endregion
|
|
137
|
-
export { PreactThrottler, useThrottler };
|
|
156
|
+
export { PreactThrottler, PreactThrottlerOptions, useThrottler };
|
|
138
157
|
//# sourceMappingURL=useThrottler.d.ts.map
|
|
@@ -44,6 +44,18 @@ import { Throttler } from "@tanstack/pacer/throttler";
|
|
|
44
44
|
* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
|
|
45
45
|
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
46
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
|
+
*
|
|
47
59
|
* @example
|
|
48
60
|
* ```tsx
|
|
49
61
|
* // Default behavior - no reactive state subscriptions
|
|
@@ -119,9 +131,10 @@ function useThrottler(fn, options, selector = () => ({})) {
|
|
|
119
131
|
const state = useStore(throttler.store, selector);
|
|
120
132
|
useEffect(() => {
|
|
121
133
|
return () => {
|
|
122
|
-
|
|
134
|
+
if (mergedOptions.onUnmount) mergedOptions.onUnmount(throttler);
|
|
135
|
+
else throttler.cancel();
|
|
123
136
|
};
|
|
124
|
-
}, [
|
|
137
|
+
}, []);
|
|
125
138
|
return useMemo(() => ({
|
|
126
139
|
...throttler,
|
|
127
140
|
state
|
|
@@ -1 +1 @@
|
|
|
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 { useStore } 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 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 `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` 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 * @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:
|
|
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 { useStore } 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 `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` 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 = useStore(throttlerInstance.store, props.selector)\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 = useStore(throttler.store, selector)\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;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;CAEnC,MAAM,QAAQ,SAAS,UAAU,OAAO,SAAS;AAGjD,iBAAgB;AACd,eAAa;AACX,OAAI,cAAc,UAChB,eAAc,UAAU,UAAU;OAElC,WAAU,QAAQ;;IAGrB,EAAE,CAAC;AAGN,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/preact-pacer",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0",
|
|
4
4
|
"description": "Utilities for debouncing and throttling functions in Preact.",
|
|
5
5
|
"author": "Tanner Linsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -28,64 +28,64 @@
|
|
|
28
28
|
"module": "./dist/index.js",
|
|
29
29
|
"exports": {
|
|
30
30
|
".": {
|
|
31
|
-
"
|
|
32
|
-
"
|
|
31
|
+
"import": "./dist/index.js",
|
|
32
|
+
"require": "./dist/index.cjs"
|
|
33
33
|
},
|
|
34
34
|
"./async-batcher": {
|
|
35
|
-
"
|
|
36
|
-
"
|
|
35
|
+
"import": "./dist/async-batcher/index.js",
|
|
36
|
+
"require": "./dist/async-batcher/index.cjs"
|
|
37
37
|
},
|
|
38
38
|
"./async-debouncer": {
|
|
39
|
-
"
|
|
40
|
-
"
|
|
39
|
+
"import": "./dist/async-debouncer/index.js",
|
|
40
|
+
"require": "./dist/async-debouncer/index.cjs"
|
|
41
41
|
},
|
|
42
42
|
"./async-queuer": {
|
|
43
|
-
"
|
|
44
|
-
"
|
|
43
|
+
"import": "./dist/async-queuer/index.js",
|
|
44
|
+
"require": "./dist/async-queuer/index.cjs"
|
|
45
45
|
},
|
|
46
46
|
"./async-rate-limiter": {
|
|
47
|
-
"
|
|
48
|
-
"
|
|
47
|
+
"import": "./dist/async-rate-limiter/index.js",
|
|
48
|
+
"require": "./dist/async-rate-limiter/index.cjs"
|
|
49
49
|
},
|
|
50
50
|
"./async-retryer": {
|
|
51
|
-
"
|
|
52
|
-
"
|
|
51
|
+
"import": "./dist/async-retryer/index.js",
|
|
52
|
+
"require": "./dist/async-retryer/index.cjs"
|
|
53
53
|
},
|
|
54
54
|
"./async-throttler": {
|
|
55
|
-
"
|
|
56
|
-
"
|
|
55
|
+
"import": "./dist/async-throttler/index.js",
|
|
56
|
+
"require": "./dist/async-throttler/index.cjs"
|
|
57
57
|
},
|
|
58
58
|
"./batcher": {
|
|
59
|
-
"
|
|
60
|
-
"
|
|
59
|
+
"import": "./dist/batcher/index.js",
|
|
60
|
+
"require": "./dist/batcher/index.cjs"
|
|
61
61
|
},
|
|
62
62
|
"./debouncer": {
|
|
63
|
-
"
|
|
64
|
-
"
|
|
63
|
+
"import": "./dist/debouncer/index.js",
|
|
64
|
+
"require": "./dist/debouncer/index.cjs"
|
|
65
65
|
},
|
|
66
66
|
"./provider": {
|
|
67
|
-
"
|
|
68
|
-
"
|
|
67
|
+
"import": "./dist/provider/index.js",
|
|
68
|
+
"require": "./dist/provider/index.cjs"
|
|
69
69
|
},
|
|
70
70
|
"./queuer": {
|
|
71
|
-
"
|
|
72
|
-
"
|
|
71
|
+
"import": "./dist/queuer/index.js",
|
|
72
|
+
"require": "./dist/queuer/index.cjs"
|
|
73
73
|
},
|
|
74
74
|
"./rate-limiter": {
|
|
75
|
-
"
|
|
76
|
-
"
|
|
75
|
+
"import": "./dist/rate-limiter/index.js",
|
|
76
|
+
"require": "./dist/rate-limiter/index.cjs"
|
|
77
77
|
},
|
|
78
78
|
"./throttler": {
|
|
79
|
-
"
|
|
80
|
-
"
|
|
79
|
+
"import": "./dist/throttler/index.js",
|
|
80
|
+
"require": "./dist/throttler/index.cjs"
|
|
81
81
|
},
|
|
82
82
|
"./types": {
|
|
83
|
-
"
|
|
84
|
-
"
|
|
83
|
+
"import": "./dist/types/index.js",
|
|
84
|
+
"require": "./dist/types/index.cjs"
|
|
85
85
|
},
|
|
86
86
|
"./utils": {
|
|
87
|
-
"
|
|
88
|
-
"
|
|
87
|
+
"import": "./dist/utils/index.js",
|
|
88
|
+
"require": "./dist/utils/index.cjs"
|
|
89
89
|
},
|
|
90
90
|
"./package.json": "./package.json"
|
|
91
91
|
},
|
|
@@ -98,19 +98,20 @@
|
|
|
98
98
|
"src"
|
|
99
99
|
],
|
|
100
100
|
"dependencies": {
|
|
101
|
-
"@tanstack/preact-store": "^0.10.
|
|
102
|
-
"@tanstack/pacer": "0.
|
|
101
|
+
"@tanstack/preact-store": "^0.10.2",
|
|
102
|
+
"@tanstack/pacer": "0.19.0"
|
|
103
103
|
},
|
|
104
104
|
"devDependencies": {
|
|
105
|
-
"@preact/preset-vite": "^2.10.
|
|
105
|
+
"@preact/preset-vite": "^2.10.3",
|
|
106
106
|
"eslint-plugin-react-hooks": "^7.0.1",
|
|
107
|
-
"preact": "^10.28.
|
|
107
|
+
"preact": "^10.28.3"
|
|
108
108
|
},
|
|
109
109
|
"peerDependencies": {
|
|
110
110
|
"preact": ">=10.0.0"
|
|
111
111
|
},
|
|
112
112
|
"scripts": {
|
|
113
113
|
"clean": "premove ./build ./dist",
|
|
114
|
+
"lint:fix": "eslint ./src --fix",
|
|
114
115
|
"test:eslint": "eslint ./src",
|
|
115
116
|
"test:lib": "vitest --passWithNoTests",
|
|
116
117
|
"test:lib:dev": "pnpm test:lib --watch",
|