@tanstack/preact-pacer 0.0.1 → 0.19.0

package/src/queuer/useQueuedValue.ts

@@ -0,0 +1,129 @@
+import { useEffect, useState } from 'preact/hooks'
+import { useQueuedState } from './useQueuedState'
+import type { PreactQueuer } from './useQueuer'
+import type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
+
+/**
+ * A Preact hook that creates a queued value that processes state changes in order with an optional delay.
+ * This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially.
+ *
+ * The queued value will process changes in the order they are received, with optional delays between
+ * processing each change. This is useful for handling state updates that need to be processed
+ * in a specific order, like animations or sequential UI updates.
+ *
+ * The hook returns a tuple containing:
+ * - The current queued value
+ * - The queuer instance with control methods
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying queuer instance.
+ * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
+ * optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available queuer state properties:
+ * - `executionCount`: Number of items that have been processed by the queuer
+ * - `expirationCount`: Number of items that have been removed due to expiration
+ * - `isEmpty`: Whether the queuer has no items to process
+ * - `isFull`: Whether the queuer has reached its maximum capacity
+ * - `isIdle`: Whether the queuer is not currently processing any items
+ * - `isRunning`: Whether the queuer is active and will process items automatically
+ * - `items`: Array of items currently waiting to be processed
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+ * - `rejectionCount`: Number of items that have been rejected from being added
+ * - `size`: Number of items currently in the queue
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [value, queuer] = useQueuedValue(initialValue, {
+ *   wait: 500, // Wait 500ms between processing each change
+ *   started: true // Start processing immediately
+ * });
+ *
+ * // Opt-in to re-render when queue processing state changes (optimized for loading indicators)
+ * const [value, queuer] = useQueuedValue(
+ *   initialValue,
+ *   { wait: 500, started: true },
+ *   (state) => ({
+ *     isRunning: state.isRunning,
+ *     isIdle: state.isIdle,
+ *     status: state.status,
+ *     pendingTick: state.pendingTick
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when queue contents change (optimized for displaying queue status)
+ * const [value, queuer] = useQueuedValue(
+ *   initialValue,
+ *   { wait: 500, started: true },
+ *   (state) => ({
+ *     size: state.size,
+ *     isEmpty: state.isEmpty,
+ *     isFull: state.isFull
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
+ * const [value, queuer] = useQueuedValue(
+ *   initialValue,
+ *   { wait: 500, started: true },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     expirationCount: state.expirationCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Add changes to the queue
+ * const handleChange = (newValue) => {
+ *   queuer.addItem(newValue);
+ * };
+ *
+ * // Control the queue
+ * const pauseProcessing = () => {
+ *   queuer.stop();
+ * };
+ *
+ * const resumeProcessing = () => {
+ *   queuer.start();
+ * };
+ *
+ * // Access the selected queuer state (will be empty object {} unless selector provided)
+ * const { size, isRunning, executionCount } = queuer.state;
+ * ```
+ */
+export function useQueuedValue<
+  TValue,
+  TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<
+    QueuerState<TValue>,
+    'items'
+  >,
+>(
+  initialValue: TValue,
+  options: QueuerOptions<TValue> = {},
+  selector?: (state: QueuerState<TValue>) => TSelected,
+): [TValue, PreactQueuer<TValue, TSelected>] {
+  const [value, setValue] = useState<TValue>(initialValue)
+
+  const [, addItem, queuer] = useQueuedState(
+    (item) => {
+      setValue(item)
+    },
+    options,
+    selector,
+  )
+
+  useEffect(() => {
+    addItem(initialValue)
+  }, [initialValue, addItem])
+
+  return [value, queuer]
+}

package/src/queuer/useQueuer.ts

