@tanstack/preact-pacer 0.23.0 → 0.24.0

package/src/throttler/useThrottledValue.ts

@@ -1,104 +0,0 @@
-import { useEffect } from 'preact/hooks'
-import { useThrottledState } from './useThrottledState'
-import type { Dispatch, StateUpdater } from 'preact/hooks'
-import type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'
-import type { ThrottlerState } from '@tanstack/pacer/throttler'
-
-/**
- * A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.
- * This hook uses Preact's useState internally to manage the throttled state.
- *
- * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
- * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
- *
- * The hook returns a tuple containing:
- * - The throttled value that updates according to the leading/trailing edge behavior specified in the options
- * - The throttler instance with control methods
- *
- * For more direct control over throttling behavior without Preact state management,
- * consider using the lower-level useThrottler hook instead.
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
- * The `selector` parameter allows you to specify which throttler state changes will trigger a re-render,
- * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
- * full control over when your component updates. Only when you provide a selector will the
- * component re-render when the selected state values change.
- *
- * Available throttler 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')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });
- *
- * // Opt-in to re-render when execution count changes (optimized for tracking executions)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     isPending: state.isPending,
- *     status: state.status
- *   })
- * );
- *
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     lastExecutionTime: state.lastExecutionTime,
- *     nextExecutionTime: state.nextExecutionTime
- *   })
- * );
- *
- * // With custom leading/trailing behavior
- * const [throttledValue, throttler] = useThrottledValue(rawValue, {
- *   wait: 1000,
- *   leading: true,   // Update immediately on first change
- *   trailing: false  // Skip trailing edge updates
- * });
- *
- * // Access the selected throttler state (will be empty object {} unless selector provided)
- * const { executionCount, isPending } = throttler.state;
- * ```
- */
-export function useThrottledValue<
-  TValue,
-  TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>,
->(
-  value: TValue,
-  options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,
-  selector?: (
-    state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,
-  ) => TSelected,
-): [TValue, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>] {
-  const [throttledValue, setThrottledValue, throttler] = useThrottledState(
-    value,
-    options,
-    selector,
-  )
-
-  useEffect(() => {
-    ;(setThrottledValue as (value: TValue) => void)(value)
-  }, [value, setThrottledValue])
-
-  return [throttledValue, throttler]
-}

package/src/throttler/useThrottler.ts

@@ -1,224 +0,0 @@
-import { useEffect, useMemo, useState } from 'preact/hooks'
-import { Throttler } from '@tanstack/pacer/throttler'
-import { shallow, useSelector } from '@tanstack/preact-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/preact-store'
-import type { AnyFunction } from '@tanstack/pacer/types'
-import type {
-  ThrottlerOptions,
-  ThrottlerState,
-} from '@tanstack/pacer/throttler'
-import type { ComponentChildren } from 'preact'
-
-export 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
-}
-
-export 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;
- * ```
- */
-export function useThrottler<TFn extends AnyFunction, TSelected = {}>(
-  fn: TFn,
-  options: PreactThrottlerOptions<TFn, TSelected>,
-  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,
-): PreactThrottler<TFn, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().throttler,
-    ...options,
-  } as PreactThrottlerOptions<TFn, TSelected>
-  const [throttler] = useState(() => {
-    const throttlerInstance = new Throttler<TFn>(
-      fn,
-      mergedOptions,
-    ) as unknown as PreactThrottler<TFn, TSelected>
-
-    throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {
-      selector: (state: ThrottlerState<TFn>) => TSelected
-      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-    }) {
-      const selected = useSelector(throttlerInstance.store, props.selector, {
-        compare: shallow,
-      })
-
-      return typeof props.children === 'function'
-        ? props.children(selected)
-        : props.children
-    }
-
-    return throttlerInstance
-  })
-
-  throttler.fn = fn
-  throttler.setOptions(mergedOptions)
-
-  const state = useSelector(throttler.store, selector, { compare: shallow })
-
-  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
-  useEffect(() => {
-    return () => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(throttler)
-      } else {
-        throttler.cancel()
-      }
-    }
-  }, [])
-  /* eslint-enable react-hooks/exhaustive-deps */
-
-  return useMemo(
-    () =>
-      ({
-        ...throttler,
-        state,
-      }) as PreactThrottler<TFn, TSelected>, // omit `store` in favor of `state`
-    [throttler, state],
-  )
-}

package/src/types/index.ts

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

package/src/utils/index.ts

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