@tanstack/solid-pacer 0.2.0 → 0.4.0

package/dist/esm/rate-limiter/createRateLimitedValue.d.ts

@@ -9,43 +9,39 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  * 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:
  * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedValue: 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 both the rate-limited value and the underlying rateLimiter instance for additional control.
+ * The hook returns a tuple containing:
+ * - An accessor function that provides the rate-limited value
+ * - The rate limiter instance with control methods
  *
  * For more direct control over rate limiting behavior without Solid state management,
  * consider using the lower-level createRateLimiter hook instead.
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update at most 5 times per minute
- * const [rateLimitedValue] = createRateLimitedValue(rawValue, {
+ * // Basic rate limiting - update at most 5 times per minute with a sliding window
+ * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
- * // With rejection callback
- * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
- *   limit: 3,
- *   window: 5000,
- *   onReject: (rateLimiter) => {
- *     console.log(`Update rejected. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
- *   }
- * });
+ * // Use the rate-limited value
+ * console.log(rateLimitedValue()); // Access the current rate-limited value
  *
- * // Optionally access rateLimiter state via signals
- * const handleSubmit = () => {
- *   const remaining = rateLimiter.remainingInWindow();
- *   if (remaining > 0) {
- *     console.log(`${remaining} updates remaining in this window`);
- *   } else {
- *     console.log('Rate limit reached for this window');
- *   }
- * };
+ * // Control the rate limiter
+ * rateLimiter.reset(); // Reset the rate limit window
  * ```
  */
-export declare function createRateLimitedValue<TValue>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>, [Accessor<TValue>]>): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, [Accessor<TValue>]>];
+export declare function createRateLimitedValue<TValue>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>];

package/dist/esm/rate-limiter/createRateLimitedValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimitedValue.js","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns both the rate-limited value and the underlying rateLimiter instance for additional control.\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute\n * const [rateLimitedValue] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000\n * });\n *\n * // With rejection callback\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 3,\n *   window: 5000,\n *   onReject: (rateLimiter) => {\n *     console.log(`Update rejected. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Optionally access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.remainingInWindow();\n *   if (remaining > 0) {\n *     console.log(`${remaining} updates remaining in this window`);\n *   } else {\n *     console.log('Rate limit reached for this window');\n *   }\n * };\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>, [Accessor<TValue>]>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, [Accessor<TValue>]>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":[],"mappings":";;AAqDgB,SAAA,uBACd,OACA,gBAC0E;AACpE,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvD,wBAAwB,SAAS,cAAc;AAEjD,eAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;"}
+{"version":3,"file":"createRateLimitedValue.js","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute with a sliding window\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Use the rate-limited value\n * console.log(rateLimitedValue()); // Access the current rate-limited value\n *\n * // Control the rate limiter\n * rateLimiter.reset(); // Reset the rate limit window\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":[],"mappings":";;AAiDgB,SAAA,uBACd,OACA,gBACsD;AAChD,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvD,wBAAwB,SAAS,cAAc;AAEjD,eAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;"}

package/dist/esm/rate-limiter/createRateLimiter.d.ts

