@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/async-batcher/useAsyncBatcher.cjs

@@ -0,0 +1,189 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let _tanstack_pacer_async_batcher = require("@tanstack/pacer/async-batcher");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+
+//#region src/async-batcher/useAsyncBatcher.ts
+/**
+* A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
+*
+* This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
+* - Handles promises and returns results from batch executions
+* - Provides error handling with configurable error behavior
+* - Tracks success, error, and settle counts separately
+* - Has state tracking for when batches are executing
+* - Returns the result of the batch function execution
+*
+* Features:
+* - Configurable batch size and wait time
+* - Custom batch processing logic via getShouldExecute
+* - Event callbacks for monitoring batch operations
+* - Error handling for failed batch operations
+* - Automatic or manual batch processing
+*
+* The batcher collects items and processes them in batches based on:
+* - Maximum batch size (number of items per batch)
+* - Time-based batching (process after X milliseconds)
+* - Custom batch processing logic via getShouldExecute
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and batcher 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 AsyncBatcher 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 `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:
+* - `errorCount`: Number of batch executions that have resulted in errors
+* - `failedItems`: Array of items that failed during batch processing
+* - `isEmpty`: Whether the batcher has no items to process
+* - `isExecuting`: Whether a batch is currently being processed asynchronously
+* - `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
+* - `lastResult`: The result from the most recent batch execution
+* - `settleCount`: Number of batch executions that have completed (success or error)
+* - `size`: Number of items currently in the batch queue
+* - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
+* - `successCount`: Number of batch executions that have completed successfully
+* - `totalItemsProcessed`: Total number of items processed across all batches
+* - `totalItemsFailed`: Total number of items that have failed processing
+*
+* @example
+* ```tsx
+* // Basic async batcher for API requests - no reactive state subscriptions
+* const asyncBatcher = useAsyncBatcher(
+*   async (items) => {
+*     const results = await Promise.all(items.map(item => processItem(item)));
+*     return results;
+*   },
+*   { maxSize: 10, wait: 2000 }
+* );
+*
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Batch Size: {size}</div>
+*   )}
+* </asyncBatcher.Subscribe>
+*
+* // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
+* const asyncBatcher = useAsyncBatcher(
+*   async (items) => {
+*     const results = await Promise.all(items.map(item => processItem(item)));
+*     return results;
+*   },
+*   { maxSize: 10, wait: 2000 },
+*   (state) => ({
+*     isExecuting: state.isExecuting,
+*     isPending: state.isPending,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const asyncBatcher = useAsyncBatcher(
+*   async (items) => {
+*     const results = await Promise.all(items.map(item => processItem(item)));
+*     return results;
+*   },
+*   { maxSize: 10, wait: 2000 },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount,
+*     totalItemsProcessed: state.totalItemsProcessed
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const asyncBatcher = useAsyncBatcher(
+*   async (items) => {
+*     const results = await Promise.all(items.map(item => processItem(item)));
+*     return results;
+*   },
+*   {
+*     maxSize: 10,
+*     wait: 2000,
+*     onError: (error) => console.error('Batch processing failed:', error)
+*   },
+*   (state) => ({
+*     errorCount: state.errorCount,
+*     failedItems: state.failedItems,
+*     totalItemsFailed: state.totalItemsFailed
+*   })
+* );
+*
+* // Complete example with all callbacks
+* const asyncBatcher = useAsyncBatcher(
+*   async (items) => {
+*     const results = await Promise.all(items.map(item => processItem(item)));
+*     return results;
+*   },
+*   {
+*     maxSize: 10,
+*     wait: 2000,
+*     onSuccess: (result) => {
+*       console.log('Batch processed successfully:', result);
+*     },
+*     onError: (error) => {
+*       console.error('Batch processing failed:', error);
+*     }
+*   }
+* );
+*
+* // Add items to batch
+* asyncBatcher.addItem(newItem);
+*
+* // Manually execute batch
+* const result = await asyncBatcher.execute();
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { isExecuting, lastResult, size } = asyncBatcher.state;
+* ```
+*/
+function useAsyncBatcher(fn, options = {}, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().asyncBatcher,
+		...options
+	};
+	const [asyncBatcher] = (0, preact_hooks.useState)(() => {
+		const batcherInstance = new _tanstack_pacer_async_batcher.AsyncBatcher(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;
+	});
+	asyncBatcher.fn = fn;
+	asyncBatcher.setOptions(mergedOptions);
+	const state = (0, _tanstack_preact_store.useStore)(asyncBatcher.store, selector);
+	return (0, preact_hooks.useMemo)(() => ({
+		...asyncBatcher,
+		state
+	}), [asyncBatcher, state]);
+}
+
+//#endregion
+exports.useAsyncBatcher = useAsyncBatcher;
+//# sourceMappingURL=useAsyncBatcher.cjs.map

