@tanstack/solid-pacer 0.21.1 → 0.23.0

package/src/async-rate-limiter/createAsyncRateLimiter.ts

@@ -1,269 +0,0 @@
-import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'
-import { createEffect, onCleanup } from 'solid-js'
-import { shallow, useSelector } from '@tanstack/solid-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/solid-store'
-import type { Accessor, JSX } from 'solid-js'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-import type {
-  AsyncRateLimiterOptions,
-  AsyncRateLimiterState,
-} from '@tanstack/pacer/async-rate-limiter'
-
-export interface SolidAsyncRateLimiterOptions<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends AsyncRateLimiterOptions<TFn> {
-  /**
-   * Optional callback invoked when the owning component unmounts. Receives the rate limiter instance.
-   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.
-   */
-  onUnmount?: (rateLimiter: SolidAsyncRateLimiter<TFn, TSelected>) => void
-}
-
-export interface SolidAsyncRateLimiter<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
-  /**
-   * A Solid component that allows you to subscribe to the rate limiter state.
-   *
-   * This is useful for tracking specific parts of the rate limiter state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
-   *   {(state) => (
-   *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
-   *   )}
-   * </rateLimiter.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncRateLimiterState<TFn>) => TSelected
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element
-  }) => JSX.Element
-  /**
-   * Reactive state that will be updated when the rate limiter state changes
-   *
-   * Use this instead of `rateLimiter.store.state`
-   */
-  readonly state: Accessor<Readonly<TSelected>>
-  /**
-   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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<AsyncRateLimiterState<TFn>>>
-}
-
-/**
- * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
- *
- * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
- * you can integrate with any state management solution (createSignal, etc).
- *
- * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
- * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
- * all executions happen immediately, followed by a complete block.
- *
- * 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.
- *
- * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
- * instead of setting the result on a state variable from within the rate-limited function.
- *
- * For smoother execution patterns, consider using:
- * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
- * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
- *
- * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
- * smoothing out frequent events, throttling or debouncing usually provide better user experience.
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and rate limiter 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 AsyncRateLimiter instance
- * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `rateLimiter.Subscribe` component (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` component 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 reactive updates
- * at the hook level, optimizing performance by preventing unnecessary updates 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` component. This prevents unnecessary
- * updates and gives you full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `currentWindowStart`: Timestamp when the current window started
- * - `executionCount`: Number of function executions that have been completed
- * - `hasError`: Whether the last execution resulted in an error
- * - `isExecuting`: Whether an async function execution is currently in progress
- * - `lastError`: The error from the most recent failed execution (if any)
- * - `lastResult`: The result from the most recent successful execution
- * - `nextWindowTime`: Timestamp when the next window begins
- * - `rejectionCount`: Number of function calls that were rejected due to rate limiting
- * - `remainingInWindow`: Number of executions remaining in the current window
- *
- * ## Unmount behavior
- *
- * By default, the primitive aborts any in-flight execution when the owning 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.
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data; // Return value is preserved
- *   },
- *   { limit: 5, window: 1000 } // 5 calls per second
- * );
- *
- * // Subscribe to state changes deep in component tree using Subscribe component
- * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
- *   {(state) => (
- *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
- *   )}
- * </asyncRateLimiter.Subscribe>
- *
- * // Opt-in to track execution state changes at hook level (optimized for loading indicators)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ isExecuting: state.isExecuting })
- * );
- *
- * // Opt-in to track results when available (optimized for data display)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     lastResult: state.lastResult,
- *     successCount: state.successCount
- *   })
- * );
- *
- * // Opt-in to track error/rejection state changes (optimized for error handling)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   {
- *     limit: 5,
- *     window: 1000,
- *     onError: (error) => console.error('API call failed:', error),
- *     onReject: (rateLimiter) => console.log('Rate limit exceeded')
- *   },
- *   (state) => ({
- *     errorCount: state.errorCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to track execution metrics changes (optimized for stats display)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     successCount: state.successCount,
- *     errorCount: state.errorCount,
- *     settleCount: state.settleCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to track execution times changes (optimized for window calculations)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ executionTimes: state.executionTimes })
- * );
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();
- * ```
- */
-export function createAsyncRateLimiter<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
->(
-  fn: TFn,
-  options: SolidAsyncRateLimiterOptions<TFn, TSelected>,
-  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>
-    ({}) as TSelected,
-): SolidAsyncRateLimiter<TFn, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().asyncRateLimiter,
-    ...options,
-  } as SolidAsyncRateLimiterOptions<TFn, TSelected>
-  const asyncRateLimiter = new AsyncRateLimiter<TFn>(
-    fn,
-    mergedOptions,
-  ) as unknown as SolidAsyncRateLimiter<TFn, TSelected>
-
-  asyncRateLimiter.Subscribe = function Subscribe<TSelected>(props: {
-    selector: (state: AsyncRateLimiterState<TFn>) => TSelected
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element
-  }) {
-    const selected = useSelector(asyncRateLimiter.store, props.selector, {
-      compare: shallow,
-    })
-
-    return typeof props.children === 'function'
-      ? props.children(selected)
-      : props.children
-  }
-
-  const state = useSelector(asyncRateLimiter.store, selector, {
-    compare: shallow,
-  })
-
-  createEffect(() => {
-    onCleanup(() => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(asyncRateLimiter)
-      } else {
-        asyncRateLimiter.abort()
-      }
-    })
-  })
-
-  return {
-    ...asyncRateLimiter,
-    state,
-  } as SolidAsyncRateLimiter<TFn, TSelected>
-}

package/src/async-rate-limiter/index.ts

