@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/throttler/useThrottler.cjs

@@ -0,0 +1,109 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let __tanstack_preact_store = require("@tanstack/preact-store");
+let __tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
+
+//#region src/throttler/useThrottler.ts
+/**
+* A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
+*
+* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
+* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+* integrates directly with Preact's useState, see useThrottledState.
+*
+* Throttling ensures a function executes at most once within a specified time window,
+* regardless of how many times it is called. This is useful for rate-limiting
+* expensive operations or UI updates.
+*
+* ## 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
+* - `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] = useState(0);
+* const throttler = useThrottler(setValue, { wait: 1000 });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking executions)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { 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] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With any state manager
+* const throttler = useThrottler(
+*   (value) => stateManager.setState(value),
+*   {
+*     wait: 2000,
+*     leading: true,   // Execute immediately on first call
+*     trailing: false  // Skip trailing edge updates
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { executionCount, isPending } = throttler.state;
+* ```
+*/
+function useThrottler(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().throttler,
+		...options
+	};
+	const [throttler] = (0, preact_hooks.useState)(() => new __tanstack_pacer_throttler.Throttler(fn, mergedOptions));
+	throttler.fn = fn;
+	throttler.setOptions(mergedOptions);
+	const state = (0, __tanstack_preact_store.useStore)(throttler.store, selector);
+	(0, preact_hooks.useEffect)(() => {
+		return () => {
+			throttler.cancel();
+		};
+	}, [throttler]);
+	return (0, preact_hooks.useMemo)(() => ({
+		...throttler,
+		state
+	}), [throttler, state]);
+}
+
+//#endregion
+exports.useThrottler = useThrottler;
+//# sourceMappingURL=useThrottler.cjs.map

package/dist/throttler/useThrottler.cjs.map

@@ -0,0 +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'\n\nexport interface PreactThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\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. 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 * - `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 * // Opt-in to re-render when execution count changes (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: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const [throttler] = useState(() => new Throttler<TFn>(fn, mergedOptions))\n\n  throttler.fn = fn\n  throttler.setOptions(mergedOptions)\n\n  const state = useStore(throttler.store, selector)\n\n  useEffect(() => {\n    return () => {\n      throttler.cancel()\n    }\n  }, [throttler])\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6GA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,8CAA4B,IAAIC,qCAAe,IAAI,cAAc,CAAC;AAEzE,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;CAEnC,MAAM,8CAAiB,UAAU,OAAO,SAAS;AAEjD,mCAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;AAEf,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}

package/dist/throttler/useThrottler.d.cts