package/dist/async-batcher/useAsyncBatcher.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncBatcher.cjs","names":["useDefaultPacerOptions","AsyncBatcher"],"sources":["../../src/async-batcher/useAsyncBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncBatcher } from '@tanstack/pacer/async-batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncBatcherOptions,\n  AsyncBatcherState,\n} from '@tanstack/pacer/async-batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<\n  AsyncBatcher<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async 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: AsyncBatcherState<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<AsyncBatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.\n *\n * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:\n * - Handles promises and returns results from batch executions\n * - Provides error handling with configurable error behavior\n * - Tracks success, error, and settle counts separately\n * - Has state tracking for when batches are executing\n * - Returns the result of the batch function execution\n *\n * Features:\n * - Configurable batch size and wait time\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n * - Error handling for failed batch operations\n * - Automatic or manual batch processing\n *\n * The batcher collects items and processes them in batches based on:\n * - Maximum batch size (number of items per batch)\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and batcher 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 AsyncBatcher 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 `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 * - `errorCount`: Number of batch executions that have resulted in errors\n * - `failedItems`: Array of items that failed during batch processing\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isExecuting`: Whether a batch is currently being processed asynchronously\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 * - `lastResult`: The result from the most recent batch execution\n * - `settleCount`: Number of batch executions that have completed (success or error)\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')\n * - `successCount`: Number of batch executions that have completed successfully\n * - `totalItemsProcessed`: Total number of items processed across all batches\n * - `totalItemsFailed`: Total number of items that have failed processing\n *\n * @example\n * ```tsx\n * // Basic async batcher for API requests - no reactive state subscriptions\n * const asyncBatcher = useAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Batch Size: {size}</div>\n *   )}\n * </asyncBatcher.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncBatcher = useAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\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 asyncBatcher = useAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncBatcher = useAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   {\n *     maxSize: 10,\n *     wait: 2000,\n *     onError: (error) => console.error('Batch processing failed:', error)\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     failedItems: state.failedItems,\n *     totalItemsFailed: state.totalItemsFailed\n *   })\n * );\n *\n * // Complete example with all callbacks\n * const asyncBatcher = useAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   {\n *     maxSize: 10,\n *     wait: 2000,\n *     onSuccess: (result) => {\n *       console.log('Batch processed successfully:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Batch processing failed:', error);\n *     }\n *   }\n * );\n *\n * // Add items to batch\n * asyncBatcher.addItem(newItem);\n *\n * // Manually execute batch\n * const result = await asyncBatcher.execute();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, size } = asyncBatcher.state;\n * ```\n */\nexport function useAsyncBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => Promise<any>,\n  options: AsyncBatcherOptions<TValue> = {},\n  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncBatcher,\n    ...options,\n  } as AsyncBatcherOptions<TValue>\n\n  const [asyncBatcher] = useState(() => {\n    const batcherInstance = new AsyncBatcher<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncBatcher<TValue, TSelected>\n\n    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncBatcherState<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  asyncBatcher.fn = fn\n  asyncBatcher.setOptions(mergedOptions)\n\n  const state = useStore(asyncBatcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncBatcher,\n        state,\n      }) as PreactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncBatcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4MA,SAAgB,gBACd,IACA,UAAuC,EAAE,EACzC,kBACG,EAAE,GACkC;CACvC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,iDAA+B;EACpC,MAAM,kBAAkB,IAAIC,2CAC1B,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,cAAa,KAAK;AAClB,cAAa,WAAW,cAAc;CAEtC,MAAM,6CAAiB,aAAa,OAAO,SAAS;AAEpD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,cAAc,MAAM,CACtB"}

package/dist/async-batcher/useAsyncBatcher.d.cts

