@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/async-debouncer/useAsyncDebouncedCallback.d.cts

@@ -0,0 +1,47 @@
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
+
+//#region src/async-debouncer/useAsyncDebouncedCallback.d.ts
+
+/**
+ * A Preact hook that creates a debounced version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
+ * providing a stable, debounced async function reference for use in Preact components.
+ *
+ * The debounced async function will only execute after the specified wait time has elapsed
+ * since its last invocation. If called again before the wait time expires, the timer
+ * resets and starts waiting again. The returned function always returns a promise
+ * that resolves or rejects with the result of the original async function.
+ *
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution/error state
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncDebouncer` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Debounce an async search handler
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
+ *   const results = await fetchSearchResults(query);
+ *   return results;
+ * }, {
+ *   wait: 500 // Wait 500ms between executions
+ * });
+ *
+ * // Use in an input
+ * <input
+ *   type="search"
+ *   onChange={e => handleSearch(e.target.value)}
+ * />
+ * ```
+ */
+declare function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncDebouncedCallback };
+//# sourceMappingURL=useAsyncDebouncedCallback.d.cts.map

package/dist/async-debouncer/useAsyncDebouncedCallback.d.ts

@@ -0,0 +1,47 @@
+import { AsyncDebouncerOptions } from "@tanstack/pacer/async-debouncer";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-debouncer/useAsyncDebouncedCallback.d.ts
+
+/**
+ * A Preact hook that creates a debounced version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
+ * providing a stable, debounced async function reference for use in Preact components.
+ *
+ * The debounced async function will only execute after the specified wait time has elapsed
+ * since its last invocation. If called again before the wait time expires, the timer
+ * resets and starts waiting again. The returned function always returns a promise
+ * that resolves or rejects with the result of the original async function.
+ *
+ * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
+ * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution/error state
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncDebouncer` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Debounce an async search handler
+ * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
+ *   const results = await fetchSearchResults(query);
+ *   return results;
+ * }, {
+ *   wait: 500 // Wait 500ms between executions
+ * });
+ *
+ * // Use in an input
+ * <input
+ *   type="search"
+ *   onChange={e => handleSearch(e.target.value)}
+ * />
+ * ```
+ */
+declare function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncDebouncerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncDebouncedCallback };
+//# sourceMappingURL=useAsyncDebouncedCallback.d.ts.map

package/dist/async-debouncer/useAsyncDebouncedCallback.js

@@ -0,0 +1,50 @@
+import { useAsyncDebouncer } from "./useAsyncDebouncer.js";
+import { useCallback } from "preact/hooks";
+
+//#region src/async-debouncer/useAsyncDebouncedCallback.ts
+/**
+* A Preact hook that creates a debounced version of an async callback function.
+* This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
+* providing a stable, debounced async function reference for use in Preact components.
+*
+* The debounced async function will only execute after the specified wait time has elapsed
+* since its last invocation. If called again before the wait time expires, the timer
+* resets and starts waiting again. The returned function always returns a promise
+* that resolves or rejects with the result of the original async function.
+*
+* This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
+* async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution/error state
+* - Custom useCallback dependencies
+*
+* Consider using the `useAsyncDebouncer` hook instead.
+*
+*
+* @example
+* ```tsx
+* // Debounce an async search handler
+* const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
+*   const results = await fetchSearchResults(query);
+*   return results;
+* }, {
+*   wait: 500 // Wait 500ms between executions
+* });
+*
+* // Use in an input
+* <input
+*   type="search"
+*   onChange={e => handleSearch(e.target.value)}
+* />
+* ```
+*/
+function useAsyncDebouncedCallback(fn, options) {
+	const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute;
+	return useCallback((...args) => asyncDebouncedFn(...args), [asyncDebouncedFn]);
+}
+
+//#endregion
+export { useAsyncDebouncedCallback };
+//# sourceMappingURL=useAsyncDebouncedCallback.js.map

