@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/async-debouncer/useAsyncDebouncer.js

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

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

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

package/dist/async-queuer/index.cjs

@@ -0,0 +1,12 @@
+const require_useAsyncQueuer = require('./useAsyncQueuer.cjs');
+const require_useAsyncQueuedState = require('./useAsyncQueuedState.cjs');
+
+exports.useAsyncQueuedState = require_useAsyncQueuedState.useAsyncQueuedState;
+exports.useAsyncQueuer = require_useAsyncQueuer.useAsyncQueuer;
+var __tanstack_pacer_async_queuer = require("@tanstack/pacer/async-queuer");
+Object.keys(__tanstack_pacer_async_queuer).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_async_queuer[k]; }
+  });
+});

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

@@ -0,0 +1,4 @@
+import { ReactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.cjs";
+import { useAsyncQueuedState } from "./useAsyncQueuedState.cjs";
+export * from "@tanstack/pacer/async-queuer";
+export { ReactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };

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

@@ -0,0 +1,4 @@
+import { ReactAsyncQueuer, useAsyncQueuer } from "./useAsyncQueuer.js";
+import { useAsyncQueuedState } from "./useAsyncQueuedState.js";
+export * from "@tanstack/pacer/async-queuer";
+export { ReactAsyncQueuer, useAsyncQueuedState, useAsyncQueuer };

package/dist/async-queuer/index.js

@@ -0,0 +1,6 @@
+import { useAsyncQueuer } from "./useAsyncQueuer.js";
+import { useAsyncQueuedState } from "./useAsyncQueuedState.js";
+
+export * from "@tanstack/pacer/async-queuer"
+
+export { useAsyncQueuedState, useAsyncQueuer };

package/dist/async-queuer/useAsyncQueuedState.cjs

@@ -0,0 +1,154 @@
+const require_useAsyncQueuer = require('./useAsyncQueuer.cjs');
+
+//#region src/async-queuer/useAsyncQueuedState.ts
+/**
+* A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.
+*
+* This hook combines an AsyncQueuer with Preact state to automatically track the queue items.
+* It returns a tuple containing:
+* - The current array of queued items as Preact state
+* - The queuer instance with methods to control the queue
+*
+* The queue can be configured with:
+* - Maximum concurrent operations
+* - Maximum queue size
+* - Processing function for queue items
+* - Various lifecycle callbacks
+*
+* The state will automatically update whenever items are:
+* - Added to the queue
+* - Removed from the queue
+* - Started processing
+* - Completed processing
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management via the underlying async queuer instance.
+* The `selector` parameter allows you to specify which async queuer 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 async queuer state properties:
+* - `activeItems`: Items currently being processed by the queuer
+* - `errorCount`: Number of task executions that have resulted in errors
+* - `expirationCount`: Number of items that have been removed due to expiration
+* - `isEmpty`: Whether the queuer has no items to process
+* - `isFull`: Whether the queuer has reached its maximum capacity
+* - `isIdle`: Whether the queuer is not currently processing any items
+* - `isRunning`: Whether the queuer is active and will process items automatically
+* - `items`: Array of items currently waiting to be processed
+* - `itemTimestamps`: Timestamps when items were added for expiration tracking
+* - `lastResult`: The result from the most recent task execution
+* - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+* - `rejectionCount`: Number of items that have been rejected from being added
+* - `settledCount`: Number of task executions that have completed (success or error)
+* - `size`: Number of items currently in the queue
+* - `status`: Current processing status ('idle' | 'running' | 'stopped')
+* - `successCount`: Number of task executions that have completed successfully
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [queueItems, asyncQueuer] = useAsyncQueuedState(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   {
+*     concurrency: 2,
+*     maxSize: 100,
+*     started: true
+*   }
+* );
+*
+* // Opt-in to re-render when queue contents change (optimized for displaying queue items)
+* const [queueItems, asyncQueuer] = useAsyncQueuedState(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: true },
+*   (state) => ({
+*     items: state.items,
+*     size: state.size,
+*     isEmpty: state.isEmpty,
+*     isFull: state.isFull
+*   })
+* );
+*
+* // Opt-in to re-render when processing state changes (optimized for loading indicators)
+* const [queueItems, asyncQueuer] = useAsyncQueuedState(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: true },
+*   (state) => ({
+*     isRunning: state.isRunning,
+*     isIdle: state.isIdle,
+*     status: state.status,
+*     activeItems: state.activeItems,
+*     pendingTick: state.pendingTick
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for stats display)
+* const [queueItems, asyncQueuer] = useAsyncQueuedState(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: true },
+*   (state) => ({
+*     successCount: state.successCount,
+*     errorCount: state.errorCount,
+*     settledCount: state.settledCount,
+*     expirationCount: state.expirationCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const [queueItems, asyncQueuer] = useAsyncQueuedState(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: true },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount
+*   })
+* );
+*
+* // Add items to queue - state updates automatically
+* asyncQueuer.addItem(async () => {
+*   const result = await fetchData();
+*   return result;
+* });
+*
+* // Start processing
+* asyncQueuer.start();
+*
+* // Stop processing
+* asyncQueuer.stop();
+*
+* // queueItems reflects current queue state
+* const pendingCount = asyncQueuer.peekPendingItems().length;
+*
+* // Access the selected async queuer state (will be empty object {} unless selector provided)
+* const { size, isRunning, activeItems } = asyncQueuer.state;
+* ```
+*/
+function useAsyncQueuedState(fn, options = {}, selector) {
+	const asyncQueuer = require_useAsyncQueuer.useAsyncQueuer(fn, options, selector);
+	return [asyncQueuer.state.items, asyncQueuer];
+}
+
+//#endregion
+exports.useAsyncQueuedState = useAsyncQueuedState;
+//# sourceMappingURL=useAsyncQueuedState.cjs.map

package/dist/async-queuer/useAsyncQueuedState.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncQueuedState.cjs","names":["useAsyncQueuer"],"sources":["../../src/async-queuer/useAsyncQueuedState.ts"],"sourcesContent":["import { useAsyncQueuer } from './useAsyncQueuer'\nimport type { ReactAsyncQueuer } from './useAsyncQueuer'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\n/**\n * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.\n *\n * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.\n * It returns a tuple containing:\n * - The current array of queued items as Preact state\n * - The queuer instance with methods to control the queue\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The state will automatically update whenever items are:\n * - Added to the queue\n * - Removed from the queue\n * - Started processing\n * - Completed processing\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.\n * The `selector` parameter allows you to specify which async queuer state changes will trigger a re-render,\n * optimizing performance by preventing 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 async queuer state properties:\n * - `activeItems`: Items currently being processed by the queuer\n * - `errorCount`: Number of task executions that have resulted in errors\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `lastResult`: The result from the most recent task execution\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `settledCount`: Number of task executions that have completed (success or error)\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n * - `successCount`: Number of task executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\n *     concurrency: 2,\n *     maxSize: 100,\n *     started: true\n *   }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: true },\n *   (state) => ({\n *     items: state.items,\n *     size: state.size,\n *     isEmpty: state.isEmpty,\n *     isFull: state.isFull\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: true },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     activeItems: state.activeItems,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: true },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settledCount: state.settledCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const [queueItems, asyncQueuer] = useAsyncQueuedState(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: true },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Add items to queue - state updates automatically\n * asyncQueuer.addItem(async () => {\n *   const result = await fetchData();\n *   return result;\n * });\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Stop processing\n * asyncQueuer.stop();\n *\n * // queueItems reflects current queue state\n * const pendingCount = asyncQueuer.peekPendingItems().length;\n *\n * // Access the selected async queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuedState<\n  TValue,\n  TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<\n    AsyncQueuerState<TValue>,\n    'items'\n  >,\n>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector?: (state: AsyncQueuerState<TValue>) => TSelected,\n): [Array<TValue>, ReactAsyncQueuer<TValue, TSelected>] {\n  const asyncQueuer = useAsyncQueuer(fn, options, selector)\n\n  return [asyncQueuer.state.items, asyncQueuer]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,SAAgB,oBAOd,IACA,UAAsC,EAAE,EACxC,UACsD;CACtD,MAAM,cAAcA,sCAAe,IAAI,SAAS,SAAS;AAEzD,QAAO,CAAC,YAAY,MAAM,OAAO,YAAY"}

package/dist/async-queuer/useAsyncQueuedState.d.cts

@@ -0,0 +1,152 @@
+import { ReactAsyncQueuer } from "./useAsyncQueuer.cjs";
+import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
+
+//#region src/async-queuer/useAsyncQueuedState.d.ts
+
+/**
+ * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.
+ *
+ * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.
+ * It returns a tuple containing:
+ * - The current array of queued items as Preact state
+ * - The queuer instance with methods to control the queue
+ *
+ * The queue can be configured with:
+ * - Maximum concurrent operations
+ * - Maximum queue size
+ * - Processing function for queue items
+ * - Various lifecycle callbacks
+ *
+ * The state will automatically update whenever items are:
+ * - Added to the queue
+ * - Removed from the queue
+ * - Started processing
+ * - Completed processing
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.
+ * The `selector` parameter allows you to specify which async queuer 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 async queuer state properties:
+ * - `activeItems`: Items currently being processed by the queuer
+ * - `errorCount`: Number of task executions that have resulted in errors
+ * - `expirationCount`: Number of items that have been removed due to expiration
+ * - `isEmpty`: Whether the queuer has no items to process
+ * - `isFull`: Whether the queuer has reached its maximum capacity
+ * - `isIdle`: Whether the queuer is not currently processing any items
+ * - `isRunning`: Whether the queuer is active and will process items automatically
+ * - `items`: Array of items currently waiting to be processed
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
+ * - `lastResult`: The result from the most recent task execution
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+ * - `rejectionCount`: Number of items that have been rejected from being added
+ * - `settledCount`: Number of task executions that have completed (success or error)
+ * - `size`: Number of items currently in the queue
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
+ * - `successCount`: Number of task executions that have completed successfully
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   {
+ *     concurrency: 2,
+ *     maxSize: 100,
+ *     started: true
+ *   }
+ * );
+ *
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     items: state.items,
+ *     size: state.size,
+ *     isEmpty: state.isEmpty,
+ *     isFull: state.isFull
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     isRunning: state.isRunning,
+ *     isIdle: state.isIdle,
+ *     status: state.status,
+ *     activeItems: state.activeItems,
+ *     pendingTick: state.pendingTick
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     successCount: state.successCount,
+ *     errorCount: state.errorCount,
+ *     settledCount: state.settledCount,
+ *     expirationCount: state.expirationCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount
+ *   })
+ * );
+ *
+ * // Add items to queue - state updates automatically
+ * asyncQueuer.addItem(async () => {
+ *   const result = await fetchData();
+ *   return result;
+ * });
+ *
+ * // Start processing
+ * asyncQueuer.start();
+ *
+ * // Stop processing
+ * asyncQueuer.stop();
+ *
+ * // queueItems reflects current queue state
+ * const pendingCount = asyncQueuer.peekPendingItems().length;
+ *
+ * // Access the selected async queuer state (will be empty object {} unless selector provided)
+ * const { size, isRunning, activeItems } = asyncQueuer.state;
+ * ```
+ */
+declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, ReactAsyncQueuer<TValue, TSelected>];
+//#endregion
+export { useAsyncQueuedState };
+//# sourceMappingURL=useAsyncQueuedState.d.cts.map

