@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/rate-limiter/useRateLimiter.js

@@ -0,0 +1,138 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { RateLimiter } from "@tanstack/pacer/rate-limiter";
+
+//#region src/rate-limiter/useRateLimiter.ts
+/**
+* A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
+*
+* This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
+* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
+*
+* Rate limiting is a simple "hard limit" approach that allows executions until a maximum count is reached within
+* a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
+* it does not attempt to space out or collapse executions intelligently.
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All executions within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+*   consistent rate of execution over time.
+*
+* For smoother execution patterns:
+* - Use throttling when you want consistent spacing between executions (e.g. UI updates)
+* - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
+* - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, optimizing performance by preventing
+* unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `executionCount`: Number of function executions that have been completed
+* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+*
+* The hook returns an object containing:
+* - maybeExecute: The rate-limited function that respects the configured limits
+* - getExecutionCount: Returns the number of successful executions
+* - getRejectionCount: Returns the number of rejected executions due to rate limiting
+* - getRemainingInWindow: Returns how many more executions are allowed in the current window
+* - reset: Resets the execution counts and window timing
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const rateLimiter = useRateLimiter(apiCall, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding',
+* });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking successful executions)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ rejectionCount: state.rejectionCount })
+* );
+*
+* // Opt-in to re-render when execution times change (optimized for window calculations)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // Multiple state properties - re-render when any of these change
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Monitor rate limit status
+* const handleClick = () => {
+*   const remaining = rateLimiter.getRemainingInWindow();
+*   if (remaining > 0) {
+*     rateLimiter.maybeExecute(data);
+*   } else {
+*     showRateLimitWarning();
+*   }
+* };
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { executionCount, rejectionCount } = rateLimiter.state;
+* ```
+*/
+function useRateLimiter(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().rateLimiter,
+		...options
+	};
+	const [rateLimiter] = useState(() => new RateLimiter(fn, mergedOptions));
+	rateLimiter.fn = fn;
+	rateLimiter.setOptions(mergedOptions);
+	const state = useStore(rateLimiter.store, selector);
+	return useMemo(() => ({
+		...rateLimiter,
+		state
+	}), [rateLimiter, state]);
+}
+
+//#endregion
+export { useRateLimiter };
+//# sourceMappingURL=useRateLimiter.js.map

package/dist/rate-limiter/useRateLimiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimiter.js","names":[],"sources":["../../src/rate-limiter/useRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\nexport interface PreactRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, 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<RateLimiterState>>\n}\n\n/**\n * A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * 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 state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n *\n * The hook returns an object containing:\n * - maybeExecute: The rate-limited function that respects the configured limits\n * - getExecutionCount: Returns the number of successful executions\n * - getRejectionCount: Returns the number of rejected executions due to rate limiting\n * - getRemainingInWindow: Returns how many more executions are allowed in the current window\n * - reset: Resets the execution counts and window timing\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = useRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n * });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking successful executions)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   const remaining = rateLimiter.getRemainingInWindow();\n *   if (remaining > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, rejectionCount } = rateLimiter.state;\n * ```\n */\nexport function useRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: RateLimiterOptions<TFn>,\n  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): PreactRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().rateLimiter,\n    ...options,\n  } as RateLimiterOptions<TFn>\n\n  const [rateLimiter] = useState(() => new RateLimiter<TFn>(fn, mergedOptions))\n\n  rateLimiter.fn = fn\n  rateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(rateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...rateLimiter,\n        state,\n      }) as PreactRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [rateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+IA,SAAgB,eACd,IACA,SACA,kBAA0D,EAAE,GACzB;CACnC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,eAAe,eAAe,IAAI,YAAiB,IAAI,cAAc,CAAC;AAE7E,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}

package/dist/throttler/index.cjs

@@ -0,0 +1,16 @@
+const require_useThrottler = require('./useThrottler.cjs');
+const require_useThrottledCallback = require('./useThrottledCallback.cjs');
+const require_useThrottledState = require('./useThrottledState.cjs');
+const require_useThrottledValue = require('./useThrottledValue.cjs');
+
+exports.useThrottledCallback = require_useThrottledCallback.useThrottledCallback;
+exports.useThrottledState = require_useThrottledState.useThrottledState;
+exports.useThrottledValue = require_useThrottledValue.useThrottledValue;
+exports.useThrottler = require_useThrottler.useThrottler;
+var __tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
+Object.keys(__tanstack_pacer_throttler).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_throttler[k]; }
+  });
+});

