@tanstack/solid-pacer 0.16.0 → 0.16.1

package/dist/throttler/createThrottledValue.js

@@ -0,0 +1,74 @@
+import { createThrottledSignal } from "./createThrottledSignal.js";
+import { createEffect } from "solid-js";
+
+//#region src/throttler/createThrottledValue.ts
+/**
+* A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.
+* This hook uses Solid's createSignal 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:
+* - An accessor function that provides the throttled value
+* - The throttler instance with control methods
+*
+* The throttled value will update according to the leading/trailing edge behavior specified in the options.
+*
+* 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
+* // 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
+* ```
+*/
+function createThrottledValue(value, initialOptions, selector) {
+	const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(value(), initialOptions, selector);
+	createEffect(() => {
+		setThrottledValue(value());
+	});
+	return [throttledValue, throttler];
+}
+
+//#endregion
+export { createThrottledValue };
+//# sourceMappingURL=createThrottledValue.js.map

package/dist/throttler/createThrottledValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createThrottledValue.js","names":[],"sources":["../../src/throttler/createThrottledValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createThrottledSignal } from './createThrottledSignal'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\n/**\n * A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window.\n * This hook uses Solid's createSignal internally to manage the throttled state.\n *\n * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.\n * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the throttled value\n * - The throttler instance with control methods\n *\n * The throttled value will update according to the leading/trailing edge behavior specified in the options.\n *\n * For more direct control over throttling behavior without Solid state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant 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. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger trailing execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Unix timestamp of the last execution\n * - `nextExecutionTime`: Unix timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });\n *\n * // Opt-in to reactive updates when pending state changes (optimized for loading indicators)\n * const [throttledValue, throttler] = createThrottledValue(\n *   rawValue,\n *   { wait: 1000 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Use the throttled value\n * console.log(throttledValue()); // Access the current throttled value\n *\n * // Access throttler state via signals\n * console.log('Is pending:', throttler.state().isPending);\n *\n * // Control the throttler\n * throttler.cancel(); // Cancel any pending updates\n * ```\n */\nexport function createThrottledValue<TValue, TSelected = {}>(\n  value: Accessor<TValue>,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>] {\n  const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(\n    value(),\n    initialOptions,\n    selector,\n  )\n\n  createEffect(() => {\n    setThrottledValue(value() as any)\n  })\n\n  return [throttledValue, throttler]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,SAAgB,qBACd,OACA,gBACA,UAC+D;CAC/D,MAAM,CAAC,gBAAgB,mBAAmB,aAAa,sBACrD,OAAO,EACP,gBACA,SACD;AAED,oBAAmB;AACjB,oBAAkB,OAAO,CAAQ;GACjC;AAEF,QAAO,CAAC,gBAAgB,UAAU"}

package/dist/throttler/createThrottler.cjs

@@ -0,0 +1,97 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let solid_js = require("solid-js");
+let __tanstack_solid_store = require("@tanstack/solid-store");
+let __tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
+
+//#region src/throttler/createThrottler.ts
+/**
+* A low-level Solid 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 (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+* integrates directly with Solid's createSignal, see createThrottledSignal.
+*
+* 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. 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
+* // Default behavior - no reactive state subscriptions
+* const throttler = createThrottler(setValue, { wait: 1000 });
+*
+* // 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(
+*   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 the selected state (will be empty object {} unless selector provided)
+* const { isPending, executionCount } = throttler.state();
+* ```
+*/
+function createThrottler(fn, options, selector = () => ({})) {
+	const asyncThrottler = new __tanstack_pacer_throttler.Throttler(fn, {
+		...require_PacerProvider.useDefaultPacerOptions().throttler,
+		...options
+	});
+	const state = (0, __tanstack_solid_store.useStore)(asyncThrottler.store, selector);
+	(0, solid_js.createEffect)(() => {
+		(0, solid_js.onCleanup)(() => {
+			asyncThrottler.cancel();
+		});
+	});
+	return {
+		...asyncThrottler,
+		state
+	};
+}
+
+//#endregion
+exports.createThrottler = createThrottler;
+//# sourceMappingURL=createThrottler.cjs.map

package/dist/throttler/createThrottler.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createThrottler.cjs","names":["Throttler","useDefaultPacerOptions"],"sources":["../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface SolidThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Accessor<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 `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Solid 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 (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Solid's createSignal, see createThrottledSignal.\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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // Opt-in to re-render when isPending changes (optimized for loading states)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const throttler = createThrottler(\n *   setValue,\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending, executionCount } = throttler.state();\n * ```\n */\nexport function createThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): SolidThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const asyncThrottler = new Throttler<TFn>(fn, mergedOptions)\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  createEffect(() => {\n    onCleanup(() => {\n      asyncThrottler.cancel()\n    })\n  })\n\n  return {\n    ...asyncThrottler,\n    state,\n  } as SolidThrottler<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqGA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,iBAAiB,IAAIA,qCAAe,IALpB;EACpB,GAAGC,8CAAwB,CAAC;EAC5B,GAAG;EACJ,CAE2D;CAE5D,MAAM,6CAAiB,eAAe,OAAO,SAAS;AAEtD,kCAAmB;AACjB,gCAAgB;AACd,kBAAe,QAAQ;IACvB;GACF;AAEF,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/{cjs/throttler → throttler}/createThrottler.d.cts