@@ -0,0 +1,213 @@
+import { useMemo, useState } from 'preact/hooks'
+import { Queuer } from '@tanstack/pacer/queuer'
+import { useStore } from '@tanstack/preact-store'
+import { useDefaultPacerOptions } from '../provider/PacerProvider'
+import type { Store } from '@tanstack/preact-store'
+import type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
+import type { ComponentChildren } from 'preact'
+
+export interface PreactQueuer<TValue, TSelected = {}> extends Omit<
+  Queuer<TValue>,
+  'store'
+> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the queuer state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the queuer state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Queue Size: {size}</div>
+   *   )}
+   * </queuer.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: QueuerState<TValue>) => TSelected
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren
+  }) => ComponentChildren
+  /**
+   * Reactive state that will be updated and re-rendered when the queuer state changes
+   *
+   * Use this instead of `queuer.store.state`
+   */
+  readonly state: Readonly<TSelected>
+  /**
+   * @deprecated Use `queuer.state` instead of `queuer.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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<QueuerState<TValue>>>
+}
+
+/**
+ * A Preact hook that creates and manages a Queuer instance.
+ *
+ * This is a lower-level hook that provides direct access to the Queuer's functionality without
+ * any built-in state management. This allows you to integrate it with any state management solution
+ * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
+ *
+ * For a hook with built-in state management, see useQueuedState.
+ *
+ * The Queuer extends the base Queue to add processing capabilities. Items are processed
+ * synchronously in order, with optional delays between processing each item. The queuer includes
+ * an internal tick mechanism that can be started and stopped, making it useful as a scheduler.
+ * When started, it will process one item per tick, with an optional wait time between ticks.
+ *
+ * By default uses FIFO (First In First Out) behavior, but can be configured for LIFO
+ * (Last In First Out) by specifying 'front' position when adding items.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**
+ *
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+ * in child components.
+ *
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
+ *
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+ * state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function 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 items that have been processed by the queuer
+ * - `expirationCount`: Number of items that have been removed due to expiration
+ * - `isEmpty`: Whether the queuer has no items to process
+ * - `isFull`: Whether the queuer has reached its maximum capacity
+ * - `isIdle`: Whether the queuer is not currently processing any items
+ * - `isRunning`: Whether the queuer is active and will process items automatically
+ * - `items`: Array of items currently waiting to be processed
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+ * - `rejectionCount`: Number of items that have been rejected from being added
+ * - `size`: Number of items currently in the queue
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 }
+ * );
+ *
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <queue.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Queue Size: {size}</div>
+ *   )}
+ * </queue.Subscribe>
+ *
+ * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     size: state.size,
+ *     isEmpty: state.isEmpty,
+ *     isFull: state.isFull
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     isRunning: state.isRunning,
+ *     isIdle: state.isIdle,
+ *     status: state.status,
+ *     pendingTick: state.pendingTick
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     expirationCount: state.expirationCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Example with custom state management and scheduling
+ * const [items, setItems] = useState([]);
+ *
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   {
+ *     started: true, // Start processing immediately
+ *     wait: 1000,    // Process one item every second
+ *     onItemsChange: (queue) => setItems(queue.peekAllItems()),
+ *     getPriority: (item) => item.priority // Process higher priority items first
+ *   }
+ * );
+ *
+ * // Add items to process - they'll be handled automatically
+ * queue.addItem('task1');
+ * queue.addItem('task2');
+ *
+ * // Control the scheduler
+ * queue.stop();  // Pause processing
+ * queue.start(); // Resume processing
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { size, isRunning, executionCount } = queue.state;
+ * ```
+ */
+export function useQueuer<TValue, TSelected = {}>(
+  fn: (item: TValue) => void,
+  options: QueuerOptions<TValue> = {},
+  selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,
+): PreactQueuer<TValue, TSelected> {
+  const mergedOptions = {
+    ...useDefaultPacerOptions().queuer,
+    ...options,
+  } as QueuerOptions<TValue>
+
+  const [queuer] = useState(() => {
+    const queuerInstance = new Queuer<TValue>(
+      fn,
+      mergedOptions,
+    ) as unknown as PreactQueuer<TValue, TSelected>
+
+    queuerInstance.Subscribe = function Subscribe<TSelected>(props: {
+      selector: (state: QueuerState<TValue>) => TSelected
+      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
+    }) {
+      const selected = useStore(queuerInstance.store, props.selector)
+
+      return typeof props.children === 'function'
+        ? props.children(selected)
+        : props.children
+    }
+
+    return queuerInstance
+  })
+
+  queuer.fn = fn
+  queuer.setOptions(mergedOptions)
+
+  const state = useStore(queuer.store, selector)
+
+  return useMemo(
+    () =>
+      ({
+        ...queuer,
+        state,
+      }) as PreactQueuer<TValue, TSelected>, // omit `store` in favor of `state`
+    [queuer, state],
+  )
+}