@@ -1,7 +1,7 @@
 import { RateLimiter, RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
 import { Accessor } from 'solid-js';
 import { AnyFunction } from '@tanstack/pacer/types';
-export interface SolidRateLimiter<TFn extends AnyFunction, TArgs extends Parameters<TFn>> extends Omit<RateLimiter<TFn, TArgs>, 'getExecutionCount' | 'getMsUntilNextWindow' | 'getRejectionCount' | 'getRemainingInWindow'> {
+export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimiter<TFn>, 'getExecutionCount' | 'getMsUntilNextWindow' | 'getRejectionCount' | 'getRemainingInWindow'> {
     executionCount: Accessor<number>;
     msUntilNextWindow: Accessor<number>;
     rejectionCount: Accessor<number>;
@@ -17,6 +17,12 @@ export interface SolidRateLimiter<TFn extends AnyFunction, TArgs extends Paramet
  * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
  * it does not attempt to space out or collapse executions intelligently.
  *
+ * 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:
  * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
  * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
@@ -24,10 +30,11 @@ export interface SolidRateLimiter<TFn extends AnyFunction, TArgs extends Paramet
  *
  * @example
  * ```tsx
- * // Basic rate limiting - max 5 calls per minute
+ * // Basic rate limiting - max 5 calls per minute with a sliding window
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Monitor rate limit status
@@ -46,4 +53,4 @@ export interface SolidRateLimiter<TFn extends AnyFunction, TArgs extends Paramet
  * console.log('Next window in:', rateLimiter.msUntilNextWindow());
  * ```
  */
-export declare function createRateLimiter<TFn extends AnyFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: RateLimiterOptions<TFn, TArgs>): SolidRateLimiter<TFn, TArgs>;
+export declare function createRateLimiter<TFn extends AnyFunction>(fn: TFn, initialOptions: RateLimiterOptions<TFn>): SolidRateLimiter<TFn>;

package/dist/esm/rate-limiter/createRateLimiter.js

@@ -2,7 +2,9 @@ import { RateLimiter } from "@tanstack/pacer/rate-limiter";
 import { createSignal } from "solid-js";
 import { bindInstanceMethods } from "@tanstack/pacer/utils";
 function createRateLimiter(fn, initialOptions) {
-  const rateLimiter = new RateLimiter(fn, initialOptions);
+  const rateLimiter = bindInstanceMethods(
+    new RateLimiter(fn, initialOptions)
+  );
   const [executionCount, setExecutionCount] = createSignal(
     rateLimiter.getExecutionCount()
   );
@@ -36,7 +38,7 @@ function createRateLimiter(fn, initialOptions) {
   }
   setOptions(initialOptions);
   return {
-    ...bindInstanceMethods(rateLimiter),
+    ...rateLimiter,
     executionCount,
     rejectionCount,
     remainingInWindow,

package/dist/esm/rate-limiter/createRateLimiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n> extends Omit<\n    RateLimiter<TFn, TArgs>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn, TArgs>,\n): SolidRateLimiter<TFn, TArgs> {\n  const rateLimiter = new RateLimiter<TFn, TArgs>(fn, initialOptions)\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn, TArgs>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(rateLimiter),\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  }\n}\n"],"names":["rateLimiter"],"mappings":";;;AA8DgB,SAAA,kBAId,IACA,gBAC8B;AAC9B,QAAM,cAAc,IAAI,YAAwB,IAAI,cAAc;AAE5D,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAAqD;AACvE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AACjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AACjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,WAAW;AAAA,IAClC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute with a sliding window\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter"],"mappings":";;;AAmEgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAM,cAAc;AAAA,IAClB,IAAI,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/dist/esm/throttler/createThrottledSignal.d.ts

@@ -35,8 +35,4 @@ import { ThrottlerOptions } from '@tanstack/pacer/throttler';
  * console.log('Next execution:', throttler.nextExecutionTime());
  * ```
  */
-export declare function createThrottledSignal<TValue>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>, [Accessor<TValue>]>): [
-    Accessor<TValue>,
-    Setter<TValue>,
-    SolidThrottler<Setter<TValue>, [Accessor<TValue>]>
-];
+export declare function createThrottledSignal<TValue>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>): [Accessor<TValue>, Setter<TValue>, SolidThrottler<Setter<TValue>>];

package/dist/esm/throttler/createThrottledSignal.js.map

@@ -1 +1 @@
-{"version":3,"file":"createThrottledSignal.js","sources":["../../../src/throttler/createThrottledSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createThrottler } from './createThrottler'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\n\n/**\n * A Solid hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value accessor\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * @example\n * ```tsx\n * // Basic throttling - update state at most once per second\n * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = createThrottledSignal(0, {\n *   wait: 1000,\n *   leading: true,   // Update immediately on first change\n *   trailing: false  // Skip trailing edge updates\n * });\n *\n * // Access throttler state via signals\n * console.log('Executions:', throttler.executionCount());\n * console.log('Is pending:', throttler.isPending());\n * console.log('Last execution:', throttler.lastExecutionTime());\n * console.log('Next execution:', throttler.nextExecutionTime());\n * ```\n */\nexport function createThrottledSignal<TValue>(\n  value: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>, [Accessor<TValue>]>,\n): [\n  Accessor<TValue>,\n  Setter<TValue>,\n  SolidThrottler<Setter<TValue>, [Accessor<TValue>]>,\n] {\n  const [throttledValue, setThrottledValue] = createSignal<TValue>(value)\n  const throttler = createThrottler(setThrottledValue, initialOptions)\n  return [throttledValue, throttler.maybeExecute as Setter<TValue>, throttler]\n}\n"],"names":[],"mappings":";;AAwCgB,SAAA,sBACd,OACA,gBAKA;AACA,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,aAAqB,KAAK;AAChE,QAAA,YAAY,gBAAgB,mBAAmB,cAAc;AACnE,SAAO,CAAC,gBAAgB,UAAU,cAAgC,SAAS;AAC7E;"}
+{"version":3,"file":"createThrottledSignal.js","sources":["../../../src/throttler/createThrottledSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createThrottler } from './createThrottler'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\n\n/**\n * A Solid hook that creates a throttled state value that updates at most once within a specified time window.\n * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.\n *\n * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.\n * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.\n *\n * The hook returns a tuple containing:\n * - The throttled state value accessor\n * - A throttled setter function that respects the configured wait time\n * - The throttler instance for additional control\n *\n * For more direct control over throttling without state management,\n * consider using the lower-level createThrottler hook instead.\n *\n * @example\n * ```tsx\n * // Basic throttling - update state at most once per second\n * const [value, setValue, throttler] = createThrottledSignal(0, { wait: 1000 });\n *\n * // With custom leading/trailing behavior\n * const [value, setValue] = createThrottledSignal(0, {\n *   wait: 1000,\n *   leading: true,   // Update immediately on first change\n *   trailing: false  // Skip trailing edge updates\n * });\n *\n * // Access throttler state via signals\n * console.log('Executions:', throttler.executionCount());\n * console.log('Is pending:', throttler.isPending());\n * console.log('Last execution:', throttler.lastExecutionTime());\n * console.log('Next execution:', throttler.nextExecutionTime());\n * ```\n */\nexport function createThrottledSignal<TValue>(\n  value: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n): [Accessor<TValue>, Setter<TValue>, SolidThrottler<Setter<TValue>>] {\n  const [throttledValue, setThrottledValue] = createSignal<TValue>(value)\n  const throttler = createThrottler(setThrottledValue, initialOptions)\n  return [throttledValue, throttler.maybeExecute as Setter<TValue>, throttler]\n}\n"],"names":[],"mappings":";;AAwCgB,SAAA,sBACd,OACA,gBACoE;AACpE,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,aAAqB,KAAK;AAChE,QAAA,YAAY,gBAAgB,mBAAmB,cAAc;AACnE,SAAO,CAAC,gBAAgB,UAAU,cAAgC,SAAS;AAC7E;"}

package/dist/esm/throttler/createThrottledValue.d.ts

@@ -8,7 +8,10 @@ import { ThrottlerOptions } from '@tanstack/pacer/throttler';
  * 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 both the throttled value and the underlying throttler instance for additional control.
+ * 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,
@@ -17,20 +20,13 @@ import { ThrottlerOptions } from '@tanstack/pacer/throttler';
  * @example
  * ```tsx
  * // Basic throttling - update at most once per second
- * const [throttledValue] = createThrottledValue(rawValue, { wait: 1000 });
+ * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });
  *
- * // With custom leading/trailing behavior
- * const [throttledValue, throttler] = createThrottledValue(rawValue, {
- *   wait: 1000,
- *   leading: true,   // Update immediately on first change
- *   trailing: false  // Skip trailing edge updates
- * });
+ * // Use the throttled value
+ * console.log(throttledValue()); // Access the current throttled value
  *
- * // 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());
+ * // Control the throttler
+ * throttler.cancel(); // Cancel any pending updates
  * ```
  */
-export declare function createThrottledValue<TValue>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>, [Accessor<TValue>]>): [Accessor<TValue>, SolidThrottler<Setter<TValue>, [Accessor<TValue>]>];
+export declare function createThrottledValue<TValue>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>): [Accessor<TValue>, SolidThrottler<Setter<TValue>>];