@@ -0,0 +1,198 @@
+import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
+import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
+
+//#region src/async-batcher/useAsyncBatcher.d.ts
+interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async 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: AsyncBatcherState<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<AsyncBatcherState<TValue>>>;
+}
+/**
+ * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
+ *
+ * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ * - Returns the result of the batch function execution
+ *
+ * Features:
+ * - Configurable batch size and wait time
+ * - Custom batch processing logic via getShouldExecute
+ * - Event callbacks for monitoring batch operations
+ * - Error handling for failed batch operations
+ * - Automatic or manual batch processing
+ *
+ * The batcher collects items and processes them in batches based on:
+ * - Maximum batch size (number of items per batch)
+ * - Time-based batching (process after X milliseconds)
+ * - Custom batch processing logic via getShouldExecute
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and batcher 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 AsyncBatcher 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 `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:
+ * - `errorCount`: Number of batch executions that have resulted in errors
+ * - `failedItems`: Array of items that failed during batch processing
+ * - `isEmpty`: Whether the batcher has no items to process
+ * - `isExecuting`: Whether a batch is currently being processed asynchronously
+ * - `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
+ * - `lastResult`: The result from the most recent batch execution
+ * - `settleCount`: Number of batch executions that have completed (success or error)
+ * - `size`: Number of items currently in the batch queue
+ * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
+ * - `successCount`: Number of batch executions that have completed successfully
+ * - `totalItemsProcessed`: Total number of items processed across all batches
+ * - `totalItemsFailed`: Total number of items that have failed processing
+ *
+ * @example
+ * ```tsx
+ * // Basic async batcher for API requests - no reactive state subscriptions
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 }
+ * );
+ *
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Batch Size: {size}</div>
+ *   )}
+ * </asyncBatcher.Subscribe>
+ *
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     isExecuting: state.isExecuting,
+ *     isPending: state.isPending,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount,
+ *     totalItemsProcessed: state.totalItemsProcessed
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when error state changes (optimized for error handling)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onError: (error) => console.error('Batch processing failed:', error)
+ *   },
+ *   (state) => ({
+ *     errorCount: state.errorCount,
+ *     failedItems: state.failedItems,
+ *     totalItemsFailed: state.totalItemsFailed
+ *   })
+ * );
+ *
+ * // Complete example with all callbacks
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onSuccess: (result) => {
+ *       console.log('Batch processed successfully:', result);
+ *     },
+ *     onError: (error) => {
+ *       console.error('Batch processing failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Add items to batch
+ * asyncBatcher.addItem(newItem);
+ *
+ * // Manually execute batch
+ * const result = await asyncBatcher.execute();
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isExecuting, lastResult, size } = asyncBatcher.state;
+ * ```
+ */
+declare function useAsyncBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => Promise<any>, options?: AsyncBatcherOptions<TValue>, selector?: (state: AsyncBatcherState<TValue>) => TSelected): PreactAsyncBatcher<TValue, TSelected>;
+//#endregion
+export { PreactAsyncBatcher, useAsyncBatcher };
+//# sourceMappingURL=useAsyncBatcher.d.cts.map

package/dist/async-batcher/useAsyncBatcher.d.ts

@@ -0,0 +1,198 @@
+import { ComponentChildren } from "preact";
+import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
+import { Store } from "@tanstack/preact-store";
+
+//#region src/async-batcher/useAsyncBatcher.d.ts
+interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async 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: AsyncBatcherState<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<AsyncBatcherState<TValue>>>;
+}
+/**
+ * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
+ *
+ * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ * - Returns the result of the batch function execution
+ *
+ * Features:
+ * - Configurable batch size and wait time
+ * - Custom batch processing logic via getShouldExecute
+ * - Event callbacks for monitoring batch operations
+ * - Error handling for failed batch operations
+ * - Automatic or manual batch processing
+ *
+ * The batcher collects items and processes them in batches based on:
+ * - Maximum batch size (number of items per batch)
+ * - Time-based batching (process after X milliseconds)
+ * - Custom batch processing logic via getShouldExecute
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and batcher 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 AsyncBatcher 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 `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:
+ * - `errorCount`: Number of batch executions that have resulted in errors
+ * - `failedItems`: Array of items that failed during batch processing
+ * - `isEmpty`: Whether the batcher has no items to process
+ * - `isExecuting`: Whether a batch is currently being processed asynchronously
+ * - `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
+ * - `lastResult`: The result from the most recent batch execution
+ * - `settleCount`: Number of batch executions that have completed (success or error)
+ * - `size`: Number of items currently in the batch queue
+ * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
+ * - `successCount`: Number of batch executions that have completed successfully
+ * - `totalItemsProcessed`: Total number of items processed across all batches
+ * - `totalItemsFailed`: Total number of items that have failed processing
+ *
+ * @example
+ * ```tsx
+ * // Basic async batcher for API requests - no reactive state subscriptions
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 }
+ * );
+ *
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Batch Size: {size}</div>
+ *   )}
+ * </asyncBatcher.Subscribe>
+ *
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     isExecuting: state.isExecuting,
+ *     isPending: state.isPending,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount,
+ *     totalItemsProcessed: state.totalItemsProcessed
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when error state changes (optimized for error handling)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onError: (error) => console.error('Batch processing failed:', error)
+ *   },
+ *   (state) => ({
+ *     errorCount: state.errorCount,
+ *     failedItems: state.failedItems,
+ *     totalItemsFailed: state.totalItemsFailed
+ *   })
+ * );
+ *
+ * // Complete example with all callbacks
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onSuccess: (result) => {
+ *       console.log('Batch processed successfully:', result);
+ *     },
+ *     onError: (error) => {
+ *       console.error('Batch processing failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Add items to batch
+ * asyncBatcher.addItem(newItem);
+ *
+ * // Manually execute batch
+ * const result = await asyncBatcher.execute();
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isExecuting, lastResult, size } = asyncBatcher.state;
+ * ```
+ */
+declare function useAsyncBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => Promise<any>, options?: AsyncBatcherOptions<TValue>, selector?: (state: AsyncBatcherState<TValue>) => TSelected): PreactAsyncBatcher<TValue, TSelected>;
+//#endregion
+export { PreactAsyncBatcher, useAsyncBatcher };
+//# sourceMappingURL=useAsyncBatcher.d.ts.map