package/src/rate-limiter/index.ts

@@ -0,0 +1,6 @@
+export * from '@tanstack/pacer/rate-limiter'
+
+export * from './useRateLimitedCallback'
+export * from './useRateLimiter'
+export * from './useRateLimitedState'
+export * from './useRateLimitedValue'

package/src/rate-limiter/useRateLimitedCallback.ts

@@ -0,0 +1,68 @@
+import { useCallback } from 'preact/hooks'
+import { useRateLimiter } from './useRateLimiter'
+import type { AnyFunction } from '@tanstack/pacer/types'
+import type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'
+
+/**
+ * A Preact hook that creates a rate-limited version of a callback function.
+ * This hook is essentially a wrapper around the basic `rateLimiter` function
+ * that is exported from `@tanstack/pacer`,
+ * but optimized for Preact with reactive options and a stable function reference.
+ *
+ * Rate limiting is a simple "hard limit" approach - it allows all calls until the limit
+ * is reached, then blocks subsequent calls until the window resets. Unlike throttling
+ * or debouncing, it does not attempt to space out or intelligently collapse calls.
+ * This can lead to bursts of rapid executions followed by periods where all calls
+ * are blocked.
+ *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+ *   consistent rate of execution over time.
+ *
+ * For smoother execution patterns, consider:
+ * - useThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
+ * - useDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
+ *
+ * Rate limiting should primarily be used when you need to enforce strict limits,
+ * like API rate limits or other scenarios requiring hard caps on execution frequency.
+ *
+ * This hook provides a simpler API compared to `useRateLimiter`, making it ideal for basic
+ * rate limiting needs. However, it does not expose the underlying RateLimiter instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useRateLimiter` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Rate limit API calls to maximum 5 calls per minute with a sliding window
+ * const makeApiCall = useRateLimitedCallback(
+ *   (data: ApiData) => {
+ *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
+ *   },
+ *   {
+ *     limit: 5,
+ *     window: 60000, // 1 minute
+ *     windowType: 'sliding',
+ *     onReject: () => {
+ *       console.warn('API rate limit reached. Please wait before trying again.');
+ *     }
+ *   }
+ * );
+ * ```
+ */
+export function useRateLimitedCallback<TFn extends AnyFunction>(
+  fn: TFn,
+  options: RateLimiterOptions<TFn>,
+): (...args: Parameters<TFn>) => boolean {
+  const rateLimitedFn = useRateLimiter(fn, options).maybeExecute
+  return useCallback(
+    (...args: Parameters<TFn>) => rateLimitedFn(...args),
+    [rateLimitedFn],
+  )
+}

package/src/rate-limiter/useRateLimitedState.ts