package/dist/throttler/index.d.cts

@@ -0,0 +1,6 @@
+import { useThrottledCallback } from "./useThrottledCallback.cjs";
+import { PreactThrottler, useThrottler } from "./useThrottler.cjs";
+import { useThrottledState } from "./useThrottledState.cjs";
+import { useThrottledValue } from "./useThrottledValue.cjs";
+export * from "@tanstack/pacer/throttler";
+export { PreactThrottler, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };

package/dist/throttler/index.d.ts

@@ -0,0 +1,6 @@
+import { useThrottledCallback } from "./useThrottledCallback.js";
+import { PreactThrottler, useThrottler } from "./useThrottler.js";
+import { useThrottledState } from "./useThrottledState.js";
+import { useThrottledValue } from "./useThrottledValue.js";
+export * from "@tanstack/pacer/throttler";
+export { PreactThrottler, useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };

package/dist/throttler/index.js

@@ -0,0 +1,8 @@
+import { useThrottler } from "./useThrottler.js";
+import { useThrottledCallback } from "./useThrottledCallback.js";
+import { useThrottledState } from "./useThrottledState.js";
+import { useThrottledValue } from "./useThrottledValue.js";
+
+export * from "@tanstack/pacer/throttler"
+
+export { useThrottledCallback, useThrottledState, useThrottledValue, useThrottler };

package/dist/throttler/useThrottledCallback.cjs

@@ -0,0 +1,49 @@
+const require_useThrottler = require('./useThrottler.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/throttler/useThrottledCallback.ts
+/**
+* A Preact hook that creates a throttled version of a callback function.
+* This hook is essentially a wrapper around the basic `throttle` function
+* that is exported from `@tanstack/pacer`,
+* but optimized for Preact with reactive options and a stable function reference.
+*
+* The throttled function will execute at most once within the specified wait time period,
+* regardless of how many times it is called. If called multiple times during the wait period,
+* only the first invocation will execute, and subsequent calls will be ignored until
+* the wait period has elapsed.
+*
+* This hook provides a simpler API compared to `useThrottler`, making it ideal for basic
+* throttling needs. However, it does not expose the underlying Throttler instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution counts
+* - Custom useCallback dependencies
+*
+* Consider using the `useThrottler` hook instead.
+*
+* @example
+* ```tsx
+* // Throttle a window resize handler
+* const handleResize = useThrottledCallback(() => {
+*   updateLayoutMeasurements();
+* }, {
+*   wait: 100 // Execute at most once every 100ms
+* });
+*
+* // Use in an event listener
+* useEffect(() => {
+*   window.addEventListener('resize', handleResize);
+*   return () => window.removeEventListener('resize', handleResize);
+* }, [handleResize]);
+* ```
+*/
+function useThrottledCallback(fn, options) {
+	const throttledFn = require_useThrottler.useThrottler(fn, options).maybeExecute;
+	return (0, preact_hooks.useCallback)((...args) => throttledFn(...args), [throttledFn]);
+}
+
+//#endregion
+exports.useThrottledCallback = useThrottledCallback;
+//# sourceMappingURL=useThrottledCallback.cjs.map

package/dist/throttler/useThrottledCallback.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThrottledCallback.cjs","names":["useThrottler"],"sources":["../../src/throttler/useThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\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: ThrottlerOptions<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,cAAcA,kCAAa,IAAI,QAAQ,CAAC;AAC9C,uCACG,GAAG,SAA0B,YAAY,GAAG,KAAK,EAClD,CAAC,YAAY,CACd"}

package/dist/throttler/useThrottledCallback.d.cts

@@ -0,0 +1,46 @@
+import { AnyFunction } from "@tanstack/pacer/types";
+import { ThrottlerOptions } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/useThrottledCallback.d.ts
+
+/**
+ * A Preact hook that creates a throttled version of a callback function.
+ * This hook is essentially a wrapper around the basic `throttle` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The throttled function will execute at most once within the specified wait time period,
+ * regardless of how many times it is called. If called multiple times during the wait period,
+ * only the first invocation will execute, and subsequent calls will be ignored until
+ * the wait period has elapsed.
+ *
+ * This hook provides a simpler API compared to `useThrottler`, making it ideal for basic
+ * throttling needs. However, it does not expose the underlying Throttler instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useThrottler` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Throttle a window resize handler
+ * const handleResize = useThrottledCallback(() => {
+ *   updateLayoutMeasurements();
+ * }, {
+ *   wait: 100 // Execute at most once every 100ms
+ * });
+ *
+ * // Use in an event listener
+ * useEffect(() => {
+ *   window.addEventListener('resize', handleResize);
+ *   return () => window.removeEventListener('resize', handleResize);
+ * }, [handleResize]);
+ * ```
+ */
+declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useThrottledCallback };
+//# sourceMappingURL=useThrottledCallback.d.cts.map

