@tanstack/preact-pacer 0.18.0 → 0.19.0

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

@@ -1,8 +1,26 @@
 import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
 import { AsyncQueuer, AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
 
 //#region src/async-queuer/useAsyncQueuer.d.ts
-interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TValue>, 'store'> {
+interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the queuer state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Queue Size: {size}</div>
+   *   )}
+   * </queuer.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: AsyncQueuerState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the queuer state changes
    *
@@ -40,14 +58,24 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  *
  * ## 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.
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `queuer.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. 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.
+ * 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:
  * - `activeItems`: Items currently being processed by the queuer
@@ -78,7 +106,14 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  *   { concurrency: 2, maxSize: 100, started: false }
  * );
  *
- * // Opt-in to re-render when queue size changes (optimized for displaying queue length)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Queue Size: {size}</div>
+ *   )}
+ * </asyncQueuer.Subscribe>
+ *
+ * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
  * const asyncQueuer = useAsyncQueuer(
  *   async (item) => {
  *     const result = await processItem(item);
@@ -157,7 +192,7 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  * const { size, isRunning, activeItems } = asyncQueuer.state;
  * ```
  */
-declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): ReactAsyncQueuer<TValue, TSelected>;
+declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): PreactAsyncQueuer<TValue, TSelected>;
 //#endregion
-export { ReactAsyncQueuer, useAsyncQueuer };
+export { PreactAsyncQueuer, useAsyncQueuer };
 //# sourceMappingURL=useAsyncQueuer.d.cts.map

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

@@ -1,8 +1,26 @@
+import { ComponentChildren } from "preact";
 import { Store } from "@tanstack/preact-store";
 import { AsyncQueuer, AsyncQueuerOptions, AsyncQueuerState } from "@tanstack/pacer/async-queuer";
 
 //#region src/async-queuer/useAsyncQueuer.d.ts
-interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TValue>, 'store'> {
+interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the queuer state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Queue Size: {size}</div>
+   *   )}
+   * </queuer.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: AsyncQueuerState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the queuer state changes
    *
@@ -40,14 +58,24 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  *
  * ## 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.
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `queuer.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. 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.
+ * 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:
  * - `activeItems`: Items currently being processed by the queuer
@@ -78,7 +106,14 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  *   { concurrency: 2, maxSize: 100, started: false }
  * );
  *
- * // Opt-in to re-render when queue size changes (optimized for displaying queue length)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Queue Size: {size}</div>
+ *   )}
+ * </asyncQueuer.Subscribe>
+ *
+ * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
  * const asyncQueuer = useAsyncQueuer(
  *   async (item) => {
  *     const result = await processItem(item);
@@ -157,7 +192,7 @@ interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<AsyncQueuer<TVal
  * const { size, isRunning, activeItems } = asyncQueuer.state;
  * ```
  */
-declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): ReactAsyncQueuer<TValue, TSelected>;
+declare function useAsyncQueuer<TValue, TSelected = {}>(fn: (value: TValue) => Promise<any>, options?: AsyncQueuerOptions<TValue>, selector?: (state: AsyncQueuerState<TValue>) => TSelected): PreactAsyncQueuer<TValue, TSelected>;
 //#endregion
-export { ReactAsyncQueuer, useAsyncQueuer };
+export { PreactAsyncQueuer, useAsyncQueuer };
 //# sourceMappingURL=useAsyncQueuer.d.ts.map

package/dist/async-queuer/useAsyncQueuer.js

