@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/batcher/useBatcher.d.cts

@@ -0,0 +1,155 @@
+import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
+import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
+
+//#region src/batcher/useBatcher.d.ts
+interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the batcher state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Batch Size: {size}</div>
+   *   )}
+   * </batcher.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: BatcherState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
+  /**
+   * Reactive state that will be updated and re-rendered when the batcher state changes
+   *
+   * Use this instead of `batcher.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>;
+}
+/**
+ * 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;
+ * ```
+ */
+declare function useBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): PreactBatcher<TValue, TSelected>;
+//#endregion
+export { PreactBatcher, useBatcher };
+//# sourceMappingURL=useBatcher.d.cts.map

package/dist/batcher/useBatcher.d.ts

@@ -0,0 +1,155 @@
+import { ComponentChildren } from "preact";
+import { Store } from "@tanstack/preact-store";
+import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
+
+//#region src/batcher/useBatcher.d.ts
+interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the batcher state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Batch Size: {size}</div>
+   *   )}
+   * </batcher.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: BatcherState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
+  /**
+   * Reactive state that will be updated and re-rendered when the batcher state changes
+   *
+   * Use this instead of `batcher.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>;
+}
+/**
+ * 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;
+ * ```
+ */
+declare function useBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): PreactBatcher<TValue, TSelected>;
+//#endregion
+export { PreactBatcher, useBatcher };
+//# sourceMappingURL=useBatcher.d.ts.map

package/dist/batcher/useBatcher.js

@@ -0,0 +1,146 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { Batcher } from "@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 = {
+		...useDefaultPacerOptions().batcher,
+		...options
+	};
+	const [batcher] = useState(() => {
+		const batcherInstance = new Batcher(fn, mergedOptions);
+		batcherInstance.Subscribe = function Subscribe(props) {
+			const selected = 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 = useStore(batcher.store, selector);
+	return useMemo(() => ({
+		...batcher,
+		state
+	}), [batcher, state]);
+}
+
+//#endregion
+export { useBatcher };
+//# sourceMappingURL=useBatcher.js.map

package/dist/batcher/useBatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBatcher.js","names":[],"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,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,WAAW,eAAe;EAC/B,MAAM,kBAAkB,IAAI,QAC1B,IACA,cACD;AAED,kBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,WAAW,SAAS,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,QAAQ,SAAS,QAAQ,OAAO,SAAS;AAE/C,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}

package/dist/debouncer/index.cjs

@@ -0,0 +1,16 @@
+const require_useDebouncer = require('./useDebouncer.cjs');
+const require_useDebouncedCallback = require('./useDebouncedCallback.cjs');
+const require_useDebouncedState = require('./useDebouncedState.cjs');
+const require_useDebouncedValue = require('./useDebouncedValue.cjs');
+
+exports.useDebouncedCallback = require_useDebouncedCallback.useDebouncedCallback;
+exports.useDebouncedState = require_useDebouncedState.useDebouncedState;
+exports.useDebouncedValue = require_useDebouncedValue.useDebouncedValue;
+exports.useDebouncer = require_useDebouncer.useDebouncer;
+var _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
+Object.keys(_tanstack_pacer_debouncer).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_pacer_debouncer[k]; }
+  });
+});

package/dist/debouncer/index.d.cts

@@ -0,0 +1,6 @@
+import { useDebouncedCallback } from "./useDebouncedCallback.cjs";
+import { PreactDebouncer, useDebouncer } from "./useDebouncer.cjs";
+import { useDebouncedState } from "./useDebouncedState.cjs";
+import { useDebouncedValue } from "./useDebouncedValue.cjs";
+export * from "@tanstack/pacer/debouncer";
+export { PreactDebouncer, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };

package/dist/debouncer/index.d.ts

@@ -0,0 +1,6 @@
+import { useDebouncedCallback } from "./useDebouncedCallback.js";
+import { PreactDebouncer, useDebouncer } from "./useDebouncer.js";
+import { useDebouncedState } from "./useDebouncedState.js";
+import { useDebouncedValue } from "./useDebouncedValue.js";
+export * from "@tanstack/pacer/debouncer";
+export { PreactDebouncer, useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };

package/dist/debouncer/index.js

@@ -0,0 +1,8 @@
+import { useDebouncer } from "./useDebouncer.js";
+import { useDebouncedCallback } from "./useDebouncedCallback.js";
+import { useDebouncedState } from "./useDebouncedState.js";
+import { useDebouncedValue } from "./useDebouncedValue.js";
+
+export * from "@tanstack/pacer/debouncer"
+
+export { useDebouncedCallback, useDebouncedState, useDebouncedValue, useDebouncer };

package/dist/debouncer/useDebouncedCallback.cjs