@@ -0,0 +1,103 @@
+import { Store } from "@tanstack/preact-store";
+import { AnyFunction } from "@tanstack/pacer/types";
+import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/useThrottler.d.ts
+interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the throttler state changes
+   *
+   * Use this instead of `throttler.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
+   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<ThrottlerState<TFn>>>;
+}
+/**
+ * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
+ *
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+ * integrates directly with Preact's useState, see useThrottledState.
+ *
+ * Throttling ensures a function executes at most once within a specified time window,
+ * regardless of how many times it is called. This is useful for rate-limiting
+ * expensive operations or UI updates.
+ *
+ * ## 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
+ * - `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] = useState(0);
+ * const throttler = useThrottler(setValue, { wait: 1000 });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking executions)
+ * const [value, setValue] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+ * const [value, setValue] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { 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] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({
+ *     lastExecutionTime: state.lastExecutionTime,
+ *     nextExecutionTime: state.nextExecutionTime
+ *   })
+ * );
+ *
+ * // With any state manager
+ * const throttler = useThrottler(
+ *   (value) => stateManager.setState(value),
+ *   {
+ *     wait: 2000,
+ *     leading: true,   // Execute immediately on first call
+ *     trailing: false  // Skip trailing edge updates
+ *   }
+ * );
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { executionCount, isPending } = throttler.state;
+ * ```
+ */
+declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
+//#endregion
+export { PreactThrottler, useThrottler };
+//# sourceMappingURL=useThrottler.d.cts.map

package/dist/throttler/useThrottler.d.ts

@@ -0,0 +1,103 @@
+import { Store } from "@tanstack/preact-store";
+import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/throttler/useThrottler.d.ts
+interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the throttler state changes
+   *
+   * Use this instead of `throttler.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
+   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<ThrottlerState<TFn>>>;
+}
+/**
+ * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
+ *
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+ * integrates directly with Preact's useState, see useThrottledState.
+ *
+ * Throttling ensures a function executes at most once within a specified time window,
+ * regardless of how many times it is called. This is useful for rate-limiting
+ * expensive operations or UI updates.
+ *
+ * ## 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
+ * - `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] = useState(0);
+ * const throttler = useThrottler(setValue, { wait: 1000 });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking executions)
+ * const [value, setValue] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+ * const [value, setValue] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { 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] = useState(0);
+ * const throttler = useThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({
+ *     lastExecutionTime: state.lastExecutionTime,
+ *     nextExecutionTime: state.nextExecutionTime
+ *   })
+ * );
+ *
+ * // With any state manager
+ * const throttler = useThrottler(
+ *   (value) => stateManager.setState(value),
+ *   {
+ *     wait: 2000,
+ *     leading: true,   // Execute immediately on first call
+ *     trailing: false  // Skip trailing edge updates
+ *   }
+ * );
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { executionCount, isPending } = throttler.state;
+ * ```
+ */
+declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
+//#endregion
+export { PreactThrottler, useThrottler };
+//# sourceMappingURL=useThrottler.d.ts.map

package/dist/throttler/useThrottler.js

@@ -0,0 +1,109 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useEffect, useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { Throttler } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/useThrottler.ts
+/**
+* A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
+*
+* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
+* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+* integrates directly with Preact's useState, see useThrottledState.
+*
+* Throttling ensures a function executes at most once within a specified time window,
+* regardless of how many times it is called. This is useful for rate-limiting
+* expensive operations or UI updates.
+*
+* ## 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
+* - `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] = useState(0);
+* const throttler = useThrottler(setValue, { wait: 1000 });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking executions)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { 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] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With any state manager
+* const throttler = useThrottler(
+*   (value) => stateManager.setState(value),
+*   {
+*     wait: 2000,
+*     leading: true,   // Execute immediately on first call
+*     trailing: false  // Skip trailing edge updates
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { executionCount, isPending } = throttler.state;
+* ```
+*/
+function useThrottler(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().throttler,
+		...options
+	};
+	const [throttler] = useState(() => new Throttler(fn, mergedOptions));
+	throttler.fn = fn;
+	throttler.setOptions(mergedOptions);
+	const state = useStore(throttler.store, selector);
+	useEffect(() => {
+		return () => {
+			throttler.cancel();
+		};
+	}, [throttler]);
+	return useMemo(() => ({
+		...throttler,
+		state
+	}), [throttler, state]);
+}
+
+//#endregion
+export { useThrottler };
+//# sourceMappingURL=useThrottler.js.map

package/dist/throttler/useThrottler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThrottler.js","names":[],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { 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'\n\nexport interface PreactThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\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. 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 * - `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 * // Opt-in to re-render when execution count changes (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: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const [throttler] = useState(() => new Throttler<TFn>(fn, mergedOptions))\n\n  throttler.fn = fn\n  throttler.setOptions(mergedOptions)\n\n  const state = useStore(throttler.store, selector)\n\n  useEffect(() => {\n    return () => {\n      throttler.cancel()\n    }\n  }, [throttler])\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6GA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,aAAa,eAAe,IAAI,UAAe,IAAI,cAAc,CAAC;AAEzE,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;CAEnC,MAAM,QAAQ,SAAS,UAAU,OAAO,SAAS;AAEjD,iBAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;AAEf,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}

package/dist/types/index.cjs