@@ -1,20 +1,22 @@
-import { Throttler, ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyFunction } from '@tanstack/pacer/types';
-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>>>;
+import { Store } from "@tanstack/solid-store";
+import { Accessor } from "solid-js";
+import { AnyFunction } from "@tanstack/pacer/types";
+import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/createThrottler.d.ts
+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>>>;
 }
 /**
  * A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute.
@@ -87,4 +89,7 @@ export interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends
  * const { isPending, executionCount } = throttler.state();
  * ```
  */
-export declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+//#endregion
+export { SolidThrottler, createThrottler };
+//# sourceMappingURL=createThrottler.d.cts.map

package/dist/{esm/throttler → throttler}/createThrottler.d.ts

@@ -1,20 +1,22 @@
-import { Throttler, ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyFunction } from '@tanstack/pacer/types';
-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>>>;
+import { Accessor } from "solid-js";
+import { Store } from "@tanstack/solid-store";
+import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/throttler/createThrottler.d.ts
+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>>>;
 }
 /**
  * A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute.
@@ -87,4 +89,7 @@ export interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends
  * const { isPending, executionCount } = throttler.state();
  * ```
  */
-export declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+//#endregion
+export { SolidThrottler, createThrottler };
+//# sourceMappingURL=createThrottler.d.ts.map

package/dist/throttler/createThrottler.js

@@ -0,0 +1,97 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { createEffect, onCleanup } from "solid-js";
+import { useStore } from "@tanstack/solid-store";
+import { Throttler } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/createThrottler.ts
+/**
+* A low-level Solid 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 (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+* integrates directly with Solid's createSignal, see createThrottledSignal.
+*
+* 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. 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
+* // Default behavior - no reactive state subscriptions
+* const throttler = createThrottler(setValue, { wait: 1000 });
+*
+* // 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(
+*   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 the selected state (will be empty object {} unless selector provided)
+* const { isPending, executionCount } = throttler.state();
+* ```
+*/
+function createThrottler(fn, options, selector = () => ({})) {
+	const asyncThrottler = new Throttler(fn, {
+		...useDefaultPacerOptions().throttler,
+		...options
+	});
+	const state = useStore(asyncThrottler.store, selector);
+	createEffect(() => {
+		onCleanup(() => {
+			asyncThrottler.cancel();
+		});
+	});
+	return {
+		...asyncThrottler,
+		state
+	};
+}
+
+//#endregion
+export { createThrottler };
+//# sourceMappingURL=createThrottler.js.map

package/dist/throttler/createThrottler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createThrottler.js","names":[],"sources":["../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface SolidThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Accessor<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 `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Solid 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 (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Solid's createSignal, see createThrottledSignal.\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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // Opt-in to re-render when isPending changes (optimized for loading states)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const throttler = createThrottler(\n *   setValue,\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending, executionCount } = throttler.state();\n * ```\n */\nexport function createThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): SolidThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const asyncThrottler = new Throttler<TFn>(fn, mergedOptions)\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  createEffect(() => {\n    onCleanup(() => {\n      asyncThrottler.cancel()\n    })\n  })\n\n  return {\n    ...asyncThrottler,\n    state,\n  } as SolidThrottler<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqGA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,iBAAiB,IAAI,UAAe,IALpB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAE2D;CAE5D,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,oBAAmB;AACjB,kBAAgB;AACd,kBAAe,QAAQ;IACvB;GACF;AAEF,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/throttler/index.cjs

@@ -0,0 +1,14 @@
+const require_createThrottler = require('./createThrottler.cjs');
+const require_createThrottledSignal = require('./createThrottledSignal.cjs');
+const require_createThrottledValue = require('./createThrottledValue.cjs');
+
+exports.createThrottledSignal = require_createThrottledSignal.createThrottledSignal;
+exports.createThrottledValue = require_createThrottledValue.createThrottledValue;
+exports.createThrottler = require_createThrottler.createThrottler;
+var __tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
+Object.keys(__tanstack_pacer_throttler).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_throttler[k]; }
+  });
+});

package/dist/throttler/index.d.cts

@@ -0,0 +1,5 @@
+import { SolidThrottler, createThrottler } from "./createThrottler.cjs";
+import { createThrottledSignal } from "./createThrottledSignal.cjs";
+import { createThrottledValue } from "./createThrottledValue.cjs";
+export * from "@tanstack/pacer/throttler";
+export { SolidThrottler, createThrottledSignal, createThrottledValue, createThrottler };

package/dist/throttler/index.d.ts

@@ -0,0 +1,5 @@
+import { SolidThrottler, createThrottler } from "./createThrottler.js";
+import { createThrottledSignal } from "./createThrottledSignal.js";
+import { createThrottledValue } from "./createThrottledValue.js";
+export * from "@tanstack/pacer/throttler";
+export { SolidThrottler, createThrottledSignal, createThrottledValue, createThrottler };

package/dist/{esm/throttler → throttler}/index.js

@@ -1,10 +1,7 @@
-export * from "@tanstack/pacer/throttler";
+import { createThrottler } from "./createThrottler.js";
 import { createThrottledSignal } from "./createThrottledSignal.js";
 import { createThrottledValue } from "./createThrottledValue.js";
-import { createThrottler } from "./createThrottler.js";
-export {
-  createThrottledSignal,
-  createThrottledValue,
-  createThrottler
-};
-//# sourceMappingURL=index.js.map
+
+export * from "@tanstack/pacer/throttler"
+
+export { createThrottledSignal, createThrottledValue, createThrottler };

package/dist/types/index.cjs

@@ -0,0 +1,9 @@
+
+
+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

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

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/dist/utils/index.cjs

@@ -0,0 +1,9 @@
+
+
+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

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

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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