@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/debouncer/useDebouncedValue.d.cts

@@ -0,0 +1,91 @@
+import { PreactDebouncer } from "./useDebouncer.cjs";
+import { DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
+import { Dispatch, StateUpdater } from "preact/hooks";
+
+//#region src/debouncer/useDebouncedValue.d.ts
+
+/**
+ * A Preact hook that creates a debounced value that updates only after a specified delay.
+ * Unlike useDebouncedState, this hook automatically tracks changes to the input value
+ * and updates the debounced value accordingly.
+ *
+ * The debounced value will only update after the specified wait time has elapsed since
+ * the last change to the input value. If the input value changes again before the wait
+ * time expires, the timer resets and starts waiting again.
+ *
+ * This is useful for deriving debounced values from props or state that change frequently,
+ * like search queries or form inputs, where you want to limit how often downstream effects
+ * or calculations occur.
+ *
+ * The hook returns the current debounced value and the underlying debouncer instance.
+ * The debouncer instance can be used to access additional functionality like cancellation
+ * and execution counts.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying debouncer instance.
+ * The `selector` parameter allows you to specify which debouncer 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 debouncer state properties:
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+ * - `executionCount`: Number of function executions that have been completed
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [searchQuery, setSearchQuery] = useState('');
+ * const [debouncedQuery, debouncer] = useDebouncedValue(searchQuery, {
+ *   wait: 500 // Wait 500ms after last change
+ * });
+ *
+ * // Opt-in to re-render when pending state changes (optimized for loading indicators)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking executions)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when debouncing status changes (optimized for status display)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({
+ *     status: state.status,
+ *     canLeadingExecute: state.canLeadingExecute
+ *   })
+ * );
+ *
+ * // debouncedQuery will update 500ms after searchQuery stops changing
+ * useEffect(() => {
+ *   fetchSearchResults(debouncedQuery);
+ * }, [debouncedQuery]);
+ *
+ * // Handle input changes
+ * const handleChange = (e) => {
+ *   setSearchQuery(e.target.value);
+ * };
+ *
+ * // Access the selected debouncer state (will be empty object {} unless selector provided)
+ * const { isPending, executionCount } = debouncer.state;
+ * ```
+ */
+declare function useDebouncedValue<TValue, TSelected = DebouncerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: DebouncerOptions<Dispatch<StateUpdater<TValue>>>, selector?: (state: DebouncerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, PreactDebouncer<Dispatch<StateUpdater<TValue>>, TSelected>];
+//#endregion
+export { useDebouncedValue };
+//# sourceMappingURL=useDebouncedValue.d.cts.map

package/dist/debouncer/useDebouncedValue.d.ts

@@ -0,0 +1,91 @@
+import { PreactDebouncer } from "./useDebouncer.js";
+import { Dispatch, StateUpdater } from "preact/hooks";
+import { DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
+
+//#region src/debouncer/useDebouncedValue.d.ts
+
+/**
+ * A Preact hook that creates a debounced value that updates only after a specified delay.
+ * Unlike useDebouncedState, this hook automatically tracks changes to the input value
+ * and updates the debounced value accordingly.
+ *
+ * The debounced value will only update after the specified wait time has elapsed since
+ * the last change to the input value. If the input value changes again before the wait
+ * time expires, the timer resets and starts waiting again.
+ *
+ * This is useful for deriving debounced values from props or state that change frequently,
+ * like search queries or form inputs, where you want to limit how often downstream effects
+ * or calculations occur.
+ *
+ * The hook returns the current debounced value and the underlying debouncer instance.
+ * The debouncer instance can be used to access additional functionality like cancellation
+ * and execution counts.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying debouncer instance.
+ * The `selector` parameter allows you to specify which debouncer 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 debouncer state properties:
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+ * - `executionCount`: Number of function executions that have been completed
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [searchQuery, setSearchQuery] = useState('');
+ * const [debouncedQuery, debouncer] = useDebouncedValue(searchQuery, {
+ *   wait: 500 // Wait 500ms after last change
+ * });
+ *
+ * // Opt-in to re-render when pending state changes (optimized for loading indicators)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking executions)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when debouncing status changes (optimized for status display)
+ * const [debouncedQuery, debouncer] = useDebouncedValue(
+ *   searchQuery,
+ *   { wait: 500 },
+ *   (state) => ({
+ *     status: state.status,
+ *     canLeadingExecute: state.canLeadingExecute
+ *   })
+ * );
+ *
+ * // debouncedQuery will update 500ms after searchQuery stops changing
+ * useEffect(() => {
+ *   fetchSearchResults(debouncedQuery);
+ * }, [debouncedQuery]);
+ *
+ * // Handle input changes
+ * const handleChange = (e) => {
+ *   setSearchQuery(e.target.value);
+ * };
+ *
+ * // Access the selected debouncer state (will be empty object {} unless selector provided)
+ * const { isPending, executionCount } = debouncer.state;
+ * ```
+ */
+declare function useDebouncedValue<TValue, TSelected = DebouncerState<Dispatch<StateUpdater<TValue>>>>(value: TValue, options: DebouncerOptions<Dispatch<StateUpdater<TValue>>>, selector?: (state: DebouncerState<Dispatch<StateUpdater<TValue>>>) => TSelected): [TValue, PreactDebouncer<Dispatch<StateUpdater<TValue>>, TSelected>];
+//#endregion
+export { useDebouncedValue };
+//# sourceMappingURL=useDebouncedValue.d.ts.map

package/dist/debouncer/useDebouncedValue.js

@@ -0,0 +1,96 @@
+import { useDebouncedState } from "./useDebouncedState.js";
+import { useEffect } from "preact/hooks";
+
+//#region src/debouncer/useDebouncedValue.ts
+/**
+* A Preact hook that creates a debounced value that updates only after a specified delay.
+* Unlike useDebouncedState, this hook automatically tracks changes to the input value
+* and updates the debounced value accordingly.
+*
+* The debounced value will only update after the specified wait time has elapsed since
+* the last change to the input value. If the input value changes again before the wait
+* time expires, the timer resets and starts waiting again.
+*
+* This is useful for deriving debounced values from props or state that change frequently,
+* like search queries or form inputs, where you want to limit how often downstream effects
+* or calculations occur.
+*
+* The hook returns the current debounced value and the underlying debouncer instance.
+* The debouncer instance can be used to access additional functionality like cancellation
+* and execution counts.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management via the underlying debouncer instance.
+* The `selector` parameter allows you to specify which debouncer 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 debouncer state properties:
+* - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+* - `executionCount`: Number of function executions that have been completed
+* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [searchQuery, setSearchQuery] = useState('');
+* const [debouncedQuery, debouncer] = useDebouncedValue(searchQuery, {
+*   wait: 500 // Wait 500ms after last change
+* });
+*
+* // Opt-in to re-render when pending state changes (optimized for loading indicators)
+* const [debouncedQuery, debouncer] = useDebouncedValue(
+*   searchQuery,
+*   { wait: 500 },
+*   (state) => ({ isPending: state.isPending })
+* );
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking executions)
+* const [debouncedQuery, debouncer] = useDebouncedValue(
+*   searchQuery,
+*   { wait: 500 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when debouncing status changes (optimized for status display)
+* const [debouncedQuery, debouncer] = useDebouncedValue(
+*   searchQuery,
+*   { wait: 500 },
+*   (state) => ({
+*     status: state.status,
+*     canLeadingExecute: state.canLeadingExecute
+*   })
+* );
+*
+* // debouncedQuery will update 500ms after searchQuery stops changing
+* useEffect(() => {
+*   fetchSearchResults(debouncedQuery);
+* }, [debouncedQuery]);
+*
+* // Handle input changes
+* const handleChange = (e) => {
+*   setSearchQuery(e.target.value);
+* };
+*
+* // Access the selected debouncer state (will be empty object {} unless selector provided)
+* const { isPending, executionCount } = debouncer.state;
+* ```
+*/
+function useDebouncedValue(value, options, selector) {
+	const [debouncedValue, setDebouncedValue, debouncer] = useDebouncedState(value, options, selector);
+	useEffect(() => {
+		setDebouncedValue(value);
+	}, [value, setDebouncedValue]);
+	return [debouncedValue, debouncer];
+}
+
+//#endregion
+export { useDebouncedValue };
+//# sourceMappingURL=useDebouncedValue.js.map

package/dist/debouncer/useDebouncedValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebouncedValue.js","names":[],"sources":["../../src/debouncer/useDebouncedValue.ts"],"sourcesContent":["import { useEffect } from 'preact/hooks'\nimport { useDebouncedState } from './useDebouncedState'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactDebouncer } from './useDebouncer'\nimport type {\n  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\n\n/**\n * A Preact hook that creates a debounced value that updates only after a specified delay.\n * Unlike useDebouncedState, this hook automatically tracks changes to the input value\n * and updates the debounced value accordingly.\n *\n * The debounced value will only update after the specified wait time has elapsed since\n * the last change to the input value. If the input value changes again before the wait\n * time expires, the timer resets and starts waiting again.\n *\n * This is useful for deriving debounced values from props or state that change frequently,\n * like search queries or form inputs, where you want to limit how often downstream effects\n * or calculations occur.\n *\n * The hook returns the current debounced value and the underlying debouncer instance.\n * The debouncer instance can be used to access additional functionality like cancellation\n * and execution counts.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying debouncer instance.\n * The `selector` parameter allows you to specify which debouncer state changes will trigger 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 debouncer state properties:\n * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [searchQuery, setSearchQuery] = useState('');\n * const [debouncedQuery, debouncer] = useDebouncedValue(searchQuery, {\n *   wait: 500 // Wait 500ms after last change\n * });\n *\n * // Opt-in to re-render when pending state changes (optimized for loading indicators)\n * const [debouncedQuery, debouncer] = useDebouncedValue(\n *   searchQuery,\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking executions)\n * const [debouncedQuery, debouncer] = useDebouncedValue(\n *   searchQuery,\n *   { wait: 500 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when debouncing status changes (optimized for status display)\n * const [debouncedQuery, debouncer] = useDebouncedValue(\n *   searchQuery,\n *   { wait: 500 },\n *   (state) => ({\n *     status: state.status,\n *     canLeadingExecute: state.canLeadingExecute\n *   })\n * );\n *\n * // debouncedQuery will update 500ms after searchQuery stops changing\n * useEffect(() => {\n *   fetchSearchResults(debouncedQuery);\n * }, [debouncedQuery]);\n *\n * // Handle input changes\n * const handleChange = (e) => {\n *   setSearchQuery(e.target.value);\n * };\n *\n * // Access the selected debouncer state (will be empty object {} unless selector provided)\n * const { isPending, executionCount } = debouncer.state;\n * ```\n */\nexport function useDebouncedValue<\n  TValue,\n  TSelected = DebouncerState<Dispatch<StateUpdater<TValue>>>,\n>(\n  value: TValue,\n  options: DebouncerOptions<Dispatch<StateUpdater<TValue>>>,\n  selector?: (\n    state: DebouncerState<Dispatch<StateUpdater<TValue>>>,\n  ) => TSelected,\n): [TValue, PreactDebouncer<Dispatch<StateUpdater<TValue>>, TSelected>] {\n  const [debouncedValue, setDebouncedValue, debouncer] = useDebouncedState(\n    value,\n    options,\n    selector,\n  )\n\n  useEffect(() => {\n    ;(setDebouncedValue as (value: TValue) => void)(value)\n  }, [value, setDebouncedValue])\n\n  return [debouncedValue, debouncer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0FA,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"}

package/dist/debouncer/useDebouncer.cjs

@@ -0,0 +1,104 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let __tanstack_preact_store = require("@tanstack/preact-store");
+let __tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
+
+//#region src/debouncer/useDebouncer.ts
+/**
+* A Preact hook that creates and manages a Debouncer instance.
+*
+* This is a lower-level hook that provides direct access to the Debouncer's functionality without
+* any built-in state management. This allows you to integrate it with any state management solution
+* you prefer (useState, Redux, Zustand, etc.).
+*
+* This hook provides debouncing functionality to limit how often a function can be called,
+* waiting for a specified delay before executing the latest call. This is useful for handling
+* frequent events like window resizing, scroll events, or real-time search inputs.
+*
+* The debouncer will only execute the function after the specified wait time has elapsed
+* since the last call. If the function is called again before the wait time expires, the
+* timer resets and starts waiting again.
+*
+* ## 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:
+* - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+* - `executionCount`: Number of function executions that have been completed
+* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const searchDebouncer = useDebouncer(
+*   (query: string) => fetchSearchResults(query),
+*   { wait: 500 }
+* );
+*
+* // Opt-in to re-render when isPending changes (optimized for loading states)
+* const searchDebouncer = useDebouncer(
+*   (query: string) => fetchSearchResults(query),
+*   { wait: 500 },
+*   (state) => ({ isPending: state.isPending })
+* );
+*
+* // Opt-in to re-render when executionCount changes (optimized for tracking execution)
+* const searchDebouncer = useDebouncer(
+*   (query: string) => fetchSearchResults(query),
+*   { wait: 500 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Multiple state properties - re-render when any of these change
+* const searchDebouncer = useDebouncer(
+*   (query: string) => fetchSearchResults(query),
+*   { wait: 500 },
+*   (state) => ({
+*     isPending: state.isPending,
+*     executionCount: state.executionCount,
+*     status: state.status
+*   })
+* );
+*
+* // In an event handler
+* const handleChange = (e) => {
+*   searchDebouncer.maybeExecute(e.target.value);
+* };
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { isPending } = searchDebouncer.state;
+* ```
+*/
+function useDebouncer(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().debouncer,
+		...options
+	};
+	const [debouncer] = (0, preact_hooks.useState)(() => new __tanstack_pacer_debouncer.Debouncer(fn, mergedOptions));
+	debouncer.fn = fn;
+	debouncer.setOptions(mergedOptions);
+	(0, preact_hooks.useEffect)(() => {
+		return () => {
+			debouncer.cancel();
+		};
+	}, [debouncer]);
+	const state = (0, __tanstack_preact_store.useStore)(debouncer.store, selector);
+	return (0, preact_hooks.useMemo)(() => ({
+		...debouncer,
+		state
+	}), [debouncer, state]);
+}
+
+//#endregion
+exports.useDebouncer = useDebouncer;
+//# sourceMappingURL=useDebouncer.cjs.map

package/dist/debouncer/useDebouncer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebouncer.cjs","names":["useDefaultPacerOptions","Debouncer"],"sources":["../../src/debouncer/useDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\nexport interface PreactDebouncer<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated and re-rendered when the debouncer state changes\n   *\n   * Use this instead of `debouncer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `debouncer.state` instead of `debouncer.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<DebouncerState<TFn>>>\n}\n\n/**\n * A Preact hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.).\n *\n * This hook provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 }\n * );\n *\n * // Opt-in to re-render when isPending changes (optimized for loading states)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     status: state.status\n *   })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n *   searchDebouncer.maybeExecute(e.target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = searchDebouncer.state;\n * ```\n */\nexport function useDebouncer<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: DebouncerOptions<TFn>,\n  selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().debouncer,\n    ...options,\n  } as DebouncerOptions<TFn>\n\n  const [debouncer] = useState(() => new Debouncer(fn, mergedOptions))\n\n  debouncer.fn = fn\n  debouncer.setOptions(mergedOptions)\n\n  useEffect(() => {\n    return () => {\n      debouncer.cancel()\n    }\n  }, [debouncer])\n\n  const state = useStore(debouncer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...debouncer,\n        state,\n      }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n    [debouncer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwGA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,8CAA4B,IAAIC,qCAAU,IAAI,cAAc,CAAC;AAEpE,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;AAEnC,mCAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;CAEf,MAAM,8CAAiB,UAAU,OAAO,SAAS;AAEjD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}

package/dist/debouncer/useDebouncer.d.cts

@@ -0,0 +1,98 @@
+import { Store } from "@tanstack/preact-store";
+import { AnyFunction } from "@tanstack/pacer/types";
+import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
+
+//#region src/debouncer/useDebouncer.d.ts
+interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the debouncer state changes
+   *
+   * Use this instead of `debouncer.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `debouncer.state` instead of `debouncer.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<DebouncerState<TFn>>>;
+}
+/**
+ * A Preact hook that creates and manages a Debouncer instance.
+ *
+ * This is a lower-level hook that provides direct access to the Debouncer's functionality without
+ * any built-in state management. This allows you to integrate it with any state management solution
+ * you prefer (useState, Redux, Zustand, etc.).
+ *
+ * This hook provides debouncing functionality to limit how often a function can be called,
+ * waiting for a specified delay before executing the latest call. This is useful for handling
+ * frequent events like window resizing, scroll events, or real-time search inputs.
+ *
+ * The debouncer will only execute the function after the specified wait time has elapsed
+ * since the last call. If the function is called again before the wait time expires, the
+ * timer resets and starts waiting again.
+ *
+ * ## 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:
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+ * - `executionCount`: Number of function executions that have been completed
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 }
+ * );
+ *
+ * // Opt-in to re-render when isPending changes (optimized for loading states)
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
+ * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Multiple state properties - re-render when any of these change
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({
+ *     isPending: state.isPending,
+ *     executionCount: state.executionCount,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // In an event handler
+ * const handleChange = (e) => {
+ *   searchDebouncer.maybeExecute(e.target.value);
+ * };
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isPending } = searchDebouncer.state;
+ * ```
+ */
+declare function useDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: DebouncerOptions<TFn>, selector?: (state: DebouncerState<TFn>) => TSelected): PreactDebouncer<TFn, TSelected>;
+//#endregion
+export { PreactDebouncer, useDebouncer };
+//# sourceMappingURL=useDebouncer.d.cts.map

