@tanstack/solid-pacer 0.9.1 → 0.11.0

package/src/rate-limiter/createRateLimitedValue.ts

@@ -34,23 +34,53 @@ import type {
  * For more direct control over rate limiting behavior without Solid state management,
  * consider using the lower-level createRateLimiter 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 reactive updates,
+ * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
+ * the reactive system track the selected state values.
+ *
+ * Available rate limiter state properties:
+ * - `callsInWindow`: Number of calls made in the current window
+ * - `remainingInWindow`: Number of calls remaining in the current window
+ * - `windowStart`: Unix timestamp when the current window started
+ * - `nextWindowStart`: Unix timestamp when the next window will start
+ * - `msUntilNextWindow`: Milliseconds until the next window starts
+ * - `isAtLimit`: Whether the call limit for the current window has been reached
+ * - `status`: Current status ('disabled' | 'idle' | 'at-limit')
+ *
  * @example
  * ```tsx
- * // Basic rate limiting - update at most 5 times per minute with a sliding window
+ * // Default behavior - no reactive state subscriptions
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
  *   limit: 5,
  *   window: 60000,
  *   windowType: 'sliding'
  * });
  *
+ * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)
+ * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
+ *   rawValue,
+ *   { limit: 5, window: 60000 },
+ *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
+ * );
+ *
  * // Use the rate-limited value
  * console.log(rateLimitedValue()); // Access the current rate-limited value
  *
+ * // Access rate limiter state via signals
+ * console.log('Is at limit:', rateLimiter.state().isAtLimit);
+ *
  * // Control the rate limiter
  * rateLimiter.reset(); // Reset the rate limit window
  * ```
  */
-export function createRateLimitedValue<TValue, TSelected = RateLimiterState>(
+export function createRateLimitedValue<TValue, TSelected = {}>(
   value: Accessor<TValue>,
   initialOptions: RateLimiterOptions<Setter<TValue>>,
   selector?: (state: RateLimiterState) => TSelected,

package/src/rate-limiter/createRateLimiter.ts

@@ -1,5 +1,6 @@
 import { RateLimiter } from '@tanstack/pacer/rate-limiter'
 import { useStore } from '@tanstack/solid-store'
+import type { Store } from '@tanstack/solid-store'
 import type { Accessor } from 'solid-js'
 import type { AnyFunction } from '@tanstack/pacer/types'
 import type {
@@ -7,16 +8,20 @@ import type {
   RateLimiterState,
 } from '@tanstack/pacer/rate-limiter'
 
-export interface SolidRateLimiter<
-  TFn extends AnyFunction,
-  TSelected = RateLimiterState,
-> extends Omit<RateLimiter<TFn>, 'store'> {
+export interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}>
+  extends Omit<RateLimiter<TFn>, 'store'> {
   /**
    * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<RateLimiterState>>
 }
 
 /**
@@ -40,9 +45,27 @@ export interface SolidRateLimiter<
  * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
  * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
  *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
+ * unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **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 state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `rejectionCount`: Number of function calls that were rejected due to rate limiting
+ * - `remainingInWindow`: Number of executions remaining in the current window
+ * - `nextWindowTime`: Timestamp when the next window begins
+ * - `currentWindowStart`: Timestamp when the current window started
+ *
  * @example
  * ```tsx
- * // Basic rate limiting - max 5 calls per minute with a sliding window
+ * // Default behavior - no reactive state subscriptions
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
@@ -52,20 +75,34 @@ export interface SolidRateLimiter<
  *   }
  * });
  *
- * // Access rate limiter state via signals
- * console.log('Executions:', rateLimiter.executionCount());
- * console.log('Rejections:', rateLimiter.rejectionCount());
- * console.log('Remaining:', rateLimiter.remainingInWindow());
- * console.log('Next window in:', rateLimiter.msUntilNextWindow());
+ * // Opt-in to re-render when rate limit state changes (optimized for UI feedback)
+ * const rateLimiter = createRateLimiter(
+ *   apiCall,
+ *   { limit: 5, window: 60000 },
+ *   (state) => ({
+ *     remainingInWindow: state.remainingInWindow,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for tracking progress)
+ * const rateLimiter = createRateLimiter(
+ *   apiCall,
+ *   { limit: 5, window: 60000 },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     nextWindowTime: state.nextWindowTime
+ *   })
+ * );
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { remainingInWindow, rejectionCount } = rateLimiter.state();
  * ```
  */
-export function createRateLimiter<
-  TFn extends AnyFunction,
-  TSelected = RateLimiterState,
->(
+export function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(
   fn: TFn,
   initialOptions: RateLimiterOptions<TFn>,
-  selector?: (state: RateLimiterState) => TSelected,
+  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,
 ): SolidRateLimiter<TFn, TSelected> {
   const rateLimiter = new RateLimiter<TFn>(fn, initialOptions)
 
@@ -74,5 +111,5 @@ export function createRateLimiter<
   return {
     ...rateLimiter,
     state,
-  } as unknown as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`
+  } as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`
 }

package/src/throttler/createThrottledSignal.ts

@@ -22,11 +22,39 @@ import type {
  * For more direct control over throttling without state management,
  * consider using the lower-level createThrottler 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 reactive updates,
+ * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
+ * the reactive system track the selected state values.
+ *
+ * Available throttler 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
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastExecutionTime`: Unix timestamp of the last execution
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
  * @example
  * ```tsx
- * // Basic throttling - update state at most once per second
+ * // Default behavior - no reactive state subscriptions
  * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });
  *
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
+ * const [value, setValue, throttler] = createThrottledSignal(
+ *   0,
+ *   { wait: 1000 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
  * // With custom leading/trailing behavior
  * const [value, setValue] = createThrottledSignal(0, {
  *   wait: 1000,
@@ -35,16 +63,13 @@ import type {
  * });
  *
  * // Access throttler state via signals
- * console.log('Executions:', throttler.executionCount());
- * console.log('Is pending:', throttler.isPending());
- * console.log('Last execution:', throttler.lastExecutionTime());
- * console.log('Next execution:', throttler.nextExecutionTime());
+ * console.log('Executions:', throttler.state().executionCount);
+ * console.log('Is pending:', throttler.state().isPending);
+ * console.log('Last execution:', throttler.state().lastExecutionTime);
+ * console.log('Next execution:', throttler.state().nextExecutionTime);
  * ```
  */
-export function createThrottledSignal<
-  TValue,
-  TSelected = ThrottlerState<Setter<TValue>>,
->(
+export function createThrottledSignal<TValue, TSelected = {}>(
   value: TValue,
   initialOptions: ThrottlerOptions<Setter<TValue>>,
   selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,

package/src/throttler/createThrottledValue.ts

@@ -23,22 +23,50 @@ import type {
  * For more direct control over throttling behavior without Solid state management,
  * consider using the lower-level createThrottler 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 reactive updates,
+ * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
+ * full control over when your component subscribes to state changes. Only when you provide a selector will
+ * the reactive system track the selected state values.
+ *
+ * Available throttler 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
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastExecutionTime`: Unix timestamp of the last execution
+ * - `nextExecutionTime`: Unix timestamp of the next allowed execution
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
  * @example
  * ```tsx
- * // Basic throttling - update at most once per second
+ * // Default behavior - no reactive state subscriptions
  * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });
  *
+ * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)
+ * const [throttledValue, throttler] = createThrottledValue(
+ *   rawValue,
+ *   { wait: 1000 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
  * // Use the throttled value
  * console.log(throttledValue()); // Access the current throttled value
  *
+ * // Access throttler state via signals
+ * console.log('Is pending:', throttler.state().isPending);
+ *
  * // Control the throttler
  * throttler.cancel(); // Cancel any pending updates
  * ```
  */
-export function createThrottledValue<
-  TValue,
-  TSelected = ThrottlerState<Setter<TValue>>,
->(
+export function createThrottledValue<TValue, TSelected = {}>(
   value: Accessor<TValue>,
   initialOptions: ThrottlerOptions<Setter<TValue>>,
   selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,

package/src/throttler/createThrottler.ts

@@ -1,6 +1,7 @@
 import { Throttler } from '@tanstack/pacer/throttler'
 import { createEffect, onCleanup } from 'solid-js'
 import { useStore } from '@tanstack/solid-store'
+import type { Store } from '@tanstack/solid-store'
 import type { Accessor } from 'solid-js'
 import type { AnyFunction } from '@tanstack/pacer/types'
 import type {
@@ -8,16 +9,20 @@ import type {
   ThrottlerState,
 } from '@tanstack/pacer/throttler'
 
-export interface SolidThrottler<
-  TFn extends AnyFunction,
-  TSelected = ThrottlerState<TFn>,
-> extends Omit<Throttler<TFn>, 'store'> {
+export interface SolidThrottler<TFn extends AnyFunction, TSelected = {}>
+  extends Omit<Throttler<TFn>, 'store'> {
   /**
    * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<ThrottlerState<TFn>>>
 }
 
 /**
@@ -31,36 +36,70 @@ export interface SolidThrottler<
  * 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. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, optimizing performance by preventing
+ * unnecessary re-renders when irrelevant state changes occur.
+ *
+ * **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 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
+ * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+ * - `lastArgs`: The arguments from the most recent call to maybeExecute
+ * - `lastExecutionTime`: Timestamp of the last execution
+ * - `nextExecutionTime`: Timestamp of the next allowed execution
+ * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+ *
  * @example
  * ```tsx
- * // Basic throttling with custom state
- * const [value, setValue] = createSignal(0);
+ * // Default behavior - no reactive state subscriptions
  * const throttler = createThrottler(setValue, { wait: 1000 });
  *
- * // With any state manager
+ * // Opt-in to re-render when isPending changes (optimized for loading states)
+ * const throttler = createThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({ isPending: state.isPending })
+ * );
+ *
+ * // Opt-in to re-render when executionCount changes (optimized for tracking execution)
+ * const throttler = createThrottler(
+ *   setValue,
+ *   { wait: 1000 },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Multiple state properties - re-render when any of these change
  * const throttler = createThrottler(
- *   (value) => stateManager.setState(value),
+ *   setValue,
  *   {
  *     wait: 2000,
  *     leading: true,   // Execute immediately on first call
  *     trailing: false  // Skip trailing edge updates
- *   }
+ *   },
+ *   (state) => ({
+ *     isPending: state.isPending,
+ *     executionCount: state.executionCount,
+ *     lastExecutionTime: state.lastExecutionTime,
+ *     nextExecutionTime: state.nextExecutionTime
+ *   })
  * );
  *
- * // Access throttler state via signals
- * console.log(throttler.executionCount()); // number of times executed
- * console.log(throttler.isPending());      // whether throttled function is pending
- * console.log(throttler.lastExecutionTime()); // timestamp of last execution
- * console.log(throttler.nextExecutionTime()); // timestamp of next allowed execution
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isPending, executionCount } = throttler.state();
  * ```
  */
-export function createThrottler<
-  TFn extends AnyFunction,
-  TSelected = ThrottlerState<TFn>,
->(
+export function createThrottler<TFn extends AnyFunction, TSelected = {}>(
   fn: TFn,
   initialOptions: ThrottlerOptions<TFn>,
-  selector?: (state: ThrottlerState<TFn>) => TSelected,
+  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,
 ): SolidThrottler<TFn, TSelected> {
   const asyncThrottler = new Throttler<TFn>(fn, initialOptions)