@@ -28,14 +28,24 @@ import { AsyncQueuer } from "@tanstack/pacer/async-queuer";
 *
 * ## 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.
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `queuer.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. 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.
+* 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:
 * - `activeItems`: Items currently being processed by the queuer
@@ -66,7 +76,14 @@ import { AsyncQueuer } from "@tanstack/pacer/async-queuer";
 *   { concurrency: 2, maxSize: 100, started: false }
 * );
 *
-* // Opt-in to re-render when queue size changes (optimized for displaying queue length)
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Queue Size: {size}</div>
+*   )}
+* </asyncQueuer.Subscribe>
+*
+* // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
 * const asyncQueuer = useAsyncQueuer(
 *   async (item) => {
 *     const result = await processItem(item);
@@ -150,7 +167,14 @@ function useAsyncQueuer(fn, options = {}, selector = () => ({})) {
 		...useDefaultPacerOptions().asyncQueuer,
 		...options
 	};
-	const [asyncQueuer] = useState(() => new AsyncQueuer(fn, mergedOptions));
+	const [asyncQueuer] = useState(() => {
+		const queuerInstance = new AsyncQueuer(fn, mergedOptions);
+		queuerInstance.Subscribe = function Subscribe(props) {
+			const selected = useStore(queuerInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return queuerInstance;
+	});
 	asyncQueuer.fn = fn;
 	asyncQueuer.setOptions(mergedOptions);
 	const state = useStore(asyncQueuer.store, selector);

package/dist/async-queuer/useAsyncQueuer.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\nexport interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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<AsyncQueuerState<TValue>>>\n}\n\n/**\n * A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and queuer 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 AsyncQueuer 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 * - `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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false }\n * );\n *\n * // Opt-in to re-render when queue size changes (optimized for displaying queue length)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\n *     concurrency: 2,\n *     maxSize: 100,\n *     started: false,\n *     onSuccess: (result) => {\n *       console.log('Item processed:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Processing failed:', error);\n *     }\n *   },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as AsyncQueuerOptions<TValue>\n\n  const [asyncQueuer] = useState(\n    () => new AsyncQueuer<TValue>(fn, mergedOptions),\n  )\n\n  asyncQueuer.fn = fn\n  asyncQueuer.setOptions(mergedOptions)\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncQueuer,\n        state,\n      }) as ReactAsyncQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncQueuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyKA,SAAgB,eACd,IACA,UAAsC,EAAE,EACxC,kBACG,EAAE,GACgC;CACrC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,eAAe,eACd,IAAI,YAAoB,IAAI,cAAc,CACjD;AAED,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}
+{"version":3,"file":"useAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the queuer state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Queue Size: {size}</div>\n   *   )}\n   * </queuer.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncQueuerState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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<AsyncQueuerState<TValue>>>\n}\n\n/**\n * A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and queuer 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 AsyncQueuer 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 `queuer.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 * - `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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncQueuer.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Queue Size: {size}</div>\n *   )}\n * </asyncQueuer.Subscribe>\n *\n * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\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 asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\n *     concurrency: 2,\n *     maxSize: 100,\n *     started: false,\n *     onSuccess: (result) => {\n *       console.log('Item processed:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Processing failed:', error);\n *     }\n *   },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as AsyncQueuerOptions<TValue>\n\n  const [asyncQueuer] = useState(() => {\n    const queuerInstance = new AsyncQueuer<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncQueuer<TValue, TSelected>\n\n    queuerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncQueuerState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(queuerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return queuerInstance\n  })\n\n  asyncQueuer.fn = fn\n  asyncQueuer.setOptions(mergedOptions)\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncQueuer,\n        state,\n      }) as PreactAsyncQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncQueuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4MA,SAAgB,eACd,IACA,UAAsC,EAAE,EACxC,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,eAAe,eAAe;EACnC,MAAM,iBAAiB,IAAI,YACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}

package/dist/async-rate-limiter/index.cjs

@@ -3,10 +3,10 @@ const require_useAsyncRateLimitedCallback = require('./useAsyncRateLimitedCallba
 
 exports.useAsyncRateLimitedCallback = require_useAsyncRateLimitedCallback.useAsyncRateLimitedCallback;
 exports.useAsyncRateLimiter = require_useAsyncRateLimiter.useAsyncRateLimiter;
-var __tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
-Object.keys(__tanstack_pacer_async_rate_limiter).forEach(function (k) {
+var _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
+Object.keys(_tanstack_pacer_async_rate_limiter).forEach(function (k) {
   if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
     enumerable: true,
-    get: function () { return __tanstack_pacer_async_rate_limiter[k]; }
+    get: function () { return _tanstack_pacer_async_rate_limiter[k]; }
   });
 });

package/dist/async-rate-limiter/index.d.cts

@@ -1,4 +1,4 @@
-import { ReactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
+import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
 import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.cjs";
 export * from "@tanstack/pacer/async-rate-limiter";
-export { ReactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };

package/dist/async-rate-limiter/index.d.ts

@@ -1,4 +1,4 @@
-import { ReactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
+import { PreactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
 import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.js";
 export * from "@tanstack/pacer/async-rate-limiter";
-export { ReactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };

package/dist/async-rate-limiter/useAsyncRateLimiter.cjs

@@ -1,7 +1,7 @@
 const require_PacerProvider = require('../provider/PacerProvider.cjs');
 let preact_hooks = require("preact/hooks");
-let __tanstack_preact_store = require("@tanstack/preact-store");
-let __tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+let _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
 
 //#region src/async-rate-limiter/useAsyncRateLimiter.ts
 /**
@@ -34,14 +34,24 @@ let __tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-li
 *
 * ## 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.
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `rateLimiter.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. 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.
+* tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
+* re-renders and gives you full control over when your component updates.
 *
 * Available state properties:
 * - `errorCount`: Number of function executions that have resulted in errors
@@ -63,7 +73,14 @@ let __tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-li
 *   { limit: 5, window: 1000 } // 5 calls per second
 * );
 *
-* // Opt-in to re-render when execution state changes (optimized for loading indicators)
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
+*   {({ rejectionCount }) => (
+*     <div>Rejections: {rejectionCount}</div>
+*   )}
+* </asyncRateLimiter.Subscribe>
+*
+* // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
 * const asyncRateLimiter = useAsyncRateLimiter(
 *   async (id: string) => {
 *     const data = await api.fetchData(id);
@@ -158,10 +175,17 @@ function useAsyncRateLimiter(fn, options, selector = () => ({})) {
 		...require_PacerProvider.useDefaultPacerOptions().asyncRateLimiter,
 		...options
 	};
-	const [asyncRateLimiter] = (0, preact_hooks.useState)(() => new __tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, mergedOptions));
+	const [asyncRateLimiter] = (0, preact_hooks.useState)(() => {
+		const rateLimiterInstance = new _tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, mergedOptions);
+		rateLimiterInstance.Subscribe = function Subscribe(props) {
+			const selected = (0, _tanstack_preact_store.useStore)(rateLimiterInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return rateLimiterInstance;
+	});
 	asyncRateLimiter.fn = fn;
 	asyncRateLimiter.setOptions(mergedOptions);
-	const state = (0, __tanstack_preact_store.useStore)(asyncRateLimiter.store, selector);
+	const state = (0, _tanstack_preact_store.useStore)(asyncRateLimiter.store, selector);
 	return (0, preact_hooks.useMemo)(() => ({
 		...asyncRateLimiter,
 		state

package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\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  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface ReactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited 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 rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter 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 AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Opt-in to re-render when execution state changes (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\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, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const [asyncRateLimiter] = useState(\n    () => new AsyncRateLimiter<TFn>(fn, mergedOptions),\n  )\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as ReactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkLA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACkC;CACvC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,qDACC,IAAIC,qDAAsB,IAAI,cAAc,CACnD;AAED,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,8CAAiB,iBAAiB,OAAO,SAAS;AAExD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}
+{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\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  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited 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 rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter 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 AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\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, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(rateLimiterInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqNA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACmC;CACxC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,qDAAmC;EACxC,MAAM,sBAAsB,IAAIC,oDAC9B,IACA,cACD;AAED,sBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,gDAAoB,oBAAoB,OAAO,MAAM,SAAS;AAEpE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,6CAAiB,iBAAiB,OAAO,SAAS;AAExD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}

package/dist/async-rate-limiter/useAsyncRateLimiter.d.cts

@@ -1,9 +1,27 @@
 import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
 
 //#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
-interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the rate limiter state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
+   *   {({ rejectionCount }) => (
+   *     <div>Rejections: {rejectionCount}</div>
+   *   )}
+   * </rateLimiter.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: AsyncRateLimiterState<TFn>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the rate limiter state changes
    *
@@ -47,14 +65,24 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  *
  * ## 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.
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `rateLimiter.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. 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.
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
+ * re-renders and gives you full control over when your component updates.
  *
  * Available state properties:
  * - `errorCount`: Number of function executions that have resulted in errors
@@ -76,7 +104,14 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // Opt-in to re-render when execution state changes (optimized for loading indicators)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
+ *   {({ rejectionCount }) => (
+ *     <div>Rejections: {rejectionCount}</div>
+ *   )}
+ * </asyncRateLimiter.Subscribe>
+ *
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
  * const asyncRateLimiter = useAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
@@ -166,7 +201,7 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * const { isExecuting, lastResult, rejectionCount } = state;
  * ```
  */
-declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): ReactAsyncRateLimiter<TFn, TSelected>;
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
 //#endregion
-export { ReactAsyncRateLimiter, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, useAsyncRateLimiter };
 //# sourceMappingURL=useAsyncRateLimiter.d.cts.map

package/dist/async-rate-limiter/useAsyncRateLimiter.d.ts

@@ -1,9 +1,27 @@
+import { ComponentChildren } from "preact";
 import { Store } from "@tanstack/preact-store";
 import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 
 //#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
-interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the rate limiter state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
+   *   {({ rejectionCount }) => (
+   *     <div>Rejections: {rejectionCount}</div>
+   *   )}
+   * </rateLimiter.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: AsyncRateLimiterState<TFn>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the rate limiter state changes
    *
@@ -47,14 +65,24 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  *
  * ## 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.
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `rateLimiter.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. 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.
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
+ * re-renders and gives you full control over when your component updates.
  *
  * Available state properties:
  * - `errorCount`: Number of function executions that have resulted in errors
@@ -76,7 +104,14 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // Opt-in to re-render when execution state changes (optimized for loading indicators)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
+ *   {({ rejectionCount }) => (
+ *     <div>Rejections: {rejectionCount}</div>
+ *   )}
+ * </asyncRateLimiter.Subscribe>
+ *
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
  * const asyncRateLimiter = useAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
@@ -166,7 +201,7 @@ interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * const { isExecuting, lastResult, rejectionCount } = state;
  * ```
  */
-declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): ReactAsyncRateLimiter<TFn, TSelected>;
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
 //#endregion
-export { ReactAsyncRateLimiter, useAsyncRateLimiter };
+export { PreactAsyncRateLimiter, useAsyncRateLimiter };
 //# sourceMappingURL=useAsyncRateLimiter.d.ts.map