@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/async-throttler/useAsyncThrottler.js

@@ -0,0 +1,182 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useEffect, useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { AsyncThrottler } from "@tanstack/pacer/async-throttler";
+
+//#region src/async-throttler/useAsyncThrottler.ts
+/**
+* A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async 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).
+*
+* Async throttling ensures an async 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 API calls,
+* database operations, or other async tasks.
+*
+* Unlike the non-async Throttler, this async version supports returning values from the throttled 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 throttled function.
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler instance
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
+*
+* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+* in child components.
+*
+* **2. Using the `selector` parameter (For hook-level subscriptions)**
+*
+* The `selector` parameter allows you to specify which state changes will trigger a re-render
+* at the hook level, 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 or using the `Subscribe` HOC. This prevents unnecessary
+* re-renders and gives you full control over when your component updates.
+*
+* Available state properties:
+* - `errorCount`: Number of function executions that have resulted in errors
+* - `isExecuting`: Whether the throttled function is currently executing asynchronously
+* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
+* - `lastResult`: The result from the most recent successful function execution
+* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
+* - `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 asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data; // Return value is preserved
+*   },
+*   { wait: 1000 }
+* );
+*
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
+*   {({ isPending }) => (
+*     <div>{isPending ? 'Processing...' : 'Ready'}</div>
+*   )}
+* </asyncThrottler.Subscribe>
+*
+* // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     isExecuting: state.isExecuting,
+*     isPending: state.isPending,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount,
+*     settleCount: state.settleCount
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   {
+*     wait: 1000,
+*     onError: (error) => console.error('API call failed:', error)
+*   },
+*   (state) => ({
+*     errorCount: state.errorCount,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when timing information changes (optimized for timing displays)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With state management and return value
+* const [data, setData] = useState(null);
+* const { maybeExecute, state } = useAsyncThrottler(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     setData(result);
+*     return result; // Return value can be used by the caller
+*   },
+*   {
+*     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 { isExecuting, lastResult } = state;
+* ```
+*/
+function useAsyncThrottler(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().asyncThrottler,
+		...options
+	};
+	const [asyncThrottler] = useState(() => {
+		const throttlerInstance = new AsyncThrottler(fn, mergedOptions);
+		throttlerInstance.Subscribe = function Subscribe(props) {
+			const selected = useStore(throttlerInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return throttlerInstance;
+	});
+	asyncThrottler.fn = fn;
+	asyncThrottler.setOptions(mergedOptions);
+	const state = useStore(asyncThrottler.store, selector);
+	useEffect(() => {
+		return () => asyncThrottler.cancel();
+	}, [asyncThrottler]);
+	return useMemo(() => ({
+		...asyncThrottler,
+		state
+	}), [asyncThrottler, state]);
+}
+
+//#endregion
+export { useAsyncThrottler };
+//# sourceMappingURL=useAsyncThrottler.js.map

package/dist/async-throttler/useAsyncThrottler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncThrottler.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\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  AsyncThrottlerOptions,\n  AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the throttler state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {({ isPending }) => (\n   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncThrottlerState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async 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).\n *\n * Async throttling ensures an async 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 expensive API calls,\n * database operations, or other async tasks.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled 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 throttled function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the throttled function is currently executing asynchronously\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `lastResult`: The result from the most recent successful function execution\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\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 asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { wait: 1000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncThrottler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {({ isPending }) => (\n *     <div>{isPending ? 'Processing...' : 'Ready'}</div>\n *   )}\n * </asyncThrottler.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     isExecuting: state.isExecuting,\n *     isPending: state.isPending,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount,\n *     settleCount: state.settleCount\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     wait: 1000,\n *     onError: (error) => console.error('API call failed:', error)\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\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 { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncThrottler,\n    ...options,\n  } as AsyncThrottlerOptions<TFn>\n\n  const [asyncThrottler] = useState(() => {\n    const throttlerInstance = new AsyncThrottler<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncThrottler<TFn, TSelected>\n\n    throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncThrottlerState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(throttlerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return throttlerInstance\n  })\n\n  asyncThrottler.fn = fn\n  asyncThrottler.setOptions(mergedOptions)\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  useEffect(() => {\n    return () => asyncThrottler.cancel()\n  }, [asyncThrottler])\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncThrottler,\n        state,\n      }) as PreactAsyncThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncThrottler, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmMA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,kBAAkB,eAAe;EACtC,MAAM,oBAAoB,IAAI,eAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,iBAAgB;AACd,eAAa,eAAe,QAAQ;IACnC,CAAC,eAAe,CAAC;AAEpB,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}

package/dist/batcher/index.cjs

@@ -0,0 +1,12 @@
+const require_useBatcher = require('./useBatcher.cjs');
+const require_useBatchedCallback = require('./useBatchedCallback.cjs');
+
+exports.useBatchedCallback = require_useBatchedCallback.useBatchedCallback;
+exports.useBatcher = require_useBatcher.useBatcher;
+var _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
+Object.keys(_tanstack_pacer_batcher).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_pacer_batcher[k]; }
+  });
+});

