@tanstack/preact-pacer 0.0.1 → 0.18.0

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'\n\nexport interface ReactAsyncBatcher<TValue, TSelected = {}> extends Omit<\n  AsyncBatcher<TValue>,\n  'store'\n> {\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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `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 * // Opt-in to re-render when execution state changes (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): ReactAsyncBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncBatcher,\n    ...options,\n  } as AsyncBatcherOptions<TValue>\n\n  const [asyncBatcher] = useState(\n    () => new AsyncBatcher<TValue>(fn, mergedOptions),\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 ReactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncBatcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyKA,SAAgB,gBACd,IACA,UAAuC,EAAE,EACzC,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,iDACC,IAAIC,4CAAqB,IAAI,cAAc,CAClD;AAED,cAAa,KAAK;AAClB,cAAa,WAAW,cAAc;CAEtC,MAAM,8CAAiB,aAAa,OAAO,SAAS;AAEpD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,cAAc,MAAM,CACtB"}

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

@@ -0,0 +1,163 @@
+import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
+import { Store } from "@tanstack/preact-store";
+
+//#region src/async-batcher/useAsyncBatcher.d.ts
+interface ReactAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
+  /**
+   * 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. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
+ * unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available state properties:
+ * - `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 }
+ * );
+ *
+ * // Opt-in to re-render when execution state changes (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): ReactAsyncBatcher<TValue, TSelected>;
+//#endregion
+export { ReactAsyncBatcher, useAsyncBatcher };
+//# sourceMappingURL=useAsyncBatcher.d.cts.map

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

@@ -0,0 +1,163 @@
+import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
+import { Store } from "@tanstack/preact-store";
+
+//#region src/async-batcher/useAsyncBatcher.d.ts
+interface ReactAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
+  /**
+   * 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. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
+ * unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available state properties:
+ * - `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 }
+ * );
+ *
+ * // Opt-in to re-render when execution state changes (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): ReactAsyncBatcher<TValue, TSelected>;
+//#endregion
+export { ReactAsyncBatcher, useAsyncBatcher };
+//# sourceMappingURL=useAsyncBatcher.d.ts.map

package/dist/async-batcher/useAsyncBatcher.js

@@ -0,0 +1,165 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { AsyncBatcher } from "@tanstack/pacer/async-batcher";
+import { useStore } from "@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. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, optimizing performance by preventing
+* unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `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 }
+* );
+*
+* // Opt-in to re-render when execution state changes (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 = {
+		...useDefaultPacerOptions().asyncBatcher,
+		...options
+	};
+	const [asyncBatcher] = useState(() => new AsyncBatcher(fn, mergedOptions));
+	asyncBatcher.fn = fn;
+	asyncBatcher.setOptions(mergedOptions);
+	const state = useStore(asyncBatcher.store, selector);
+	return useMemo(() => ({
+		...asyncBatcher,
+		state
+	}), [asyncBatcher, state]);
+}
+
+//#endregion
+export { useAsyncBatcher };
+//# sourceMappingURL=useAsyncBatcher.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncBatcher.js","names":[],"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'\n\nexport interface ReactAsyncBatcher<TValue, TSelected = {}> extends Omit<\n  AsyncBatcher<TValue>,\n  'store'\n> {\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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `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 * // Opt-in to re-render when execution state changes (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): ReactAsyncBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncBatcher,\n    ...options,\n  } as AsyncBatcherOptions<TValue>\n\n  const [asyncBatcher] = useState(\n    () => new AsyncBatcher<TValue>(fn, mergedOptions),\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 ReactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncBatcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyKA,SAAgB,gBACd,IACA,UAAuC,EAAE,EACzC,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,gBAAgB,eACf,IAAI,aAAqB,IAAI,cAAc,CAClD;AAED,cAAa,KAAK;AAClB,cAAa,WAAW,cAAc;CAEtC,MAAM,QAAQ,SAAS,aAAa,OAAO,SAAS;AAEpD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,cAAc,MAAM,CACtB"}

package/dist/async-debouncer/index.cjs

@@ -0,0 +1,12 @@
+const require_useAsyncDebouncer = require('./useAsyncDebouncer.cjs');
+const require_useAsyncDebouncedCallback = require('./useAsyncDebouncedCallback.cjs');
+
+exports.useAsyncDebouncedCallback = require_useAsyncDebouncedCallback.useAsyncDebouncedCallback;
+exports.useAsyncDebouncer = require_useAsyncDebouncer.useAsyncDebouncer;
+var __tanstack_pacer_async_debouncer = require("@tanstack/pacer/async-debouncer");
+Object.keys(__tanstack_pacer_async_debouncer).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_async_debouncer[k]; }
+  });
+});

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

@@ -0,0 +1,4 @@
+import { ReactAsyncDebouncer, useAsyncDebouncer } from "./useAsyncDebouncer.cjs";
+import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.cjs";
+export * from "@tanstack/pacer/async-debouncer";
+export { ReactAsyncDebouncer, useAsyncDebouncedCallback, useAsyncDebouncer };

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

@@ -0,0 +1,4 @@
+import { ReactAsyncDebouncer, useAsyncDebouncer } from "./useAsyncDebouncer.js";
+import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.js";
+export * from "@tanstack/pacer/async-debouncer";
+export { ReactAsyncDebouncer, useAsyncDebouncedCallback, useAsyncDebouncer };

package/dist/async-debouncer/index.js

@@ -0,0 +1,6 @@
+import { useAsyncDebouncer } from "./useAsyncDebouncer.js";
+import { useAsyncDebouncedCallback } from "./useAsyncDebouncedCallback.js";
+
+export * from "@tanstack/pacer/async-debouncer"
+
+export { useAsyncDebouncedCallback, useAsyncDebouncer };

package/dist/async-debouncer/useAsyncDebouncedCallback.cjs

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

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

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