@tanstack/preact-pacer 0.18.0 → 0.19.0

package/dist/batcher/useBatcher.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_batcher = require("@tanstack/pacer/batcher");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
 
 //#region src/batcher/useBatcher.ts
 /**
@@ -18,14 +18,24 @@ let __tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
 *
 * ## 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 `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
+*
+* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+* in child components.
+*
+* **2. Using the `selector` parameter (For hook-level subscriptions)**
+*
+* The `selector` parameter allows you to specify which state changes will trigger a re-render
+* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+* state changes occur.
 *
 * **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function. 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:
 * - `executionCount`: Number of batch executions that have been completed
@@ -45,7 +55,14 @@ let __tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
 *   { maxSize: 5, wait: 2000 }
 * );
 *
-* // Opt-in to re-render when batch size changes (optimized for displaying queue size)
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Batch Size: {size}</div>
+*   )}
+* </batcher.Subscribe>
+*
+* // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
 * const batcher = useBatcher<number>(
 *   (items) => console.log('Processing batch:', items),
 *   { maxSize: 5, wait: 2000 },
@@ -107,10 +124,17 @@ function useBatcher(fn, options = {}, selector = () => ({})) {
 		...require_PacerProvider.useDefaultPacerOptions().batcher,
 		...options
 	};
-	const [batcher] = (0, preact_hooks.useState)(() => new __tanstack_pacer_batcher.Batcher(fn, mergedOptions));
+	const [batcher] = (0, preact_hooks.useState)(() => {
+		const batcherInstance = new _tanstack_pacer_batcher.Batcher(fn, mergedOptions);
+		batcherInstance.Subscribe = function Subscribe(props) {
+			const selected = (0, _tanstack_preact_store.useStore)(batcherInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return batcherInstance;
+	});
 	batcher.fn = fn;
 	batcher.setOptions(mergedOptions);
-	const state = (0, __tanstack_preact_store.useStore)(batcher.store, selector);
+	const state = (0, _tanstack_preact_store.useStore)(batcher.store, selector);
 	return (0, preact_hooks.useMemo)(() => ({
 		...batcher,
 		state

package/dist/batcher/useBatcher.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useBatcher.cjs","names":["useDefaultPacerOptions","Batcher"],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated and re-rendered when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. 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 * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Opt-in to re-render when batch size changes (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     isRunning: state.isRunning,\n *     status: state.status\n *   })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n *     getShouldExecute: (items) => items.length >= 3\n *   }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop();  // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const [batcher] = useState(() => new Batcher<TValue>(fn, mergedOptions))\n\n  batcher.fn = fn\n  batcher.setOptions(mergedOptions)\n\n  const state = useStore(batcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...batcher,\n        state,\n      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [batcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2HA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,4CAA0B,IAAIC,iCAAgB,IAAI,cAAc,CAAC;AAExE,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,8CAAiB,QAAQ,OAAO,SAAS;AAE/C,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}
+{"version":3,"file":"useBatcher.cjs","names":["useDefaultPacerOptions","Batcher"],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the batcher state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Batch Size: {size}</div>\n   *   )}\n   * </batcher.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: BatcherState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Batch Size: {size}</div>\n *   )}\n * </batcher.Subscribe>\n *\n * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     isRunning: state.isRunning,\n *     status: state.status\n *   })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n *     getShouldExecute: (items) => items.length >= 3\n *   }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop();  // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const [batcher] = useState(() => {\n    const batcherInstance = new Batcher<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactBatcher<TValue, TSelected>\n\n    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: BatcherState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(batcherInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return batcherInstance\n  })\n\n  batcher.fn = fn\n  batcher.setOptions(mergedOptions)\n\n  const state = useStore(batcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...batcher,\n        state,\n      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [batcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8JA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,4CAA0B;EAC/B,MAAM,kBAAkB,IAAIC,gCAC1B,IACA,cACD;AAED,kBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,gDAAoB,gBAAgB,OAAO,MAAM,SAAS;AAEhE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,6CAAiB,QAAQ,OAAO,SAAS;AAE/C,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}

package/dist/batcher/useBatcher.d.cts

@@ -1,8 +1,26 @@
 import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
 import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
 
 //#region src/batcher/useBatcher.d.ts
 interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the batcher state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Batch Size: {size}</div>
+   *   )}
+   * </batcher.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: BatcherState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the batcher state changes
    *
@@ -30,14 +48,24 @@ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 's
  *
  * ## 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 `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
+ *
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+ * in child components.
+ *
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
+ *
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+ * state changes occur.
  *
  * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. 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:
  * - `executionCount`: Number of batch executions that have been completed
@@ -57,7 +85,14 @@ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 's
  *   { maxSize: 5, wait: 2000 }
  * );
  *
- * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Batch Size: {size}</div>
+ *   )}
+ * </batcher.Subscribe>
+ *
+ * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
  * const batcher = useBatcher<number>(
  *   (items) => console.log('Processing batch:', items),
  *   { maxSize: 5, wait: 2000 },

package/dist/batcher/useBatcher.d.ts

@@ -1,8 +1,26 @@
+import { ComponentChildren } from "preact";
 import { Store } from "@tanstack/preact-store";
 import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
 
 //#region src/batcher/useBatcher.d.ts
 interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the batcher state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Batch Size: {size}</div>
+   *   )}
+   * </batcher.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: BatcherState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the batcher state changes
    *
@@ -30,14 +48,24 @@ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 's
  *
  * ## 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 `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
+ *
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+ * in child components.
+ *
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
+ *
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+ * state changes occur.
  *
  * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. 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:
  * - `executionCount`: Number of batch executions that have been completed
@@ -57,7 +85,14 @@ interface PreactBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 's
  *   { maxSize: 5, wait: 2000 }
  * );
  *
- * // Opt-in to re-render when batch size changes (optimized for displaying queue size)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Batch Size: {size}</div>
+ *   )}
+ * </batcher.Subscribe>
+ *
+ * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
  * const batcher = useBatcher<number>(
  *   (items) => console.log('Processing batch:', items),
  *   { maxSize: 5, wait: 2000 },

package/dist/batcher/useBatcher.js

@@ -18,14 +18,24 @@ import { Batcher } from "@tanstack/pacer/batcher";
 *
 * ## 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 `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
+*
+* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+* in child components.
+*
+* **2. Using the `selector` parameter (For hook-level subscriptions)**
+*
+* The `selector` parameter allows you to specify which state changes will trigger a re-render
+* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+* state changes occur.
 *
 * **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function. 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:
 * - `executionCount`: Number of batch executions that have been completed
@@ -45,7 +55,14 @@ import { Batcher } from "@tanstack/pacer/batcher";
 *   { maxSize: 5, wait: 2000 }
 * );
 *
-* // Opt-in to re-render when batch size changes (optimized for displaying queue size)
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Batch Size: {size}</div>
+*   )}
+* </batcher.Subscribe>
+*
+* // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
 * const batcher = useBatcher<number>(
 *   (items) => console.log('Processing batch:', items),
 *   { maxSize: 5, wait: 2000 },
@@ -107,7 +124,14 @@ function useBatcher(fn, options = {}, selector = () => ({})) {
 		...useDefaultPacerOptions().batcher,
 		...options
 	};
-	const [batcher] = useState(() => new Batcher(fn, mergedOptions));
+	const [batcher] = useState(() => {
+		const batcherInstance = new Batcher(fn, mergedOptions);
+		batcherInstance.Subscribe = function Subscribe(props) {
+			const selected = useStore(batcherInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return batcherInstance;
+	});
 	batcher.fn = fn;
 	batcher.setOptions(mergedOptions);
 	const state = useStore(batcher.store, selector);

package/dist/batcher/useBatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBatcher.js","names":[],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated and re-rendered when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. 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 * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Opt-in to re-render when batch size changes (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     isRunning: state.isRunning,\n *     status: state.status\n *   })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n *     getShouldExecute: (items) => items.length >= 3\n *   }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop();  // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const [batcher] = useState(() => new Batcher<TValue>(fn, mergedOptions))\n\n  batcher.fn = fn\n  batcher.setOptions(mergedOptions)\n\n  const state = useStore(batcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...batcher,\n        state,\n      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [batcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2HA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,WAAW,eAAe,IAAI,QAAgB,IAAI,cAAc,CAAC;AAExE,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,QAAQ,SAAS,QAAQ,OAAO,SAAS;AAE/C,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}
+{"version":3,"file":"useBatcher.js","names":[],"sources":["../../src/batcher/useBatcher.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the batcher state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Batch Size: {size}</div>\n   *   )}\n   * </batcher.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: BatcherState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<BatcherState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Batcher instance.\n *\n * This is a lower-level hook that provides direct access to the Batcher's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of batch executions that have been completed\n * - `isEmpty`: Whether the batcher has no items to process\n * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing\n * - `isRunning`: Whether the batcher is active and will process items automatically\n * - `items`: Array of items currently queued for batch processing\n * - `size`: Number of items currently in the batch queue\n * - `status`: Current processing status ('idle' | 'pending')\n * - `totalItemsProcessed`: Total number of items processed across all batches\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <batcher.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Batch Size: {size}</div>\n *   )}\n * </batcher.Subscribe>\n *\n * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     totalItemsProcessed: state.totalItemsProcessed\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     isRunning: state.isRunning,\n *     status: state.status\n *   })\n * );\n *\n * // Example with custom state management and batching\n * const [items, setItems] = useState([]);\n *\n * const batcher = useBatcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),\n *     getShouldExecute: (items) => items.length >= 3\n *   }\n * );\n *\n * // Add items to batch - they'll be processed when conditions are met\n * batcher.addItem(1);\n * batcher.addItem(2);\n * batcher.addItem(3); // Triggers batch processing\n *\n * // Control the batcher\n * batcher.stop();  // Pause batching\n * batcher.start(); // Resume batching\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isPending } = batcher.state;\n * ```\n */\nexport function useBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const [batcher] = useState(() => {\n    const batcherInstance = new Batcher<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactBatcher<TValue, TSelected>\n\n    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: BatcherState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(batcherInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return batcherInstance\n  })\n\n  batcher.fn = fn\n  batcher.setOptions(mergedOptions)\n\n  const state = useStore(batcher.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...batcher,\n        state,\n      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`\n    [batcher, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8JA,SAAgB,WACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC6B;CAClC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,WAAW,eAAe;EAC/B,MAAM,kBAAkB,IAAI,QAC1B,IACA,cACD;AAED,kBAAgB,YAAY,SAAS,UAAqB,OAGvD;GACD,MAAM,WAAW,SAAS,gBAAgB,OAAO,MAAM,SAAS;AAEhE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,SAAQ,KAAK;AACb,SAAQ,WAAW,cAAc;CAEjC,MAAM,QAAQ,SAAS,QAAQ,OAAO,SAAS;AAE/C,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,SAAS,MAAM,CACjB"}

package/dist/debouncer/index.cjs

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

package/dist/debouncer/useDebouncer.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_debouncer = require("@tanstack/pacer/debouncer");
+let _tanstack_preact_store = require("@tanstack/preact-store");
+let _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
 
 //#region src/debouncer/useDebouncer.ts
 /**
@@ -21,14 +21,24 @@ let __tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
 *
 * ## 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 `debouncer.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:
 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
@@ -45,7 +55,14 @@ let __tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
 *   { wait: 500 }
 * );
 *
-* // Opt-in to re-render when isPending changes (optimized for loading states)
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
+*   {({ isPending }) => (
+*     <div>{isPending ? 'Searching...' : 'Ready'}</div>
+*   )}
+* </searchDebouncer.Subscribe>
+*
+* // Opt-in to re-render when isPending changes at hook level (optimized for loading states)
 * const searchDebouncer = useDebouncer(
 *   (query: string) => fetchSearchResults(query),
 *   { wait: 500 },
@@ -84,7 +101,14 @@ function useDebouncer(fn, options, selector = () => ({})) {
 		...require_PacerProvider.useDefaultPacerOptions().debouncer,
 		...options
 	};
-	const [debouncer] = (0, preact_hooks.useState)(() => new __tanstack_pacer_debouncer.Debouncer(fn, mergedOptions));
+	const [debouncer] = (0, preact_hooks.useState)(() => {
+		const debouncerInstance = new _tanstack_pacer_debouncer.Debouncer(fn, mergedOptions);
+		debouncerInstance.Subscribe = function Subscribe(props) {
+			const selected = (0, _tanstack_preact_store.useStore)(debouncerInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return debouncerInstance;
+	});
 	debouncer.fn = fn;
 	debouncer.setOptions(mergedOptions);
 	(0, preact_hooks.useEffect)(() => {
@@ -92,7 +116,7 @@ function useDebouncer(fn, options, selector = () => ({})) {
 			debouncer.cancel();
 		};
 	}, [debouncer]);
-	const state = (0, __tanstack_preact_store.useStore)(debouncer.store, selector);
+	const state = (0, _tanstack_preact_store.useStore)(debouncer.store, selector);
 	return (0, preact_hooks.useMemo)(() => ({
 		...debouncer,
 		state

package/dist/debouncer/useDebouncer.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useDebouncer.cjs","names":["useDefaultPacerOptions","Debouncer"],"sources":["../../src/debouncer/useDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\nexport interface PreactDebouncer<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Debouncer<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<DebouncerState<TFn>>>\n}\n\n/**\n * A Preact hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.).\n *\n * This hook provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 * - `executionCount`: Number of function executions that have been completed\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 * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 }\n * );\n *\n * // Opt-in to re-render when isPending changes (optimized for loading states)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     status: state.status\n *   })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n *   searchDebouncer.maybeExecute(e.target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = searchDebouncer.state;\n * ```\n */\nexport function useDebouncer<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: DebouncerOptions<TFn>,\n  selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().debouncer,\n    ...options,\n  } as DebouncerOptions<TFn>\n\n  const [debouncer] = useState(() => new Debouncer(fn, mergedOptions))\n\n  debouncer.fn = fn\n  debouncer.setOptions(mergedOptions)\n\n  useEffect(() => {\n    return () => {\n      debouncer.cancel()\n    }\n  }, [debouncer])\n\n  const state = useStore(debouncer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...debouncer,\n        state,\n      }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n    [debouncer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwGA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,8CAA4B,IAAIC,qCAAU,IAAI,cAAc,CAAC;AAEpE,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;AAEnC,mCAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;CAEf,MAAM,8CAAiB,UAAU,OAAO,SAAS;AAEjD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}
+{"version":3,"file":"useDebouncer.cjs","names":["useDefaultPacerOptions","Debouncer"],"sources":["../../src/debouncer/useDebouncer.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactDebouncer<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the debouncer state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the debouncer state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {({ isPending }) => (\n   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </debouncer.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: DebouncerState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\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<DebouncerState<TFn>>>\n}\n\n/**\n * A Preact hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.).\n *\n * This hook provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 `debouncer.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 * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\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 * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {({ isPending }) => (\n *     <div>{isPending ? 'Searching...' : 'Ready'}</div>\n *   )}\n * </searchDebouncer.Subscribe>\n *\n * // Opt-in to re-render when isPending changes at hook level (optimized for loading states)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const searchDebouncer = useDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     status: state.status\n *   })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n *   searchDebouncer.maybeExecute(e.target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = searchDebouncer.state;\n * ```\n */\nexport function useDebouncer<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: DebouncerOptions<TFn>,\n  selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().debouncer,\n    ...options,\n  } as DebouncerOptions<TFn>\n\n  const [debouncer] = useState(() => {\n    const debouncerInstance = new Debouncer(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactDebouncer<TFn, TSelected>\n\n    debouncerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: DebouncerState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(debouncerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return debouncerInstance\n  })\n\n  debouncer.fn = fn\n  debouncer.setOptions(mergedOptions)\n\n  useEffect(() => {\n    return () => {\n      debouncer.cancel()\n    }\n  }, [debouncer])\n\n  const state = useStore(debouncer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...debouncer,\n        state,\n      }) as PreactDebouncer<TFn, TSelected>, // omit `store` in favor of `state`\n    [debouncer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2IA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,8CAA4B;EACjC,MAAM,oBAAoB,IAAIC,oCAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,gDAAoB,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;AAEnC,mCAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;CAEf,MAAM,6CAAiB,UAAU,OAAO,SAAS;AAEjD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}

package/dist/debouncer/useDebouncer.d.cts

@@ -1,9 +1,27 @@
 import { Store } from "@tanstack/preact-store";
+import { ComponentChildren } from "preact";
 import { AnyFunction } from "@tanstack/pacer/types";
 import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
 
 //#region src/debouncer/useDebouncer.d.ts
 interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the debouncer state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the debouncer state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <debouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
+   *   {({ isPending }) => (
+   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>
+   *   )}
+   * </debouncer.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: DebouncerState<TFn>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
   /**
    * Reactive state that will be updated and re-rendered when the debouncer state changes
    *
@@ -34,14 +52,24 @@ interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<
  *
  * ## 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 `debouncer.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:
  * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
@@ -58,7 +86,14 @@ interface PreactDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<
  *   { wait: 500 }
  * );
  *
- * // Opt-in to re-render when isPending changes (optimized for loading states)
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <searchDebouncer.Subscribe selector={(state) => ({ isPending: state.isPending })}>
+ *   {({ isPending }) => (
+ *     <div>{isPending ? 'Searching...' : 'Ready'}</div>
+ *   )}
+ * </searchDebouncer.Subscribe>
+ *
+ * // Opt-in to re-render when isPending changes at hook level (optimized for loading states)
  * const searchDebouncer = useDebouncer(
  *   (query: string) => fetchSearchResults(query),
  *   { wait: 500 },