package/dist/async-debouncer/useAsyncDebouncedCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncDebouncedCallback.js","names":[],"sources":["../../src/async-debouncer/useAsyncDebouncedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncDebouncer } from './useAsyncDebouncer'\nimport type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a debounced version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,\n * providing a stable, debounced async function reference for use in Preact components.\n *\n * The debounced async function will only execute after the specified wait time has elapsed\n * since its last invocation. If called again before the wait time expires, the timer\n * resets and starts waiting again. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic\n * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncDebouncer` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Debounce an async search handler\n * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {\n *   const results = await fetchSearchResults(query);\n *   return results;\n * }, {\n *   wait: 500 // Wait 500ms between executions\n * });\n *\n * // Use in an input\n * <input\n *   type=\"search\"\n *   onChange={e => handleSearch(e.target.value)}\n * />\n * ```\n */\nexport function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncDebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncDebouncedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncDebouncedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmB,kBAAkB,IAAI,QAAQ,CAAC;AACxD,QAAO,aACJ,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}

package/dist/async-debouncer/useAsyncDebouncer.cjs

@@ -0,0 +1,149 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let __tanstack_preact_store = require("@tanstack/preact-store");
+let __tanstack_pacer_async_debouncer = require("@tanstack/pacer/async-debouncer");
+
+//#region src/async-debouncer/useAsyncDebouncer.ts
+/**
+* A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
+*
+* This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
+* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
+*
+* Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
+* Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
+* or input changes where you only want to execute the handler after the events have stopped occurring.
+*
+* Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
+* the function stops being called for the specified delay period.
+*
+* Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
+* making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+* instead of setting the result on a state variable from within the debounced function.
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and debouncer instance
+* - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+* - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+* - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+* - The error state can be checked using the underlying AsyncDebouncer instance
+*
+* ## 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
+* - `errorCount`: Number of function executions that have resulted in errors
+* - `isExecuting`: Whether the debounced function is currently executing asynchronously
+* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `lastResult`: The result from the most recent successful function execution
+* - `settleCount`: Number of function executions that have completed (success or error)
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
+* - `successCount`: Number of function executions that have completed successfully
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const searchDebouncer = useAsyncDebouncer(
+*   async (query: string) => {
+*     const results = await api.search(query);
+*     return results;
+*   },
+*   { wait: 500 }
+* );
+*
+* // Opt-in to re-render when execution state changes (optimized for loading indicators)
+* const searchDebouncer = useAsyncDebouncer(
+*   async (query: string) => {
+*     const results = await api.search(query);
+*     return results;
+*   },
+*   { wait: 500 },
+*   (state) => ({
+*     isExecuting: state.isExecuting,
+*     isPending: state.isPending
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const searchDebouncer = useAsyncDebouncer(
+*   async (query: string) => {
+*     const results = await api.search(query);
+*     return results;
+*   },
+*   { wait: 500 },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const searchDebouncer = useAsyncDebouncer(
+*   async (query: string) => {
+*     const results = await api.search(query);
+*     return results;
+*   },
+*   {
+*     wait: 500,
+*     onError: (error) => console.error('Search failed:', error)
+*   },
+*   (state) => ({
+*     errorCount: state.errorCount,
+*     status: state.status
+*   })
+* );
+*
+* // With state management
+* const [results, setResults] = useState([]);
+* const { maybeExecute, state } = useAsyncDebouncer(
+*   async (searchTerm) => {
+*     const data = await searchAPI(searchTerm);
+*     setResults(data);
+*   },
+*   {
+*     wait: 300,
+*     leading: true,   // Execute immediately on first call
+*     trailing: false, // Skip trailing edge updates
+*     onError: (error) => {
+*       console.error('API call failed:', error);
+*     }
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { isExecuting, lastResult } = state;
+* ```
+*/
+function useAsyncDebouncer(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().asyncDebouncer,
+		...options
+	};
+	const [asyncDebouncer] = (0, preact_hooks.useState)(() => new __tanstack_pacer_async_debouncer.AsyncDebouncer(fn, mergedOptions));
+	asyncDebouncer.fn = fn;
+	asyncDebouncer.setOptions(mergedOptions);
+	const state = (0, __tanstack_preact_store.useStore)(asyncDebouncer.store, selector);
+	(0, preact_hooks.useEffect)(() => {
+		return () => {
+			asyncDebouncer.cancel();
+		};
+	}, [asyncDebouncer]);
+	return (0, preact_hooks.useMemo)(() => ({
+		...asyncDebouncer,
+		state
+	}), [asyncDebouncer, state]);
+}
+
+//#endregion
+exports.useAsyncDebouncer = useAsyncDebouncer;
+//# sourceMappingURL=useAsyncDebouncer.cjs.map