@@ -1,4 +0,0 @@
-// re-export everything from the core pacer package, BUT ONLY from the async-rate-limiter module
-export * from '@tanstack/pacer/async-rate-limiter'
-
-export * from './createAsyncRateLimiter'

package/src/async-throttler/createAsyncThrottler.ts

@@ -1,225 +0,0 @@
-import { createEffect, onCleanup } from 'solid-js'
-import { AsyncThrottler } from '@tanstack/pacer/async-throttler'
-import { shallow, useSelector } from '@tanstack/solid-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/solid-store'
-import type { Accessor, JSX } from 'solid-js'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-import type {
-  AsyncThrottlerOptions,
-  AsyncThrottlerState,
-} from '@tanstack/pacer/async-throttler'
-
-export interface SolidAsyncThrottlerOptions<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends AsyncThrottlerOptions<TFn> {
-  /**
-   * Optional callback invoked when the owning component unmounts. Receives the throttler instance.
-   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
-   */
-  onUnmount?: (throttler: SolidAsyncThrottler<TFn, TSelected>) => void
-}
-
-export interface SolidAsyncThrottler<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends Omit<AsyncThrottler<TFn>, 'store'> {
-  /**
-   * A Solid component that allows you to subscribe to the throttler state.
-   *
-   * This is useful for tracking 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, isExecuting: state.isExecuting })}>
-   *   {(state) => (
-   *     <div>{state().isPending ? 'Pending...' : state().isExecuting ? 'Executing...' : 'Ready'}</div>
-   *   )}
-   * </throttler.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncThrottlerState<TFn>) => TSelected
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element
-  }) => JSX.Element
-  /**
-   * Reactive state that will be updated when the throttler state changes
-   *
-   * Use this instead of `throttler.store.state`
-   */
-  readonly state: Accessor<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<AsyncThrottlerState<TFn>>>
-}
-
-/**
- * A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async 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 (createSignal, etc).
- *
- * Async throttling ensures an async 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 API calls,
- * database operations, or other async tasks.
- *
- * Unlike the non-async Throttler, this async version supports returning values from the throttled function,
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
- * instead of setting the result on a state variable from within the throttled function.
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler 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 `throttler.Subscribe` component (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` component 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 reactive updates
- * at the hook level, optimizing performance by preventing unnecessary updates 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` component. This prevents unnecessary
- * updates and gives you full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
- * - `executionCount`: Number of function executions that have been completed
- * - `hasError`: Whether the last execution resulted in an error
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `isExecuting`: Whether an async function execution is currently in progress
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastError`: The error from the most recent failed execution (if any)
- * - `lastExecutionTime`: Timestamp of the last execution
- * - `lastResult`: The result from the most recent successful execution
- * - `nextExecutionTime`: Timestamp of the next allowed execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing')
- *
- * ## Unmount behavior
- *
- * By default, the primitive cancels any pending execution and aborts any in-flight execution when the owning 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 throttler = createAsyncThrottler(fn, {
- *   wait: 1000,
- *   onUnmount: (t) => t.flush()
- * });
- * ```
- *
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
- * If your throttled function updates Solid signals, those updates may run after the component has
- * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
- * using onUnmount with flush.
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const { maybeExecute } = createAsyncThrottler(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { wait: 1000 }
- * );
- *
- * // Opt-in to track isPending or isExecuting changes (optimized for loading states)
- * const throttler = createAsyncThrottler(
- *   async (query) => {
- *     const result = await searchAPI(query);
- *     return result;
- *   },
- *   { wait: 2000 },
- *   (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })
- * );
- *
- * // Opt-in to track error state changes (optimized for error handling)
- * const throttler = createAsyncThrottler(
- *   async (query) => {
- *     const result = await searchAPI(query);
- *     return result;
- *   },
- *   {
- *     wait: 2000,
- *     leading: true,   // Execute immediately on first call
- *     trailing: false, // Skip trailing edge updates
- *     onError: (error) => {
- *       console.error('API call failed:', error);
- *     }
- *   },
- *   (state) => ({ hasError: state.hasError, lastError: state.lastError })
- * );
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { isPending, isExecuting } = throttler.state();
- * ```
- */
-export function createAsyncThrottler<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
->(
-  fn: TFn,
-  options: SolidAsyncThrottlerOptions<TFn, TSelected>,
-  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>
-    ({}) as TSelected,
-): SolidAsyncThrottler<TFn, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().asyncThrottler,
-    ...options,
-  } as SolidAsyncThrottlerOptions<TFn, TSelected>
-  const asyncThrottler = new AsyncThrottler(
-    fn,
-    mergedOptions,
-  ) as unknown as SolidAsyncThrottler<TFn, TSelected>
-
-  asyncThrottler.Subscribe = function Subscribe<TSelected>(props: {
-    selector: (state: AsyncThrottlerState<TFn>) => TSelected
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element
-  }) {
-    const selected = useSelector(asyncThrottler.store, props.selector, {
-      compare: shallow,
-    })
-
-    return typeof props.children === 'function'
-      ? props.children(selected)
-      : props.children
-  }
-
-  const state = useSelector(asyncThrottler.store, selector, {
-    compare: shallow,
-  })
-
-  createEffect(() => {
-    onCleanup(() => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(asyncThrottler)
-      } else {
-        asyncThrottler.cancel()
-        asyncThrottler.abort()
-      }
-    })
-  })
-
-  return {
-    ...asyncThrottler,
-    state,
-  } as SolidAsyncThrottler<TFn, TSelected>
-}

package/src/async-throttler/index.ts

@@ -1,4 +0,0 @@
-// re-export everything from the core pacer package, BUT ONLY from the async-throttler module
-export * from '@tanstack/pacer/async-throttler'
-
-export * from './createAsyncThrottler'