@@ -0,0 +1,9 @@
+
+
+var __tanstack_pacer_types = require("@tanstack/pacer/types");
+Object.keys(__tanstack_pacer_types).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_types[k]; }
+  });
+});

package/dist/types/index.d.cts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/types";

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/types";

package/dist/types/index.js

@@ -0,0 +1,3 @@
+export * from "@tanstack/pacer/types"
+
+export {  };

package/dist/utils/index.cjs

@@ -0,0 +1,9 @@
+
+
+var __tanstack_pacer_utils = require("@tanstack/pacer/utils");
+Object.keys(__tanstack_pacer_utils).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_utils[k]; }
+  });
+});

package/dist/utils/index.d.cts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/utils";

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/utils";

package/dist/utils/index.js

@@ -0,0 +1,3 @@
+export * from "@tanstack/pacer/utils"
+
+export {  };

package/package.json

@@ -1,10 +1,121 @@
 {
   "name": "@tanstack/preact-pacer",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tanstack/preact-pacer",
+  "version": "0.18.0",
+  "description": "Utilities for debouncing and throttling functions in Preact.",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/pacer.git",
+    "directory": "packages/preact-pacer"
+  },
+  "homepage": "https://tanstack.com/pacer",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "preact",
+    "debounce",
+    "throttle",
+    "rate-limit",
+    "queue",
+    "async"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.cts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    },
+    "./async-batcher": {
+      "require": "./dist/async-batcher/index.cjs",
+      "import": "./dist/async-batcher/index.js"
+    },
+    "./async-debouncer": {
+      "require": "./dist/async-debouncer/index.cjs",
+      "import": "./dist/async-debouncer/index.js"
+    },
+    "./async-queuer": {
+      "require": "./dist/async-queuer/index.cjs",
+      "import": "./dist/async-queuer/index.js"
+    },
+    "./async-rate-limiter": {
+      "require": "./dist/async-rate-limiter/index.cjs",
+      "import": "./dist/async-rate-limiter/index.js"
+    },
+    "./async-retryer": {
+      "require": "./dist/async-retryer/index.cjs",
+      "import": "./dist/async-retryer/index.js"
+    },
+    "./async-throttler": {
+      "require": "./dist/async-throttler/index.cjs",
+      "import": "./dist/async-throttler/index.js"
+    },
+    "./batcher": {
+      "require": "./dist/batcher/index.cjs",
+      "import": "./dist/batcher/index.js"
+    },
+    "./debouncer": {
+      "require": "./dist/debouncer/index.cjs",
+      "import": "./dist/debouncer/index.js"
+    },
+    "./provider": {
+      "require": "./dist/provider/index.cjs",
+      "import": "./dist/provider/index.js"
+    },
+    "./queuer": {
+      "require": "./dist/queuer/index.cjs",
+      "import": "./dist/queuer/index.js"
+    },
+    "./rate-limiter": {
+      "require": "./dist/rate-limiter/index.cjs",
+      "import": "./dist/rate-limiter/index.js"
+    },
+    "./throttler": {
+      "require": "./dist/throttler/index.cjs",
+      "import": "./dist/throttler/index.js"
+    },
+    "./types": {
+      "require": "./dist/types/index.cjs",
+      "import": "./dist/types/index.js"
+    },
+    "./utils": {
+      "require": "./dist/utils/index.cjs",
+      "import": "./dist/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@tanstack/preact-store": "^0.10.1",
+    "@tanstack/pacer": "0.17.0"
+  },
+  "devDependencies": {
+    "@preact/preset-vite": "^2.10.2",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "preact": "^10.28.0"
+  },
+  "peerDependencies": {
+    "preact": ">=10.0.0"
+  },
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest --passWithNoTests",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc",
+    "test:build": "publint --strict",
+    "build": "tsdown"
+  }
+}

package/src/async-batcher/index.ts

@@ -0,0 +1,4 @@
+export * from '@tanstack/pacer/async-batcher'
+
+export * from './useAsyncBatcher'
+export * from './useAsyncBatchedCallback'