package/dist/async-debouncer/useAsyncDebouncer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncDebouncer.cjs","names":["useDefaultPacerOptions","AsyncDebouncer"],"sources":["../../src/async-debouncer/useAsyncDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncDebouncerOptions,\n  AsyncDebouncerState,\n} from '@tanstack/pacer/async-debouncer'\n\nexport interface ReactAsyncDebouncer<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncDebouncer<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<AsyncDebouncerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the debounced function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and debouncer instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncDebouncer instance\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 * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the debounced function is currently executing asynchronously\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 * - `lastResult`: The result from the most recent successful function execution\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useAsyncDebouncer(\n *   async (query: string) => {\n *     const results = await api.search(query);\n *     return results;\n *   },\n *   { wait: 500 }\n * );\n *\n * // Opt-in to re-render when execution state changes (optimized for loading indicators)\n * const searchDebouncer = useAsyncDebouncer(\n *   async (query: string) => {\n *     const results = await api.search(query);\n *     return results;\n *   },\n *   { wait: 500 },\n *   (state) => ({\n *     isExecuting: state.isExecuting,\n *     isPending: state.isPending\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const searchDebouncer = useAsyncDebouncer(\n *   async (query: string) => {\n *     const results = await api.search(query);\n *     return results;\n *   },\n *   { wait: 500 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const searchDebouncer = useAsyncDebouncer(\n *   async (query: string) => {\n *     const results = await api.search(query);\n *     return results;\n *   },\n *   {\n *     wait: 500,\n *     onError: (error) => console.error('Search failed:', error)\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     status: state.status\n *   })\n * );\n *\n * // With state management\n * const [results, setResults] = useState([]);\n * const { maybeExecute, state } = useAsyncDebouncer(\n *   async (searchTerm) => {\n *     const data = await searchAPI(searchTerm);\n *     setResults(data);\n *   },\n *   {\n *     wait: 300,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false, // Skip trailing edge updates\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(\n  fn: TFn,\n  options: AsyncDebouncerOptions<TFn>,\n  selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncDebouncer,\n    ...options,\n  } as AsyncDebouncerOptions<TFn>\n\n  const [asyncDebouncer] = useState(\n    () => new AsyncDebouncer<TFn>(fn, mergedOptions),\n  )\n\n  asyncDebouncer.fn = fn\n  asyncDebouncer.setOptions(mergedOptions)\n\n  const state = useStore(asyncDebouncer.store, selector)\n\n  useEffect(() => {\n    return () => {\n      asyncDebouncer.cancel()\n    }\n  }, [asyncDebouncer])\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncDebouncer,\n        state,\n      }) as ReactAsyncDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncDebouncer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqJA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACgC;CACrC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,mDACC,IAAIC,gDAAoB,IAAI,cAAc,CACjD;AAED,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,8CAAiB,eAAe,OAAO,SAAS;AAEtD,mCAAgB;AACd,eAAa;AACX,kBAAe,QAAQ;;IAExB,CAAC,eAAe,CAAC;AAEpB,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}

package/dist/async-debouncer/useAsyncDebouncer.d.cts