package/dist/async-queuer/useAsyncQueuedState.d.ts

@@ -0,0 +1,152 @@
+import { ReactAsyncQueuer } from "./useAsyncQueuer.js";
+import { AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
+
+//#region src/async-queuer/useAsyncQueuedState.d.ts
+
+/**
+ * A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management.
+ *
+ * This hook combines an AsyncQueuer with Preact state to automatically track the queue items.
+ * It returns a tuple containing:
+ * - The current array of queued items as Preact state
+ * - The queuer instance with methods to control the queue
+ *
+ * The queue can be configured with:
+ * - Maximum concurrent operations
+ * - Maximum queue size
+ * - Processing function for queue items
+ * - Various lifecycle callbacks
+ *
+ * The state will automatically update whenever items are:
+ * - Added to the queue
+ * - Removed from the queue
+ * - Started processing
+ * - Completed processing
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying async queuer instance.
+ * The `selector` parameter allows you to specify which async queuer 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 async queuer state properties:
+ * - `activeItems`: Items currently being processed by the queuer
+ * - `errorCount`: Number of task executions that have resulted in errors
+ * - `expirationCount`: Number of items that have been removed due to expiration
+ * - `isEmpty`: Whether the queuer has no items to process
+ * - `isFull`: Whether the queuer has reached its maximum capacity
+ * - `isIdle`: Whether the queuer is not currently processing any items
+ * - `isRunning`: Whether the queuer is active and will process items automatically
+ * - `items`: Array of items currently waiting to be processed
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
+ * - `lastResult`: The result from the most recent task execution
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+ * - `rejectionCount`: Number of items that have been rejected from being added
+ * - `settledCount`: Number of task executions that have completed (success or error)
+ * - `size`: Number of items currently in the queue
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
+ * - `successCount`: Number of task executions that have completed successfully
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   {
+ *     concurrency: 2,
+ *     maxSize: 100,
+ *     started: true
+ *   }
+ * );
+ *
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue items)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     items: state.items,
+ *     size: state.size,
+ *     isEmpty: state.isEmpty,
+ *     isFull: state.isFull
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     isRunning: state.isRunning,
+ *     isIdle: state.isIdle,
+ *     status: state.status,
+ *     activeItems: state.activeItems,
+ *     pendingTick: state.pendingTick
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     successCount: state.successCount,
+ *     errorCount: state.errorCount,
+ *     settledCount: state.settledCount,
+ *     expirationCount: state.expirationCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const [queueItems, asyncQueuer] = useAsyncQueuedState(
+ *   async (item) => {
+ *     const result = await processItem(item);
+ *     return result;
+ *   },
+ *   { concurrency: 2, maxSize: 100, started: true },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount
+ *   })
+ * );
+ *
+ * // Add items to queue - state updates automatically
+ * asyncQueuer.addItem(async () => {
+ *   const result = await fetchData();
+ *   return result;
+ * });
+ *
+ * // Start processing
+ * asyncQueuer.start();
+ *
+ * // Stop processing
+ * asyncQueuer.stop();
+ *
+ * // queueItems reflects current queue state
+ * const pendingCount = asyncQueuer.peekPendingItems().length;
+ *
+ * // Access the selected async queuer state (will be empty object {} unless selector provided)
+ * const { size, isRunning, activeItems } = asyncQueuer.state;
+ * ```
+ */
+declare function useAsyncQueuedState<TValue, TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<AsyncQueuerState<TValue>, 'items'>>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): [Array<TValue>, ReactAsyncQueuer<TValue, TSelected>];
+//#endregion
+export { useAsyncQueuedState };
+//# sourceMappingURL=useAsyncQueuedState.d.ts.map