@tanstack/preact-pacer 0.23.0 → 0.24.0

package/dist/throttler/useThrottler.d.cts

@@ -1,156 +0,0 @@
-import { Store } from "@tanstack/preact-store";
-import { ComponentChildren } from "preact";
-import { AnyFunction } from "@tanstack/pacer/types";
-import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
-//#region src/throttler/useThrottler.d.ts
-interface PreactThrottlerOptions<TFn extends AnyFunction, TSelected = {}> extends ThrottlerOptions<TFn> {
-  /**
-   * Optional callback invoked when the component unmounts. Receives the throttler instance.
-   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
-   */
-  onUnmount?: (throttler: PreactThrottler<TFn, TSelected>) => void;
-}
-interface PreactThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
-  /**
-   * A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.
-   *
-   * This is useful for opting into state re-renders for specific parts of the throttler state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
-   *   {({ isPending }) => (
-   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>
-   *   )}
-   * </throttler.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: ThrottlerState<TFn>) => TSelected;
-    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
-  }) => ComponentChildren;
-  /**
-   * Reactive state that will be updated and re-rendered when the throttler state changes
-   *
-   * Use this instead of `throttler.store.state`
-   */
-  readonly state: Readonly<TSelected>;
-  /**
-   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
-   * Although, you can make the state reactive by using the `useSelector` in your own usage.
-   */
-  readonly store: Store<Readonly<ThrottlerState<TFn>>>;
-}
-/**
- * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
- *
- * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
- * integrates directly with Preact's useState, see useThrottledState.
- *
- * Throttling ensures a function executes at most once within a specified time window,
- * regardless of how many times it is called. This is useful for rate-limiting
- * expensive operations or UI updates.
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `throttler.Subscribe` HOC (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
- * in child components.
- *
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
- *
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
- * state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
- * re-renders and gives you full control over when your component updates.
- *
- * Available state properties:
- * - `executionCount`: Number of function executions that have been completed
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * ## Unmount behavior
- *
- * By default, the hook cancels any pending execution when the component unmounts.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```tsx
- * const throttler = useThrottler(fn, {
- *   wait: 1000,
- *   onUnmount: (t) => t.flush()
- * });
- * ```
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [value, setValue] = useState(0);
- * const throttler = useThrottler(setValue, { wait: 1000 });
- *
- * // Subscribe to state changes deep in component tree using Subscribe HOC
- * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
- *   {({ isPending }) => (
- *     <div>{isPending ? 'Processing...' : 'Ready'}</div>
- *   )}
- * </throttler.Subscribe>
- *
- * // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)
- * const [value, setValue] = useState(0);
- * const throttler = useThrottler(
- *   setValue,
- *   { wait: 1000 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
- * const [value, setValue] = useState(0);
- * const throttler = useThrottler(
- *   setValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     isPending: state.isPending,
- *     status: state.status
- *   })
- * );
- *
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
- * const [value, setValue] = useState(0);
- * const throttler = useThrottler(
- *   setValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     lastExecutionTime: state.lastExecutionTime,
- *     nextExecutionTime: state.nextExecutionTime
- *   })
- * );
- *
- * // With any state manager
- * const throttler = useThrottler(
- *   (value) => stateManager.setState(value),
- *   {
- *     wait: 2000,
- *     leading: true,   // Execute immediately on first call
- *     trailing: false  // Skip trailing edge updates
- *   }
- * );
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { executionCount, isPending } = throttler.state;
- * ```
- */
-declare function useThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: PreactThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): PreactThrottler<TFn, TSelected>;
-//#endregion
-export { PreactThrottler, PreactThrottlerOptions, useThrottler };
-//# sourceMappingURL=useThrottler.d.cts.map