package/dist/throttler/useThrottledCallback.d.ts

@@ -0,0 +1,46 @@
+import { ThrottlerOptions } from "@tanstack/pacer/throttler";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/throttler/useThrottledCallback.d.ts
+
+/**
+ * A Preact hook that creates a throttled version of a callback function.
+ * This hook is essentially a wrapper around the basic `throttle` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The throttled function will execute at most once within the specified wait time period,
+ * regardless of how many times it is called. If called multiple times during the wait period,
+ * only the first invocation will execute, and subsequent calls will be ignored until
+ * the wait period has elapsed.
+ *
+ * This hook provides a simpler API compared to `useThrottler`, making it ideal for basic
+ * throttling needs. However, it does not expose the underlying Throttler instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useThrottler` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Throttle a window resize handler
+ * const handleResize = useThrottledCallback(() => {
+ *   updateLayoutMeasurements();
+ * }, {
+ *   wait: 100 // Execute at most once every 100ms
+ * });
+ *
+ * // Use in an event listener
+ * useEffect(() => {
+ *   window.addEventListener('resize', handleResize);
+ *   return () => window.removeEventListener('resize', handleResize);
+ * }, [handleResize]);
+ * ```
+ */
+declare function useThrottledCallback<TFn extends AnyFunction>(fn: TFn, options: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useThrottledCallback };
+//# sourceMappingURL=useThrottledCallback.d.ts.map

package/dist/throttler/useThrottledCallback.js

@@ -0,0 +1,49 @@
+import { useThrottler } from "./useThrottler.js";
+import { useCallback } from "preact/hooks";
+
+//#region src/throttler/useThrottledCallback.ts
+/**
+* A Preact hook that creates a throttled version of a callback function.
+* This hook is essentially a wrapper around the basic `throttle` function
+* that is exported from `@tanstack/pacer`,
+* but optimized for Preact with reactive options and a stable function reference.
+*
+* The throttled function will execute at most once within the specified wait time period,
+* regardless of how many times it is called. If called multiple times during the wait period,
+* only the first invocation will execute, and subsequent calls will be ignored until
+* the wait period has elapsed.
+*
+* This hook provides a simpler API compared to `useThrottler`, making it ideal for basic
+* throttling needs. However, it does not expose the underlying Throttler instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution counts
+* - Custom useCallback dependencies
+*
+* Consider using the `useThrottler` hook instead.
+*
+* @example
+* ```tsx
+* // Throttle a window resize handler
+* const handleResize = useThrottledCallback(() => {
+*   updateLayoutMeasurements();
+* }, {
+*   wait: 100 // Execute at most once every 100ms
+* });
+*
+* // Use in an event listener
+* useEffect(() => {
+*   window.addEventListener('resize', handleResize);
+*   return () => window.removeEventListener('resize', handleResize);
+* }, [handleResize]);
+* ```
+*/
+function useThrottledCallback(fn, options) {
+	const throttledFn = useThrottler(fn, options).maybeExecute;
+	return useCallback((...args) => throttledFn(...args), [throttledFn]);
+}
+
+//#endregion
+export { useThrottledCallback };
+//# sourceMappingURL=useThrottledCallback.js.map

package/dist/throttler/useThrottledCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThrottledCallback.js","names":[],"sources":["../../src/throttler/useThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useThrottler } from './useThrottler'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\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: ThrottlerOptions<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"}

package/dist/throttler/useThrottledState.cjs