package/dist/esm/throttler/createThrottledValue.js

@@ -1,4 +1,4 @@
-import { createEffect, onCleanup } from "solid-js";
+import { createEffect } from "solid-js";
 import { createThrottledSignal } from "./createThrottledSignal.js";
 function createThrottledValue(value, initialOptions) {
   const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(
@@ -7,9 +7,6 @@ function createThrottledValue(value, initialOptions) {
   );
   createEffect(() => {
     setThrottledValue(value());
-    onCleanup(() => {
-      throttler.cancel();
-    });
   });
   return [throttledValue, throttler];
 }

package/dist/esm/throttler/createThrottledValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"createThrottledValue.js","sources":["../../../src/throttler/createThrottledValue.ts"],"sourcesContent":["import { createEffect, onCleanup } from 'solid-js'\nimport { createThrottledSignal } from './createThrottledSignal'\nimport type { SolidThrottler } from './createThrottler'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { ThrottlerOptions } 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 both the throttled value and the underlying throttler instance for additional control.\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 * @example\n * ```tsx\n * // Basic throttling - update at most once per second\n * const [throttledValue] = createThrottledValue(rawValue, { wait: 1000 });\n *\n * // With custom leading/trailing behavior\n * const [throttledValue, throttler] = createThrottledValue(rawValue, {\n *   wait: 1000,\n *   leading: true,   // Update immediately on first change\n *   trailing: false  // Skip trailing edge updates\n * });\n *\n * // Access throttler state via signals\n * console.log('Executions:', throttler.executionCount());\n * console.log('Is pending:', throttler.isPending());\n * console.log('Last execution:', throttler.lastExecutionTime());\n * console.log('Next execution:', throttler.nextExecutionTime());\n * ```\n */\nexport function createThrottledValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: ThrottlerOptions<Setter<TValue>, [Accessor<TValue>]>,\n): [Accessor<TValue>, SolidThrottler<Setter<TValue>, [Accessor<TValue>]>] {\n  const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(\n    value(),\n    initialOptions,\n  )\n\n  createEffect(() => {\n    setThrottledValue(value() as any)\n    onCleanup(() => {\n      throttler.cancel()\n    })\n  })\n\n  return [throttledValue, throttler]\n}\n"],"names":[],"mappings":";;AAsCgB,SAAA,qBACd,OACA,gBACwE;AACxE,QAAM,CAAC,gBAAgB,mBAAmB,SAAS,IAAI;AAAA,IACrD,MAAM;AAAA,IACN;AAAA,EACF;AAEA,eAAa,MAAM;AACjB,sBAAkB,OAAc;AAChC,cAAU,MAAM;AACd,gBAAU,OAAO;AAAA,IAAA,CAClB;AAAA,EAAA,CACF;AAEM,SAAA,CAAC,gBAAgB,SAAS;AACnC;"}
+{"version":3,"file":"createThrottledValue.js","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 { ThrottlerOptions } 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 * @example\n * ```tsx\n * // Basic throttling - update at most once per second\n * const [throttledValue, throttler] = createThrottledValue(rawValue, { wait: 1000 });\n *\n * // Use the throttled value\n * console.log(throttledValue()); // Access the current throttled value\n *\n * // Control the throttler\n * throttler.cancel(); // Cancel any pending updates\n * ```\n */\nexport function createThrottledValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidThrottler<Setter<TValue>>] {\n  const [throttledValue, setThrottledValue, throttler] = createThrottledSignal(\n    value(),\n    initialOptions,\n  )\n\n  createEffect(() => {\n    setThrottledValue(value() as any)\n  })\n\n  return [throttledValue, throttler]\n}\n"],"names":[],"mappings":";;AAkCgB,SAAA,qBACd,OACA,gBACoD;AACpD,QAAM,CAAC,gBAAgB,mBAAmB,SAAS,IAAI;AAAA,IACrD,MAAM;AAAA,IACN;AAAA,EACF;AAEA,eAAa,MAAM;AACjB,sBAAkB,OAAc;AAAA,EAAA,CACjC;AAEM,SAAA,CAAC,gBAAgB,SAAS;AACnC;"}