package/dist/throttler/useThrottler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useThrottler.js","names":[],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactThrottlerOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends ThrottlerOptions<TFn> {\n  /**\n   * Optional callback invoked when the component unmounts. Receives the throttler instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n   */\n  onUnmount?: (throttler: PreactThrottler<TFn, TSelected>) => void\n}\n\nexport interface PreactThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the throttler state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {({ isPending }) => (\n   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.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 `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Preact's useState, see useThrottledState.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\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 `throttler.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 function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Unmount behavior\n *\n * By default, the hook cancels any pending execution when the component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = useThrottler(fn, {\n *   wait: 1000,\n *   onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {({ isPending }) => (\n *     <div>{isPending ? 'Processing...' : 'Ready'}</div>\n *   )}\n * </throttler.Subscribe>\n *\n * // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // With any state manager\n * const throttler = useThrottler(\n *   (value) => stateManager.setState(value),\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: PreactThrottlerOptions<TFn, TSelected>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as PreactThrottlerOptions<TFn, TSelected>\n  const [throttler] = useState(() => {\n    const throttlerInstance = new Throttler<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactThrottler<TFn, TSelected>\n\n    throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: ThrottlerState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useSelector(throttlerInstance.store, props.selector, {\n        compare: shallow,\n      })\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return throttlerInstance\n  })\n\n  throttler.fn = fn\n  throttler.setOptions(mergedOptions)\n\n  const state = useSelector(throttler.store, selector, { compare: shallow })\n\n  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n  useEffect(() => {\n    return () => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(throttler)\n      } else {\n        throttler.cancel()\n      }\n    }\n  }, [])\n  /* eslint-enable react-hooks/exhaustive-deps */\n\n  return useMemo(\n    () =>\n      ({\n        ...throttler,\n        state,\n      }) as PreactThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n    [throttler, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuKA,SAAgB,aACd,IACA,SACA,kBAA6D,CAAC,IAC7B;CACjC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,CAAC,aAAa,eAAe;EACjC,MAAM,oBAAoB,IAAI,UAC5B,IACA,aACF;EAEA,kBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,YAAY,kBAAkB,OAAO,MAAM,UAAU,EACpE,SAAS,QACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,UAAU,KAAK;CACf,UAAU,WAAW,aAAa;CAElC,MAAM,QAAQ,YAAY,UAAU,OAAO,UAAU,EAAE,SAAS,QAAQ,CAAC;CAGzE,gBAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,SAAS;QAEjC,UAAU,OAAO;EAErB;CACF,GAAG,CAAC,CAAC;CAGL,OAAO,eAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,WAAW,KAAK,CACnB;AACF"}

package/dist/types/index.cjs

@@ -1,8 +0,0 @@
-
-var _tanstack_pacer_types = require("@tanstack/pacer/types");
-Object.keys(_tanstack_pacer_types).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_types[k]; }
-  });
-});

package/dist/types/index.d.cts

@@ -1 +0,0 @@
-export * from "@tanstack/pacer/types";

package/dist/utils/index.cjs

@@ -1,8 +0,0 @@
-
-var _tanstack_pacer_utils = require("@tanstack/pacer/utils");
-Object.keys(_tanstack_pacer_utils).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_utils[k]; }
-  });
-});

package/dist/utils/index.d.cts

@@ -1 +0,0 @@
-export * from "@tanstack/pacer/utils";

package/src/async-batcher/index.ts

@@ -1,4 +0,0 @@
-export * from '@tanstack/pacer/async-batcher'
-
-export * from './useAsyncBatcher'
-export * from './useAsyncBatchedCallback'

package/src/async-batcher/useAsyncBatchedCallback.ts

@@ -1,53 +0,0 @@
-import { useCallback } from 'preact/hooks'
-import { useAsyncBatcher } from './useAsyncBatcher'
-import type { PreactAsyncBatcherOptions } from './useAsyncBatcher'
-
-/**
- * A Preact hook that creates a batched version of an async callback function.
- * This hook is a convenient wrapper around the `useAsyncBatcher` hook,
- * providing a stable, batched async function reference for use in Preact components.
- *
- * The batched async function will collect individual calls into batches and execute them
- * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
- * The returned function always returns a promise that resolves with undefined (since the
- * batch function processes multiple items together).
- *
- * This hook provides a simpler API compared to `useAsyncBatcher`, making it ideal for basic
- * async batching needs. However, it does not expose the underlying AsyncBatcher instance.
- *
- * For advanced usage requiring features like:
- * - Manual batch execution
- * - Access to batch results and state
- * - Custom useCallback dependencies
- *
- * Consider using the `useAsyncBatcher` hook instead.
- *
- * @example
- * ```tsx
- * // Batch API requests
- * const batchApiCall = useAsyncBatchedCallback(async (requests: ApiRequest[]) => {
- *   const results = await Promise.all(requests.map(req => fetch(req.url)));
- *   return results.map(res => res.json());
- * }, {
- *   maxSize: 10,   // Process when 10 requests collected
- *   wait: 1000     // Or after 1 second
- * });
- *
- * // Use in event handlers
- * <button onClick={() => batchApiCall({ url: '/api/analytics', data: eventData })}>
- *   Track Event
- * </button>
- * ```
- */
-export function useAsyncBatchedCallback<TValue>(
-  fn: (items: Array<TValue>) => Promise<unknown>,
-  options: PreactAsyncBatcherOptions<TValue, {}>,
-): (item: TValue) => Promise<void> {
-  const asyncBatchedFn = useAsyncBatcher(fn, options).addItem
-  return useCallback(
-    async (item: TValue) => {
-      await asyncBatchedFn(item)
-    },
-    [asyncBatchedFn],
-  )
-}

package/src/async-batcher/useAsyncBatcher.ts