package/dist/debouncer/useDebouncer.d.ts

@@ -0,0 +1,98 @@
+import { Store } from "@tanstack/preact-store";
+import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/debouncer/useDebouncer.d.ts
+interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the debouncer state changes
+   *
+   * Use this instead of `debouncer.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `debouncer.state` instead of `debouncer.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<DebouncerState<TFn>>>;
+}
+/**
+ * A Preact hook that creates and manages a Debouncer instance.
+ *
+ * This is a lower-level hook that provides direct access to the Debouncer's functionality without
+ * any built-in state management. This allows you to integrate it with any state management solution
+ * you prefer (useState, Redux, Zustand, etc.).
+ *
+ * This hook provides debouncing functionality to limit how often a function can be called,
+ * waiting for a specified delay before executing the latest call. This is useful for handling
+ * frequent events like window resizing, scroll events, or real-time search inputs.
+ *
+ * The debouncer will only execute the function after the specified wait time has elapsed
+ * since the last call. If the function is called again before the wait time expires, the
+ * timer resets and starts waiting again.
+ *
+ * ## 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:
+ * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
+ * - `executionCount`: Number of function executions that have been completed
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 }
+ * );
+ *
+ * // Opt-in to re-render when isPending changes (optimized for loading states)
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
+ * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Multiple state properties - re-render when any of these change
+ * const searchDebouncer = useDebouncer(
+ *   (query: string) => fetchSearchResults(query),
+ *   { wait: 500 },
+ *   (state) => ({
+ *     isPending: state.isPending,
+ *     executionCount: state.executionCount,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // In an event handler
+ * const handleChange = (e) => {
+ *   searchDebouncer.maybeExecute(e.target.value);
+ * };
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isPending } = searchDebouncer.state;
+ * ```
+ */
+declare function useDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: DebouncerOptions<TFn>, selector?: (state: DebouncerState<TFn>) => TSelected): PreactDebouncer<TFn, TSelected>;
+//#endregion
+export { PreactDebouncer, useDebouncer };
+//# sourceMappingURL=useDebouncer.d.ts.map