package/dist/esm/throttler/createThrottler.d.ts

@@ -4,7 +4,7 @@ import { AnyFunction } from '@tanstack/pacer/types';
 /**
  * An extension of the Throttler class that adds Solid signals to access the internal state of the throttler
  */
-export interface SolidThrottler<TFn extends AnyFunction, TArgs extends Parameters<TFn>> extends Omit<Throttler<TFn, TArgs>, 'getExecutionCount' | 'getIsPending' | 'getLastExecutionTime' | 'getNextExecutionTime'> {
+export interface SolidThrottler<TFn extends AnyFunction> extends Omit<Throttler<TFn>, 'getExecutionCount' | 'getIsPending' | 'getLastExecutionTime' | 'getNextExecutionTime'> {
     executionCount: Accessor<number>;
     isPending: Accessor<boolean>;
     lastExecutionTime: Accessor<number>;
@@ -44,4 +44,4 @@ export interface SolidThrottler<TFn extends AnyFunction, TArgs extends Parameter
  * console.log(throttler.nextExecutionTime()); // timestamp of next allowed execution
  * ```
  */
-export declare function createThrottler<TFn extends AnyFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: ThrottlerOptions<TFn, TArgs>): SolidThrottler<TFn, TArgs>;
+export declare function createThrottler<TFn extends AnyFunction>(fn: TFn, initialOptions: ThrottlerOptions<TFn>): SolidThrottler<TFn>;

package/dist/esm/throttler/createThrottler.js

@@ -1,8 +1,8 @@
 import { Throttler } from "@tanstack/pacer/throttler";
-import { createSignal } from "solid-js";
+import { createSignal, createEffect, onCleanup } from "solid-js";
 import { bindInstanceMethods } from "@tanstack/pacer/utils";
 function createThrottler(fn, initialOptions) {
-  const throttler = new Throttler(fn, initialOptions);
+  const throttler = bindInstanceMethods(new Throttler(fn, initialOptions));
   const [executionCount, setExecutionCount] = createSignal(
     throttler.getExecutionCount()
   );
@@ -27,8 +27,13 @@ function createThrottler(fn, initialOptions) {
     });
   }
   setOptions(initialOptions);
+  createEffect(() => {
+    onCleanup(() => {
+      throttler.cancel();
+    });
+  });
   return {
-    ...bindInstanceMethods(throttler),
+    ...throttler,
     executionCount,
     isPending,
     lastExecutionTime,

package/dist/esm/throttler/createThrottler.js.map

@@ -1 +1 @@
-{"version":3,"file":"createThrottler.js","sources":["../../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\n\n/**\n * An extension of the Throttler class that adds Solid signals to access the internal state of the throttler\n */\nexport interface SolidThrottler<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n> extends Omit<\n    Throttler<TFn, TArgs>,\n    | 'getExecutionCount'\n    | 'getIsPending'\n    | 'getLastExecutionTime'\n    | 'getNextExecutionTime'\n  > {\n  executionCount: Accessor<number>\n  isPending: Accessor<boolean>\n  lastExecutionTime: Accessor<number>\n  nextExecutionTime: Accessor<number>\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 * @example\n * ```tsx\n * // Basic throttling with custom state\n * const [value, setValue] = createSignal(0);\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // With any state manager\n * const throttler = createThrottler(\n *   (value) => stateManager.setState(value),\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n *\n * // Access throttler state via signals\n * console.log(throttler.executionCount()); // number of times executed\n * console.log(throttler.isPending());      // whether throttled function is pending\n * console.log(throttler.lastExecutionTime()); // timestamp of last execution\n * console.log(throttler.nextExecutionTime()); // timestamp of next allowed execution\n * ```\n */\nexport function createThrottler<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n>(\n  fn: TFn,\n  initialOptions: ThrottlerOptions<TFn, TArgs>,\n): SolidThrottler<TFn, TArgs> {\n  const throttler = new Throttler<TFn, TArgs>(fn, initialOptions)\n\n  const [executionCount, setExecutionCount] = createSignal(\n    throttler.getExecutionCount(),\n  )\n  const [isPending, setIsPending] = createSignal(throttler.getIsPending())\n  const [lastExecutionTime, setLastExecutionTime] = createSignal(\n    throttler.getLastExecutionTime(),\n  )\n  const [nextExecutionTime, setNextExecutionTime] = createSignal(\n    throttler.getNextExecutionTime(),\n  )\n\n  function setOptions(newOptions: Partial<ThrottlerOptions<TFn, TArgs>>) {\n    throttler.setOptions({\n      ...newOptions,\n      onExecute: (throttler) => {\n        setExecutionCount(throttler.getExecutionCount())\n        setIsPending(throttler.getIsPending())\n        setLastExecutionTime(throttler.getLastExecutionTime())\n        setNextExecutionTime(throttler.getNextExecutionTime())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(throttler)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(throttler),\n    executionCount,\n    isPending,\n    lastExecutionTime,\n    nextExecutionTime,\n    setOptions,\n  }\n}\n"],"names":["throttler"],"mappings":";;;AA4DgB,SAAA,gBAId,IACA,gBAC4B;AAC5B,QAAM,YAAY,IAAI,UAAsB,IAAI,cAAc;AAExD,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,UAAU,kBAAkB;AAAA,EAC9B;AACA,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,UAAU,cAAc;AACjE,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,UAAU,qBAAqB;AAAA,EACjC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,UAAU,qBAAqB;AAAA,EACjC;AAEA,WAAS,WAAW,YAAmD;AACrE,cAAU,WAAW;AAAA,MACnB,GAAG;AAAA,MACH,WAAW,CAACA,eAAc;AACNA,0BAAAA,WAAU,mBAAmB;AAClCA,qBAAAA,WAAU,cAAc;AAChBA,6BAAAA,WAAU,sBAAsB;AAChCA,6BAAAA,WAAU,sBAAsB;AAE/C,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MAAS;AAAA,IACvB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,SAAS;AAAA,IAChC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createThrottler.js","sources":["../../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createEffect, createSignal, onCleanup } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\n\n/**\n * An extension of the Throttler class that adds Solid signals to access the internal state of the throttler\n */\nexport interface SolidThrottler<TFn extends AnyFunction>\n  extends Omit<\n    Throttler<TFn>,\n    | 'getExecutionCount'\n    | 'getIsPending'\n    | 'getLastExecutionTime'\n    | 'getNextExecutionTime'\n  > {\n  executionCount: Accessor<number>\n  isPending: Accessor<boolean>\n  lastExecutionTime: Accessor<number>\n  nextExecutionTime: Accessor<number>\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 * @example\n * ```tsx\n * // Basic throttling with custom state\n * const [value, setValue] = createSignal(0);\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // With any state manager\n * const throttler = createThrottler(\n *   (value) => stateManager.setState(value),\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n *\n * // Access throttler state via signals\n * console.log(throttler.executionCount()); // number of times executed\n * console.log(throttler.isPending());      // whether throttled function is pending\n * console.log(throttler.lastExecutionTime()); // timestamp of last execution\n * console.log(throttler.nextExecutionTime()); // timestamp of next allowed execution\n * ```\n */\nexport function createThrottler<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: ThrottlerOptions<TFn>,\n): SolidThrottler<TFn> {\n  const throttler = bindInstanceMethods(new Throttler<TFn>(fn, initialOptions))\n\n  const [executionCount, setExecutionCount] = createSignal(\n    throttler.getExecutionCount(),\n  )\n  const [isPending, setIsPending] = createSignal(throttler.getIsPending())\n  const [lastExecutionTime, setLastExecutionTime] = createSignal(\n    throttler.getLastExecutionTime(),\n  )\n  const [nextExecutionTime, setNextExecutionTime] = createSignal(\n    throttler.getNextExecutionTime(),\n  )\n\n  function setOptions(newOptions: Partial<ThrottlerOptions<TFn>>) {\n    throttler.setOptions({\n      ...newOptions,\n      onExecute: (throttler) => {\n        setExecutionCount(throttler.getExecutionCount())\n        setIsPending(throttler.getIsPending())\n        setLastExecutionTime(throttler.getLastExecutionTime())\n        setNextExecutionTime(throttler.getNextExecutionTime())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(throttler)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  createEffect(() => {\n    onCleanup(() => {\n      throttler.cancel()\n    })\n  })\n\n  return {\n    ...throttler,\n    executionCount,\n    isPending,\n    lastExecutionTime,\n    nextExecutionTime,\n    setOptions,\n  } as SolidThrottler<TFn>\n}\n"],"names":["throttler"],"mappings":";;;AA0DgB,SAAA,gBACd,IACA,gBACqB;AACrB,QAAM,YAAY,oBAAoB,IAAI,UAAe,IAAI,cAAc,CAAC;AAEtE,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,UAAU,kBAAkB;AAAA,EAC9B;AACA,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,UAAU,cAAc;AACjE,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,UAAU,qBAAqB;AAAA,EACjC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,UAAU,qBAAqB;AAAA,EACjC;AAEA,WAAS,WAAW,YAA4C;AAC9D,cAAU,WAAW;AAAA,MACnB,GAAG;AAAA,MACH,WAAW,CAACA,eAAc;AACNA,0BAAAA,WAAU,mBAAmB;AAClCA,qBAAAA,WAAU,cAAc;AAChBA,6BAAAA,WAAU,sBAAsB;AAChCA,6BAAAA,WAAU,sBAAsB;AAE/C,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MAAS;AAAA,IACvB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAEzB,eAAa,MAAM;AACjB,cAAU,MAAM;AACd,gBAAU,OAAO;AAAA,IAAA,CAClB;AAAA,EAAA,CACF;AAEM,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -142,10 +142,10 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/pacer": "0.2.0"
+    "@tanstack/pacer": "0.4.0"
   },
   "devDependencies": {
-    "solid-js": "^1.9.5",
+    "solid-js": "^1.9.6",
     "vite-plugin-solid": "^2.11.6"
   },
   "peerDependencies": {

package/src/async-debouncer/createAsyncDebouncer.ts

@@ -5,15 +5,20 @@ import type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'
 import type { AnyAsyncFunction } from '@tanstack/pacer/types'
 import type { Accessor } from 'solid-js'
 
-export interface SolidAsyncDebouncer<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
-> extends Omit<
-    AsyncDebouncer<TFn, TArgs>,
-    'getExecutionCount' | 'getIsPending'
+export interface SolidAsyncDebouncer<TFn extends AnyAsyncFunction>
+  extends Omit<
+    AsyncDebouncer<TFn>,
+    | 'getErrorCount'
+    | 'getIsPending'
+    | 'getLastResult'
+    | 'getSettleCount'
+    | 'getSuccessCount'
   > {
-  executionCount: Accessor<number>
+  errorCount: Accessor<number>
   isPending: Accessor<boolean>
+  lastResult: Accessor<ReturnType<TFn> | undefined>
+  settleCount: Accessor<number>
+  successCount: Accessor<number>
 }
 
 /**
@@ -51,29 +56,37 @@ export interface SolidAsyncDebouncer<
  * ```
  */
 
-export function createAsyncDebouncer<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
->(
+export function createAsyncDebouncer<TFn extends AnyAsyncFunction>(
   fn: TFn,
-  initialOptions: AsyncDebouncerOptions<TFn, TArgs>,
-): SolidAsyncDebouncer<TFn, TArgs> {
-  const asyncDebouncer = new AsyncDebouncer<TFn, TArgs>(fn, initialOptions)
+  initialOptions: AsyncDebouncerOptions<TFn>,
+): SolidAsyncDebouncer<TFn> {
+  const asyncDebouncer = new AsyncDebouncer<TFn>(fn, initialOptions)
 
-  const [executionCount, setExecutionCount] = createSignal(
-    asyncDebouncer.getExecutionCount(),
+  const [errorCount, setErrorCount] = createSignal(
+    asyncDebouncer.getErrorCount(),
+  )
+  const [settleCount, setSettleCount] = createSignal(
+    asyncDebouncer.getSettleCount(),
+  )
+  const [successCount, setSuccessCount] = createSignal(
+    asyncDebouncer.getSuccessCount(),
   )
   const [isPending, setIsPending] = createSignal(asyncDebouncer.getIsPending())
+  const [lastResult, setLastResult] = createSignal(
+    asyncDebouncer.getLastResult(),
+  )
 
-  function setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn, TArgs>>) {
+  function setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn>>) {
     asyncDebouncer.setOptions({
       ...newOptions,
-      onExecute: (asyncDebouncer) => {
-        setExecutionCount(asyncDebouncer.getExecutionCount())
+      onSettled: (asyncDebouncer) => {
+        setSuccessCount(asyncDebouncer.getSuccessCount())
+        setErrorCount(asyncDebouncer.getErrorCount())
+        setSettleCount(asyncDebouncer.getSettleCount())
         setIsPending(asyncDebouncer.getIsPending())
-
-        const onExecute = newOptions.onExecute ?? initialOptions.onExecute
-        onExecute?.(asyncDebouncer)
+        setLastResult(asyncDebouncer.getLastResult())
+        const onSettled = newOptions.onSettled ?? initialOptions.onSettled
+        onSettled?.(asyncDebouncer)
       },
     })
   }
@@ -82,8 +95,11 @@ export function createAsyncDebouncer<
 
   return {
     ...bindInstanceMethods(asyncDebouncer),
-    executionCount,
+    errorCount,
     isPending,
+    lastResult,
+    settleCount,
+    successCount,
     setOptions,
-  }
+  } as SolidAsyncDebouncer<TFn>
 }

package/src/async-queuer/createAsyncQueuer.ts

@@ -49,11 +49,15 @@ export interface SolidAsyncQueuer<TValue>
   /**
    * Signal version of `getPeek`
    */
-  peek: Accessor<TValue | undefined>
+  peek: Accessor<(() => Promise<TValue>) | undefined>
   /**
    * Signal version of `getPendingItems`
    */
   pendingItems: Accessor<Array<() => Promise<TValue>>>
+  /**
+   * Signal version of `getRejectionCount`
+   */
+  rejectionCount: Accessor<number>
   /**
    * Signal version of `getSize`
    */
@@ -171,5 +175,5 @@ export function createAsyncQueuer<TValue>(
     pendingItems,
     rejectionCount,
     size,
-  }
+  } as SolidAsyncQueuer<TValue>
 }

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

@@ -5,17 +5,19 @@ import type { Accessor } from 'solid-js'
 import type { AnyAsyncFunction } from '@tanstack/pacer/types'
 import type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'
 
-export interface SolidAsyncRateLimiter<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
-> extends Omit<
-    AsyncRateLimiter<TFn, TArgs>,
-    | 'getExecutionCount'
+export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>
+  extends Omit<
+    AsyncRateLimiter<TFn>,
+    | 'getSuccessCount'
+    | 'getSettleCount'
+    | 'getErrorCount'
     | 'getRejectionCount'
     | 'getRemainingInWindow'
     | 'getMsUntilNextWindow'
   > {
-  executionCount: Accessor<number>
+  successCount: Accessor<number>
+  settleCount: Accessor<number>
+  errorCount: Accessor<number>
   rejectionCount: Accessor<number>
   remainingInWindow: Accessor<number>
   msUntilNextWindow: Accessor<number>
@@ -31,23 +33,34 @@ export interface SolidAsyncRateLimiter<
  * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
  * managing resource constraints, or controlling bursts of async operations.
  *
+ * 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.
+ *
+ * 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.
+ *
  * @example
  * ```tsx
- * // Basic API call rate limiting
+ * // Basic API call rate limiting with return value
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
- *     return data;
+ *     return data; // Return value is preserved
  *   },
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // With state management
+ * // With state management and return value
  * const [data, setData] = createSignal(null);
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (query) => {
  *     const result = await searchAPI(query);
  *     setData(result);
+ *     return result; // Return value can be used by the caller
  *   },
  *   {
  *     limit: 10,
@@ -57,21 +70,24 @@ export interface SolidAsyncRateLimiter<
  * );
  * ```
  */
-export function createAsyncRateLimiter<
-  TFn extends AnyAsyncFunction,
-  TArgs extends Parameters<TFn>,
->(
+export function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(
   fn: TFn,
-  initialOptions: AsyncRateLimiterOptions<TFn, TArgs>,
-): SolidAsyncRateLimiter<TFn, TArgs> {
-  const asyncRateLimiter = new AsyncRateLimiter<TFn, TArgs>(fn, initialOptions)
+  initialOptions: AsyncRateLimiterOptions<TFn>,
+): SolidAsyncRateLimiter<TFn> {
+  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)
 
-  const [executionCount, setExecutionCount] = createSignal(
-    asyncRateLimiter.getExecutionCount(),
+  const [successCount, setSuccessCount] = createSignal(
+    asyncRateLimiter.getSuccessCount(),
   )
   const [rejectionCount, setRejectionCount] = createSignal(
     asyncRateLimiter.getRejectionCount(),
   )
+  const [errorCount, setErrorCount] = createSignal(
+    asyncRateLimiter.getErrorCount(),
+  )
+  const [settleCount, setSettleCount] = createSignal(
+    asyncRateLimiter.getSettleCount(),
+  )
   const [remainingInWindow, setRemainingInWindow] = createSignal(
     asyncRateLimiter.getRemainingInWindow(),
   )
@@ -79,18 +95,19 @@ export function createAsyncRateLimiter<
     asyncRateLimiter.getMsUntilNextWindow(),
   )
 
-  function setOptions(
-    newOptions: Partial<AsyncRateLimiterOptions<TFn, TArgs>>,
-  ) {
+  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {
     asyncRateLimiter.setOptions({
       ...newOptions,
-      onExecute: (rateLimiter) => {
-        setExecutionCount(rateLimiter.getExecutionCount())
+      onSettled: (rateLimiter) => {
+        setSuccessCount(rateLimiter.getSuccessCount())
+        setSettleCount(rateLimiter.getSettleCount())
+        setErrorCount(rateLimiter.getErrorCount())
+        setRejectionCount(rateLimiter.getRejectionCount())
         setRemainingInWindow(rateLimiter.getRemainingInWindow())
         setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())
 
-        const onExecute = newOptions.onExecute ?? initialOptions.onExecute
-        onExecute?.(rateLimiter)
+        const onSettled = newOptions.onSettled ?? initialOptions.onSettled
+        onSettled?.(rateLimiter)
       },
       onReject: (rateLimiter) => {
         setRejectionCount(rateLimiter.getRejectionCount())
@@ -107,10 +124,12 @@ export function createAsyncRateLimiter<
 
   return {
     ...bindInstanceMethods(asyncRateLimiter),
-    executionCount,
-    rejectionCount,
+    errorCount,
     remainingInWindow,
     msUntilNextWindow,
+    rejectionCount,
     setOptions,
-  }
+    settleCount,
+    successCount,
+  } as SolidAsyncRateLimiter<TFn>
 }