@@ -1,293 +0,0 @@
-import { useEffect, useMemo, useState } from 'preact/hooks'
-import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
-import { shallow, useSelector } from '@tanstack/preact-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/preact-store'
-import type {
-  AsyncBatcherOptions,
-  AsyncBatcherState,
-} from '@tanstack/pacer/async-batcher'
-import type { ComponentChildren } from 'preact'
-
-export interface PreactAsyncBatcherOptions<
-  TValue,
-  TSelected = {},
-> extends AsyncBatcherOptions<TValue> {
-  /**
-   * Optional callback invoked when the component unmounts. Receives the batcher instance.
-   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
-   */
-  onUnmount?: (batcher: PreactAsyncBatcher<TValue, TSelected>) => void
-}
-
-export interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<
-  AsyncBatcher<TValue>,
-  'store'
-> {
-  /**
-   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async batcher state.
-   *
-   * This is useful for opting into state re-renders for specific parts of the batcher state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
-   *   {({ size }) => (
-   *     <div>Batch Size: {size}</div>
-   *   )}
-   * </batcher.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncBatcherState<TValue>) => TSelected
-    children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-  }) => ComponentChildren
-  /**
-   * Reactive state that will be updated and re-rendered when the batcher state changes
-   *
-   * Use this instead of `batcher.store.state`
-   */
-  readonly state: Readonly<TSelected>
-  /**
-   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
-   * Although, you can make the state reactive by using the `useSelector` in your own usage.
-   */
-  readonly store: Store<Readonly<AsyncBatcherState<TValue>>>
-}
-
-/**
- * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
- *
- * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
- * - Handles promises and returns results from batch executions
- * - Provides error handling with configurable error behavior
- * - Tracks success, error, and settle counts separately
- * - Has state tracking for when batches are executing
- * - Returns the result of the batch function execution
- *
- * Features:
- * - Configurable batch size and wait time
- * - Custom batch processing logic via getShouldExecute
- * - Event callbacks for monitoring batch operations
- * - Error handling for failed batch operations
- * - Automatic or manual batch processing
- *
- * The batcher collects items and processes them in batches based on:
- * - Maximum batch size (number of items per batch)
- * - Time-based batching (process after X milliseconds)
- * - Custom batch processing logic via getShouldExecute
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and batcher instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncBatcher instance
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `batcher.Subscribe` HOC (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
- * in child components.
- *
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
- *
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
- * state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
- * re-renders and gives you full control over when your component updates.
- *
- * Available state properties:
- * - `errorCount`: Number of batch executions that have resulted in errors
- * - `failedItems`: Array of items that failed during batch processing
- * - `isEmpty`: Whether the batcher has no items to process
- * - `isExecuting`: Whether a batch is currently being processed asynchronously
- * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
- * - `isRunning`: Whether the batcher is active and will process items automatically
- * - `items`: Array of items currently queued for batch processing
- * - `lastResult`: The result from the most recent batch execution
- * - `settleCount`: Number of batch executions that have completed (success or error)
- * - `size`: Number of items currently in the batch queue
- * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
- * - `successCount`: Number of batch executions that have completed successfully
- * - `totalItemsProcessed`: Total number of items processed across all batches
- * - `totalItemsFailed`: Total number of items that have failed processing
- *
- * ## Unmount behavior
- *
- * By default, the hook cancels any pending batch and aborts any in-flight execution when the component unmounts.
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```tsx
- * const batcher = useAsyncBatcher(fn, {
- *   maxSize: 10,
- *   wait: 2000,
- *   onUnmount: (b) => b.flush()
- * });
- * ```
- *
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
- * If your batch function updates Preact state, those updates may run after the component has
- * unmounted, which can cause "setState on unmounted component" warnings. Guard your callbacks
- * accordingly when using onUnmount with flush.
- *
- * @example
- * ```tsx
- * // Basic async batcher for API requests - no reactive state subscriptions
- * const asyncBatcher = useAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   { maxSize: 10, wait: 2000 }
- * );
- *
- * // Subscribe to state changes deep in component tree using Subscribe HOC
- * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
- *   {({ size }) => (
- *     <div>Batch Size: {size}</div>
- *   )}
- * </asyncBatcher.Subscribe>
- *
- * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
- * const asyncBatcher = useAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   { maxSize: 10, wait: 2000 },
- *   (state) => ({
- *     isExecuting: state.isExecuting,
- *     isPending: state.isPending,
- *     status: state.status
- *   })
- * );
- *
- * // Opt-in to re-render when results are available (optimized for data display)
- * const asyncBatcher = useAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   { maxSize: 10, wait: 2000 },
- *   (state) => ({
- *     lastResult: state.lastResult,
- *     successCount: state.successCount,
- *     totalItemsProcessed: state.totalItemsProcessed
- *   })
- * );
- *
- * // Opt-in to re-render when error state changes (optimized for error handling)
- * const asyncBatcher = useAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   {
- *     maxSize: 10,
- *     wait: 2000,
- *     onError: (error) => console.error('Batch processing failed:', error)
- *   },
- *   (state) => ({
- *     errorCount: state.errorCount,
- *     failedItems: state.failedItems,
- *     totalItemsFailed: state.totalItemsFailed
- *   })
- * );
- *
- * // Complete example with all callbacks
- * const asyncBatcher = useAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   {
- *     maxSize: 10,
- *     wait: 2000,
- *     onSuccess: (result) => {
- *       console.log('Batch processed successfully:', result);
- *     },
- *     onError: (error) => {
- *       console.error('Batch processing failed:', error);
- *     }
- *   }
- * );
- *
- * // Add items to batch
- * asyncBatcher.addItem(newItem);
- *
- * // Manually execute batch
- * const result = await asyncBatcher.execute();
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { isExecuting, lastResult, size } = asyncBatcher.state;
- * ```
- */
-export function useAsyncBatcher<TValue, TSelected = {}>(
-  fn: (items: Array<TValue>) => Promise<any>,
-  options: PreactAsyncBatcherOptions<TValue, TSelected> = {},
-  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>
-    ({}) as TSelected,
-): PreactAsyncBatcher<TValue, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().asyncBatcher,
-    ...options,
-  } as PreactAsyncBatcherOptions<TValue, TSelected>
-  const [asyncBatcher] = useState(() => {
-    const batcherInstance = new AsyncBatcher<TValue>(
-      fn,
-      mergedOptions,
-    ) as unknown as PreactAsyncBatcher<TValue, TSelected>
-
-    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {
-      selector: (state: AsyncBatcherState<TValue>) => TSelected
-      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-    }) {
-      const selected = useSelector(batcherInstance.store, props.selector, {
-        compare: shallow,
-      })
-
-      return typeof props.children === 'function'
-        ? props.children(selected)
-        : props.children
-    }
-
-    return batcherInstance
-  })
-
-  asyncBatcher.fn = fn
-  asyncBatcher.setOptions(mergedOptions)
-
-  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
-  useEffect(() => {
-    return () => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(asyncBatcher)
-      } else {
-        asyncBatcher.cancel()
-        asyncBatcher.abort()
-      }
-    }
-  }, [])
-  /* eslint-enable react-hooks/exhaustive-deps */
-
-  const state = useSelector(asyncBatcher.store, selector, { compare: shallow })
-
-  return useMemo(
-    () =>
-      ({
-        ...asyncBatcher,
-        state,
-      }) as PreactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`
-    [asyncBatcher, state],
-  )
-}

package/src/async-debouncer/index.ts

@@ -1,5 +0,0 @@
-// re-export everything from the core pacer package, BUT ONLY from the async-debouncer module
-export * from '@tanstack/pacer/async-debouncer'
-
-export * from './useAsyncDebouncer'
-export * from './useAsyncDebouncedCallback'

package/src/async-debouncer/useAsyncDebouncedCallback.ts

@@ -1,55 +0,0 @@
-import { useCallback } from 'preact/hooks'
-import { useAsyncDebouncer } from './useAsyncDebouncer'
-import type { PreactAsyncDebouncerOptions } from './useAsyncDebouncer'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-
-/**
- * A Preact hook that creates a debounced version of an async callback function.
- * This hook is a convenient wrapper around the `useAsyncDebouncer` hook,
- * providing a stable, debounced async function reference for use in Preact components.
- *
- * The debounced async function will only execute after the specified wait time has elapsed
- * since its last invocation. If called again before the wait time expires, the timer
- * resets and starts waiting again. The returned function always returns a promise. The call
- * that triggers an execution resolves or rejects with that execution's result; superseded
- * calls resolve with the most recent result (which may be `undefined` if nothing has executed
- * yet), and calls made while the debouncer is disabled resolve with `undefined`.
- *
- * This hook provides a simpler API compared to `useAsyncDebouncer`, making it ideal for basic
- * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution/error state
- * - Custom useCallback dependencies
- *
- * Consider using the `useAsyncDebouncer` hook instead.
- *
- *
- * @example
- * ```tsx
- * // Debounce an async search handler
- * const handleSearch = useAsyncDebouncedCallback(async (query: string) => {
- *   const results = await fetchSearchResults(query);
- *   return results;
- * }, {
- *   wait: 500 // Wait 500ms between executions
- * });
- *
- * // Use in an input
- * <input
- *   type="search"
- *   onChange={e => handleSearch(e.target.value)}
- * />
- * ```
- */
-export function useAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(
-  fn: TFn,
-  options: PreactAsyncDebouncerOptions<TFn, {}>,
-): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {
-  const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute
-  return useCallback(
-    (...args: Parameters<TFn>) => asyncDebouncedFn(...args),
-    [asyncDebouncedFn],
-  )
-}