@@ -0,0 +1,124 @@
+import { useState } from 'preact/hooks'
+import { useRateLimiter } from './useRateLimiter'
+import type { Dispatch, StateUpdater } from 'preact/hooks'
+import type { PreactRateLimiter } from './useRateLimiter'
+import type {
+  RateLimiterOptions,
+  RateLimiterState,
+} from '@tanstack/pacer/rate-limiter'
+
+/**
+ * A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+ * This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.
+ *
+ * Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
+ * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
+ * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
+ *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
+ * For smoother update patterns, consider:
+ * - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)
+ * - useDebouncedState: When you want to collapse rapid updates into a single update (e.g. search input)
+ *
+ * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.
+ *
+ * The hook returns a tuple containing:
+ * - The rate-limited state value
+ * - A rate-limited setter function that respects the configured limits
+ * - The rateLimiter instance for additional control
+ *
+ * For more direct control over rate limiting without state management,
+ * consider using the lower-level useRateLimiter hook instead.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.
+ * The `selector` parameter allows you to specify which rate limiter 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 rate limiter state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+ * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [value, setValue, rateLimiter] = useRateLimitedState(0, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding'
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // With rejection callback and fixed window
+ * const [value, setValue] = useRateLimitedState(0, {
+ *   limit: 3,
+ *   window: 5000,
+ *   windowType: 'fixed',
+ *   onReject: (rateLimiter) => {
+ *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+ *   }
+ * });
+ *
+ * // Access rateLimiter methods if needed
+ * const handleSubmit = () => {
+ *   const remaining = rateLimiter.getRemainingInWindow();
+ *   if (remaining > 0) {
+ *     setValue(newValue);
+ *   } else {
+ *     showRateLimitWarning();
+ *   }
+ * };
+ *
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+export function useRateLimitedState<TValue, TSelected = RateLimiterState>(
+  value: TValue,
+  options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>,
+  selector?: (state: RateLimiterState) => TSelected,
+): [
+  TValue,
+  Dispatch<StateUpdater<TValue>>,
+  PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>,
+] {
+  const [rateLimitedValue, setRateLimitedValue] = useState(value)
+  const rateLimiter = useRateLimiter(setRateLimitedValue, options, selector)
+  return [
+    rateLimitedValue,
+    rateLimiter.maybeExecute as Dispatch<StateUpdater<TValue>>,
+    rateLimiter,
+  ]
+}

package/src/rate-limiter/useRateLimitedValue.ts

@@ -0,0 +1,110 @@
+import { useEffect } from 'preact/hooks'
+import { useRateLimitedState } from './useRateLimitedState'
+import type { Dispatch, StateUpdater } from 'preact/hooks'
+import type { PreactRateLimiter } from './useRateLimiter'
+import type {
+  RateLimiterOptions,
+  RateLimiterState,
+} from '@tanstack/pacer/rate-limiter'
+
+/**
+ * A high-level Preact hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.
+ * This hook uses Preact's useState internally to manage the rate-limited state.
+ *
+ * Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
+ * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
+ * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
+ *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
+ * For smoother update patterns, consider:
+ * - useThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
+ * - useDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)
+ *
+ * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.
+ *
+ * The hook returns a tuple containing:
+ * - The rate-limited value that updates according to the configured rate limit
+ * - The rate limiter instance with control methods
+ *
+ * For more direct control over rate limiting behavior without Preact state management,
+ * consider using the lower-level useRateLimiter hook instead.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.
+ * The `selector` parameter allows you to specify which rate limiter 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 rate limiter state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+ * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding'
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+ * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+ *   rawValue,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+ * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+ *   rawValue,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+ *   rawValue,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // With rejection callback and fixed window
+ * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
+ *   limit: 3,
+ *   window: 5000,
+ *   windowType: 'fixed',
+ *   onReject: (rateLimiter) => {
+ *     console.log(`Update rejected. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+ *   }
+ * });
+ *
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+export function useRateLimitedValue<TValue, TSelected = RateLimiterState>(
+  value: TValue,
+  options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>,
+  selector?: (state: RateLimiterState) => TSelected,
+): [TValue, PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>] {
+  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =
+    useRateLimitedState(value, options, selector)
+
+  useEffect(() => {
+    ;(setRateLimitedValue as (value: TValue) => void)(value)
+  }, [value, setRateLimitedValue])
+
+  return [rateLimitedValue, rateLimiter]
+}