@@ -0,0 +1,143 @@
+import { Store } from "@tanstack/preact-store";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
+
+//#region src/async-debouncer/useAsyncDebouncer.d.ts
+interface ReactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<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<AsyncDebouncerState<TFn>>>;
+}
+/**
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
+ *
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
+ *
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
+ *
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
+ * the function stops being called for the specified delay period.
+ *
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the debounced function.
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncDebouncer instance
+ *
+ * ## 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
+ * - `errorCount`: Number of function executions that have resulted in errors
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastResult`: The result from the most recent successful function execution
+ * - `settleCount`: Number of function executions that have completed (success or error)
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
+ * - `successCount`: Number of function executions that have completed successfully
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 }
+ * );
+ *
+ * // Opt-in to re-render when execution state changes (optimized for loading indicators)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 },
+ *   (state) => ({
+ *     isExecuting: state.isExecuting,
+ *     isPending: state.isPending
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when error state changes (optimized for error handling)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   {
+ *     wait: 500,
+ *     onError: (error) => console.error('Search failed:', error)
+ *   },
+ *   (state) => ({
+ *     errorCount: state.errorCount,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // With state management
+ * const [results, setResults] = useState([]);
+ * const { maybeExecute, state } = useAsyncDebouncer(
+ *   async (searchTerm) => {
+ *     const data = await searchAPI(searchTerm);
+ *     setResults(data);
+ *   },
+ *   {
+ *     wait: 300,
+ *     leading: true,   // Execute immediately on first call
+ *     trailing: false, // Skip trailing edge updates
+ *     onError: (error) => {
+ *       console.error('API call failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isExecuting, lastResult } = state;
+ * ```
+ */
+declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): ReactAsyncDebouncer<TFn, TSelected>;
+//#endregion
+export { ReactAsyncDebouncer, useAsyncDebouncer };
+//# sourceMappingURL=useAsyncDebouncer.d.cts.map

package/dist/async-debouncer/useAsyncDebouncer.d.ts

@@ -0,0 +1,143 @@
+import { Store } from "@tanstack/preact-store";
+import { AsyncDebouncer, AsyncDebouncerOptions, AsyncDebouncerState } from "@tanstack/pacer/async-debouncer";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-debouncer/useAsyncDebouncer.d.ts
+interface ReactAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncDebouncer<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<AsyncDebouncerState<TFn>>>;
+}
+/**
+ * A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
+ *
+ * This hook is designed to be flexible and state-management agnostic - it simply returns a debouncer instance that
+ * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
+ *
+ * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
+ *
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
+ * the function stops being called for the specified delay period.
+ *
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the debounced function.
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and debouncer instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncDebouncer instance
+ *
+ * ## 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
+ * - `errorCount`: Number of function executions that have resulted in errors
+ * - `isExecuting`: Whether the debounced function is currently executing asynchronously
+ * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastResult`: The result from the most recent successful function execution
+ * - `settleCount`: Number of function executions that have completed (success or error)
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
+ * - `successCount`: Number of function executions that have completed successfully
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 }
+ * );
+ *
+ * // Opt-in to re-render when execution state changes (optimized for loading indicators)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 },
+ *   (state) => ({
+ *     isExecuting: state.isExecuting,
+ *     isPending: state.isPending
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   { wait: 500 },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when error state changes (optimized for error handling)
+ * const searchDebouncer = useAsyncDebouncer(
+ *   async (query: string) => {
+ *     const results = await api.search(query);
+ *     return results;
+ *   },
+ *   {
+ *     wait: 500,
+ *     onError: (error) => console.error('Search failed:', error)
+ *   },
+ *   (state) => ({
+ *     errorCount: state.errorCount,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // With state management
+ * const [results, setResults] = useState([]);
+ * const { maybeExecute, state } = useAsyncDebouncer(
+ *   async (searchTerm) => {
+ *     const data = await searchAPI(searchTerm);
+ *     setResults(data);
+ *   },
+ *   {
+ *     wait: 300,
+ *     leading: true,   // Execute immediately on first call
+ *     trailing: false, // Skip trailing edge updates
+ *     onError: (error) => {
+ *       console.error('API call failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isExecuting, lastResult } = state;
+ * ```
+ */
+declare function useAsyncDebouncer<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncDebouncerOptions<TFn>, selector?: (state: AsyncDebouncerState<TFn>) => TSelected): ReactAsyncDebouncer<TFn, TSelected>;
+//#endregion
+export { ReactAsyncDebouncer, useAsyncDebouncer };
+//# sourceMappingURL=useAsyncDebouncer.d.ts.map