@@ -0,0 +1,100 @@
+const require_useThrottler = require('./useThrottler.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/throttler/useThrottledState.ts
+/**
+* A Preact hook that creates a throttled state value that updates at most once within a specified time window.
+* This hook combines Preact's useState with throttling functionality to provide controlled state updates.
+*
+* Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.
+* This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.
+*
+* The hook returns a tuple containing:
+* - The throttled state value
+* - A throttled setter function that respects the configured wait time
+* - The throttler instance for additional control
+*
+* For more direct control over throttling without state management,
+* consider using the lower-level useThrottler hook instead.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management via the underlying throttler instance.
+* The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,
+* optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available throttler state properties:
+* - `executionCount`: Number of function executions that have been completed
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
+* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
+* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [value, setValue, throttler] = useThrottledState(0, { wait: 1000 });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking executions)
+* const [value, setValue, throttler] = useThrottledState(
+*   0,
+*   { wait: 1000 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+* const [value, setValue, throttler] = useThrottledState(
+*   0,
+*   { wait: 1000 },
+*   (state) => ({
+*     isPending: state.isPending,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when timing information changes (optimized for timing displays)
+* const [value, setValue, throttler] = useThrottledState(
+*   0,
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With custom leading/trailing behavior
+* const [value, setValue] = useThrottledState(0, {
+*   wait: 1000,
+*   leading: true,   // Update immediately on first change
+*   trailing: false  // Skip trailing edge updates
+* });
+*
+* // Access throttler methods if needed
+* const handleReset = () => {
+*   setValue(0);
+*   throttler.cancel(); // Cancel any pending updates
+* };
+*
+* // Access the selected throttler state (will be empty object {} unless selector provided)
+* const { executionCount, isPending } = throttler.state;
+* ```
+*/
+function useThrottledState(value, options, selector) {
+	const [throttledValue, setThrottledValue] = (0, preact_hooks.useState)(value);
+	const throttler = require_useThrottler.useThrottler(setThrottledValue, options, selector);
+	return [
+		throttledValue,
+		throttler.maybeExecute,
+		throttler
+	];
+}
+
+//#endregion
+exports.useThrottledState = useThrottledState;
+//# sourceMappingURL=useThrottledState.cjs.map

package/dist/throttler/useThrottledState.cjs.map

@@ -0,0 +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 {\n  ThrottlerOptions,\n  ThrottlerState,\n} 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: ThrottlerOptions<Dispatch<StateUpdater<TValue>>>,\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,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"}

package/dist/throttler/useThrottledState.d.cts

@@ -0,0 +1,93 @@
+import { PreactThrottler } from "./useThrottler.cjs";
+import { Dispatch, StateUpdater } from "preact/hooks";
+import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/useThrottledState.d.ts
+
+/**
+ * A Preact hook that creates a throttled state value that updates at most once within a specified time window.
+ * This hook combines Preact's useState with throttling functionality to provide controlled state updates.
+ *
+ * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.
+ * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.
+ *
+ * The hook returns a tuple containing:
+ * - The throttled state value
+ * - A throttled setter function that respects the configured wait time
+ * - The throttler instance for additional control
+ *
+ * For more direct control over throttling without state management,
+ * consider using the lower-level useThrottler hook instead.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
+ * The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available throttler state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
+ * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [value, setValue, throttler] = useThrottledState(0, { wait: 1000 });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking executions)
+ * const [value, setValue, throttler] = useThrottledState(
+ *   0,
+ *   { wait: 1000 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+ * const [value, setValue, throttler] = useThrottledState(
+ *   0,
+ *   { wait: 1000 },
+ *   (state) => ({
+ *     isPending: state.isPending,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when timing information changes (optimized for timing displays)
+ * const [value, setValue, throttler] = useThrottledState(
+ *   0,
+ *   { wait: 1000 },
+ *   (state) => ({
+ *     lastExecutionTime: state.lastExecutionTime,
+ *     nextExecutionTime: state.nextExecutionTime
+ *   })
+ * );
+ *
+ * // With custom leading/trailing behavior
+ * const [value, setValue] = useThrottledState(0, {
+ *   wait: 1000,
+ *   leading: true,   // Update immediately on first change
+ *   trailing: false  // Skip trailing edge updates
+ * });
+ *
+ * // Access throttler methods if needed
+ * const handleReset = () => {
+ *   setValue(0);
+ *   throttler.cancel(); // Cancel any pending updates
+ * };
+ *
+ * // Access the selected throttler state (will be empty object {} unless selector provided)
+ * const { executionCount, isPending } = throttler.state;
+ * ```
+ */
+declare function useThrottledState<TValue, TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: ThrottlerOptions<Dispatch<StateUpdater<TValue>>>, selector?: (state: ThrottlerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, Dispatch<StateUpdater<TValue>>, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>];
+//#endregion
+export { useThrottledState };
+//# sourceMappingURL=useThrottledState.d.cts.map