package/dist/batcher/index.d.cts

@@ -0,0 +1,4 @@
+import { PreactBatcher, useBatcher } from "./useBatcher.cjs";
+import { useBatchedCallback } from "./useBatchedCallback.cjs";
+export * from "@tanstack/pacer/batcher";
+export { PreactBatcher, useBatchedCallback, useBatcher };

package/dist/batcher/index.d.ts

@@ -0,0 +1,4 @@
+import { PreactBatcher, useBatcher } from "./useBatcher.js";
+import { useBatchedCallback } from "./useBatchedCallback.js";
+export * from "@tanstack/pacer/batcher";
+export { PreactBatcher, useBatchedCallback, useBatcher };

package/dist/batcher/index.js

@@ -0,0 +1,6 @@
+import { useBatcher } from "./useBatcher.js";
+import { useBatchedCallback } from "./useBatchedCallback.js";
+
+export * from "@tanstack/pacer/batcher"
+
+export { useBatchedCallback, useBatcher };

package/dist/batcher/useBatchedCallback.cjs

@@ -0,0 +1,47 @@
+const require_useBatcher = require('./useBatcher.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/batcher/useBatchedCallback.ts
+/**
+* A Preact hook that creates a batched version of a callback function.
+* This hook is essentially a wrapper around the basic `batch` function
+* that is exported from `@tanstack/pacer`,
+* but optimized for Preact with reactive options and a stable function reference.
+*
+* The batched function will collect individual calls into batches and execute them
+* when batch conditions are met (max size reached, wait time elapsed, or custom logic).
+*
+* This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
+* batching needs. However, it does not expose the underlying Batcher instance.
+*
+* For advanced usage requiring features like:
+* - Manual batch execution
+* - Access to batch state and metrics
+* - Custom useCallback dependencies
+*
+* Consider using the `useBatcher` hook instead.
+*
+* @example
+* ```tsx
+* // Batch analytics events
+* const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
+*   sendAnalytics(events);
+* }, {
+*   maxSize: 5,    // Process when 5 events collected
+*   wait: 2000     // Or after 2 seconds
+* });
+*
+* // Use in event handlers
+* <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
+*   Click me
+* </button>
+* ```
+*/
+function useBatchedCallback(fn, options) {
+	const batchedFn = require_useBatcher.useBatcher(fn, options).addItem;
+	return (0, preact_hooks.useCallback)((...args) => batchedFn(args[0]), [batchedFn]);
+}
+
+//#endregion
+exports.useBatchedCallback = useBatchedCallback;
+//# sourceMappingURL=useBatchedCallback.cjs.map

package/dist/batcher/useBatchedCallback.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBatchedCallback.cjs","names":["useBatcher"],"sources":["../../src/batcher/useBatchedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useBatcher } from './useBatcher'\nimport type { BatcherOptions } from '@tanstack/pacer/batcher'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a batched version of a callback function.\n * This hook is essentially a wrapper around the basic `batch` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The batched function will collect individual calls into batches and execute them\n * when batch conditions are met (max size reached, wait time elapsed, or custom logic).\n *\n * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic\n * batching needs. However, it does not expose the underlying Batcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual batch execution\n * - Access to batch state and metrics\n * - Custom useCallback dependencies\n *\n * Consider using the `useBatcher` hook instead.\n *\n * @example\n * ```tsx\n * // Batch analytics events\n * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {\n *   sendAnalytics(events);\n * }, {\n *   maxSize: 5,    // Process when 5 events collected\n *   wait: 2000     // Or after 2 seconds\n * });\n *\n * // Use in event handlers\n * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>\n *   Click me\n * </button>\n * ```\n */\nexport function useBatchedCallback<TFn extends AnyFunction>(\n  fn: (items: Array<Parameters<TFn>[0]>) => void,\n  options: BatcherOptions<Parameters<TFn>[0]>,\n): (...args: Parameters<TFn>) => void {\n  const batchedFn = useBatcher(fn, options).addItem\n  return useCallback(\n    (...args: Parameters<TFn>) => batchedFn(args[0]),\n    [batchedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,mBACd,IACA,SACoC;CACpC,MAAM,YAAYA,8BAAW,IAAI,QAAQ,CAAC;AAC1C,uCACG,GAAG,SAA0B,UAAU,KAAK,GAAG,EAChD,CAAC,UAAU,CACZ"}

package/dist/batcher/useBatchedCallback.d.cts

@@ -0,0 +1,44 @@
+import { AnyFunction } from "@tanstack/pacer/types";
+import { BatcherOptions } from "@tanstack/pacer/batcher";
+
+//#region src/batcher/useBatchedCallback.d.ts
+
+/**
+ * A Preact hook that creates a batched version of a callback function.
+ * This hook is essentially a wrapper around the basic `batch` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The batched function will collect individual calls into batches and execute them
+ * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
+ *
+ * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
+ * batching needs. However, it does not expose the underlying Batcher instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual batch execution
+ * - Access to batch state and metrics
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useBatcher` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Batch analytics events
+ * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
+ *   sendAnalytics(events);
+ * }, {
+ *   maxSize: 5,    // Process when 5 events collected
+ *   wait: 2000     // Or after 2 seconds
+ * });
+ *
+ * // Use in event handlers
+ * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
+ *   Click me
+ * </button>
+ * ```
+ */
+declare function useBatchedCallback<TFn extends AnyFunction>(fn: (items: Array<Parameters<TFn>[0]>) => void, options: BatcherOptions<Parameters<TFn>[0]>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useBatchedCallback };
+//# sourceMappingURL=useBatchedCallback.d.cts.map

package/dist/batcher/useBatchedCallback.d.ts

@@ -0,0 +1,44 @@
+import { BatcherOptions } from "@tanstack/pacer/batcher";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/batcher/useBatchedCallback.d.ts
+
+/**
+ * A Preact hook that creates a batched version of a callback function.
+ * This hook is essentially a wrapper around the basic `batch` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The batched function will collect individual calls into batches and execute them
+ * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
+ *
+ * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
+ * batching needs. However, it does not expose the underlying Batcher instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual batch execution
+ * - Access to batch state and metrics
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useBatcher` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Batch analytics events
+ * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
+ *   sendAnalytics(events);
+ * }, {
+ *   maxSize: 5,    // Process when 5 events collected
+ *   wait: 2000     // Or after 2 seconds
+ * });
+ *
+ * // Use in event handlers
+ * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
+ *   Click me
+ * </button>
+ * ```
+ */
+declare function useBatchedCallback<TFn extends AnyFunction>(fn: (items: Array<Parameters<TFn>[0]>) => void, options: BatcherOptions<Parameters<TFn>[0]>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useBatchedCallback };
+//# sourceMappingURL=useBatchedCallback.d.ts.map

package/dist/batcher/useBatchedCallback.js

@@ -0,0 +1,47 @@
+import { useBatcher } from "./useBatcher.js";
+import { useCallback } from "preact/hooks";
+
+//#region src/batcher/useBatchedCallback.ts
+/**
+* A Preact hook that creates a batched version of a callback function.
+* This hook is essentially a wrapper around the basic `batch` function
+* that is exported from `@tanstack/pacer`,
+* but optimized for Preact with reactive options and a stable function reference.
+*
+* The batched function will collect individual calls into batches and execute them
+* when batch conditions are met (max size reached, wait time elapsed, or custom logic).
+*
+* This hook provides a simpler API compared to `useBatcher`, making it ideal for basic
+* batching needs. However, it does not expose the underlying Batcher instance.
+*
+* For advanced usage requiring features like:
+* - Manual batch execution
+* - Access to batch state and metrics
+* - Custom useCallback dependencies
+*
+* Consider using the `useBatcher` hook instead.
+*
+* @example
+* ```tsx
+* // Batch analytics events
+* const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {
+*   sendAnalytics(events);
+* }, {
+*   maxSize: 5,    // Process when 5 events collected
+*   wait: 2000     // Or after 2 seconds
+* });
+*
+* // Use in event handlers
+* <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>
+*   Click me
+* </button>
+* ```
+*/
+function useBatchedCallback(fn, options) {
+	const batchedFn = useBatcher(fn, options).addItem;
+	return useCallback((...args) => batchedFn(args[0]), [batchedFn]);
+}
+
+//#endregion
+export { useBatchedCallback };
+//# sourceMappingURL=useBatchedCallback.js.map

package/dist/batcher/useBatchedCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBatchedCallback.js","names":[],"sources":["../../src/batcher/useBatchedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useBatcher } from './useBatcher'\nimport type { BatcherOptions } from '@tanstack/pacer/batcher'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a batched version of a callback function.\n * This hook is essentially a wrapper around the basic `batch` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The batched function will collect individual calls into batches and execute them\n * when batch conditions are met (max size reached, wait time elapsed, or custom logic).\n *\n * This hook provides a simpler API compared to `useBatcher`, making it ideal for basic\n * batching needs. However, it does not expose the underlying Batcher instance.\n *\n * For advanced usage requiring features like:\n * - Manual batch execution\n * - Access to batch state and metrics\n * - Custom useCallback dependencies\n *\n * Consider using the `useBatcher` hook instead.\n *\n * @example\n * ```tsx\n * // Batch analytics events\n * const trackEvents = useBatchedCallback((events: AnalyticsEvent[]) => {\n *   sendAnalytics(events);\n * }, {\n *   maxSize: 5,    // Process when 5 events collected\n *   wait: 2000     // Or after 2 seconds\n * });\n *\n * // Use in event handlers\n * <button onClick={() => trackEvents({ type: 'click', target: 'button' })}>\n *   Click me\n * </button>\n * ```\n */\nexport function useBatchedCallback<TFn extends AnyFunction>(\n  fn: (items: Array<Parameters<TFn>[0]>) => void,\n  options: BatcherOptions<Parameters<TFn>[0]>,\n): (...args: Parameters<TFn>) => void {\n  const batchedFn = useBatcher(fn, options).addItem\n  return useCallback(\n    (...args: Parameters<TFn>) => batchedFn(args[0]),\n    [batchedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,mBACd,IACA,SACoC;CACpC,MAAM,YAAY,WAAW,IAAI,QAAQ,CAAC;AAC1C,QAAO,aACJ,GAAG,SAA0B,UAAU,KAAK,GAAG,EAChD,CAAC,UAAU,CACZ"}

package/dist/batcher/useBatcher.cjs

@@ -0,0 +1,146 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
+
+//#region src/batcher/useBatcher.ts
+/**
+* A Preact hook that creates and manages a Batcher instance.
+*
+* This is a lower-level hook that provides direct access to the Batcher'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.) by utilizing the onItemsChange callback.
+*
+* The Batcher collects items and processes them in batches based on configurable conditions:
+* - Maximum batch size
+* - Time-based batching (process after X milliseconds)
+* - Custom batch processing logic via getShouldExecute
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
+*
+* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+* in child components.
+*
+* **2. Using the `selector` parameter (For hook-level subscriptions)**
+*
+* The `selector` parameter allows you to specify which state changes will trigger a re-render
+* at the hook level, 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 or using the `Subscribe` HOC. This prevents unnecessary
+* re-renders and gives you full control over when your component updates.
+*
+* Available state properties:
+* - `executionCount`: Number of batch executions that have been completed
+* - `isEmpty`: Whether the batcher has no items to process
+* - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
+* - `isRunning`: Whether the batcher is active and will process items automatically
+* - `items`: Array of items currently queued for batch processing
+* - `size`: Number of items currently in the batch queue
+* - `status`: Current processing status ('idle' | 'pending')
+* - `totalItemsProcessed`: Total number of items processed across all batches
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const batcher = useBatcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   { maxSize: 5, wait: 2000 }
+* );
+*
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Batch Size: {size}</div>
+*   )}
+* </batcher.Subscribe>
+*
+* // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
+* const batcher = useBatcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   { maxSize: 5, wait: 2000 },
+*   (state) => ({
+*     size: state.size,
+*     isEmpty: state.isEmpty
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for stats display)
+* const batcher = useBatcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   { maxSize: 5, wait: 2000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     totalItemsProcessed: state.totalItemsProcessed
+*   })
+* );
+*
+* // Opt-in to re-render when processing state changes (optimized for loading indicators)
+* const batcher = useBatcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   { maxSize: 5, wait: 2000 },
+*   (state) => ({
+*     isPending: state.isPending,
+*     isRunning: state.isRunning,
+*     status: state.status
+*   })
+* );
+*
+* // Example with custom state management and batching
+* const [items, setItems] = useState([]);
+*
+* const batcher = useBatcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   {
+*     maxSize: 5,
+*     wait: 2000,
+*     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
+*     getShouldExecute: (items) => items.length >= 3
+*   }
+* );
+*
+* // Add items to batch - they'll be processed when conditions are met
+* batcher.addItem(1);
+* batcher.addItem(2);
+* batcher.addItem(3); // Triggers batch processing
+*
+* // Control the batcher
+* batcher.stop();  // Pause batching
+* batcher.start(); // Resume batching
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { size, isPending } = batcher.state;
+* ```
+*/
+function useBatcher(fn, options = {}, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().batcher,
+		...options
+	};
+	const [batcher] = (0, preact_hooks.useState)(() => {
+		const batcherInstance = new _tanstack_pacer_batcher.Batcher(fn, mergedOptions);
+		batcherInstance.Subscribe = function Subscribe(props) {
+			const selected = (0, _tanstack_preact_store.useStore)(batcherInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return batcherInstance;
+	});
+	batcher.fn = fn;
+	batcher.setOptions(mergedOptions);
+	const state = (0, _tanstack_preact_store.useStore)(batcher.store, selector);
+	return (0, preact_hooks.useMemo)(() => ({
+		...batcher,
+		state
+	}), [batcher, state]);
+}
+
+//#endregion
+exports.useBatcher = useBatcher;
+//# sourceMappingURL=useBatcher.cjs.map

package/dist/batcher/useBatcher.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBatcher.cjs","names":["useDefaultPacerOptions","Batcher"],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the batcher state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Batch Size: {size}</div>\n   *   )}\n   * </batcher.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: BatcherState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher'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.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Batch Size: {size}</div>\n *   )}\n * </batcher.Subscribe>\n *\n * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     isRunning: state.isRunning,\n *     status: state.status\n *   })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n *     getShouldExecute: (items) => items.length >= 3\n *   }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop();  // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const [batcher] = useState(() => {\n    const batcherInstance = new Batcher<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactBatcher<TValue, TSelected>\n\n    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: BatcherState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(batcherInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return batcherInstance\n  })\n\n  batcher.fn = fn\n  batcher.setOptions(mergedOptions)\n\n  const state = useStore(batcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...batcher,\n        state,\n      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [batcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8JA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,4CAA0B;EAC/B,MAAM,kBAAkB,IAAIC,gCAC1B,IACA,cACD;AAED,kBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,gDAAoB,gBAAgB,OAAO,MAAM,SAAS;AAEhE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,6CAAiB,QAAQ,OAAO,SAAS;AAE/C,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}