@@ -0,0 +1,48 @@
+const require_useDebouncer = require('./useDebouncer.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/debouncer/useDebouncedCallback.ts
+/**
+* A Preact hook that creates a debounced version of a callback function.
+* This hook is essentially a wrapper around the basic `debounce` function
+* that is exported from `@tanstack/pacer`,
+* but optimized for Preact with reactive options and a stable function reference.
+*
+* The debounced 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.
+*
+* This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
+* debouncing needs. However, it does not expose the underlying Debouncer instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution counts
+* - Custom useCallback dependencies
+*
+* Consider using the `useDebouncer` hook instead.
+*
+* @example
+* ```tsx
+* // Debounce a search handler
+* const handleSearch = useDebouncedCallback((query: string) => {
+*   fetchSearchResults(query);
+* }, {
+*   wait: 500 // Wait 500ms between executions
+* });
+*
+* // Use in an input
+* <input
+*   type="search"
+*   onChange={(e) => handleSearch(e.target.value)}
+* />
+* ```
+*/
+function useDebouncedCallback(fn, options) {
+	const debouncedFn = require_useDebouncer.useDebouncer(fn, options).maybeExecute;
+	return (0, preact_hooks.useCallback)((...args) => debouncedFn(...args), [debouncedFn]);
+}
+
+//#endregion
+exports.useDebouncedCallback = useDebouncedCallback;
+//# sourceMappingURL=useDebouncedCallback.cjs.map

package/dist/debouncer/useDebouncedCallback.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebouncedCallback.cjs","names":["useDebouncer"],"sources":["../../src/debouncer/useDebouncedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useDebouncer } from './useDebouncer'\nimport type { DebouncerOptions } from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a debounced version of a callback function.\n * This hook is essentially a wrapper around the basic `debounce` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * The debounced 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.\n *\n * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic\n * debouncing needs. However, it does not expose the underlying Debouncer instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useDebouncer` hook instead.\n *\n * @example\n * ```tsx\n * // Debounce a search handler\n * const handleSearch = useDebouncedCallback((query: string) => {\n *   fetchSearchResults(query);\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 useDebouncedCallback<TFn extends AnyFunction>(\n  fn: TFn,\n  options: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const debouncedFn = useDebouncer(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) => debouncedFn(...args),\n    [debouncedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,qBACd,IACA,SACoC;CACpC,MAAM,cAAcA,kCAAa,IAAI,QAAQ,CAAC;AAC9C,uCACG,GAAG,SAA0B,YAAY,GAAG,KAAK,EAClD,CAAC,YAAY,CACd"}

package/dist/debouncer/useDebouncedCallback.d.cts

@@ -0,0 +1,45 @@
+import { AnyFunction } from "@tanstack/pacer/types";
+import { DebouncerOptions } from "@tanstack/pacer/debouncer";
+
+//#region src/debouncer/useDebouncedCallback.d.ts
+
+/**
+ * A Preact hook that creates a debounced version of a callback function.
+ * This hook is essentially a wrapper around the basic `debounce` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The debounced 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.
+ *
+ * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
+ * debouncing needs. However, it does not expose the underlying Debouncer instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useDebouncer` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Debounce a search handler
+ * const handleSearch = useDebouncedCallback((query: string) => {
+ *   fetchSearchResults(query);
+ * }, {
+ *   wait: 500 // Wait 500ms between executions
+ * });
+ *
+ * // Use in an input
+ * <input
+ *   type="search"
+ *   onChange={(e) => handleSearch(e.target.value)}
+ * />
+ * ```
+ */
+declare function useDebouncedCallback<TFn extends AnyFunction>(fn: TFn, options: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useDebouncedCallback };
+//# sourceMappingURL=useDebouncedCallback.d.cts.map

package/dist/debouncer/useDebouncedCallback.d.ts

@@ -0,0 +1,45 @@
+import { DebouncerOptions } from "@tanstack/pacer/debouncer";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/debouncer/useDebouncedCallback.d.ts
+
+/**
+ * A Preact hook that creates a debounced version of a callback function.
+ * This hook is essentially a wrapper around the basic `debounce` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * The debounced 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.
+ *
+ * This hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
+ * debouncing needs. However, it does not expose the underlying Debouncer instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useDebouncer` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Debounce a search handler
+ * const handleSearch = useDebouncedCallback((query: string) => {
+ *   fetchSearchResults(query);
+ * }, {
+ *   wait: 500 // Wait 500ms between executions
+ * });
+ *
+ * // Use in an input
+ * <input
+ *   type="search"
+ *   onChange={(e) => handleSearch(e.target.value)}
+ * />
+ * ```
+ */
+declare function useDebouncedCallback<TFn extends AnyFunction>(fn: TFn, options: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { useDebouncedCallback };
+//# sourceMappingURL=useDebouncedCallback.d.ts.map