@tanstack/solid-pacer 0.7.0 → 0.9.0

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<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 *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\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":";;;AA6DgB,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;"}
+{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { useStore } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = RateLimiterState,\n> extends Omit<RateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\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 *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\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  TSelected = RateLimiterState,\n>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n  selector?: (state: RateLimiterState) => TSelected,\n): SolidRateLimiter<TFn, TSelected> {\n  const rateLimiter = new RateLimiter<TFn>(fn, initialOptions)\n\n  const state = useStore(rateLimiter.store, selector)\n\n  return {\n    ...rateLimiter,\n    state,\n  } as unknown as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"names":[],"mappings":";;AA6DO,SAAS,kBAId,IACA,gBACA,UACkC;AAClC,QAAM,cAAc,IAAI,YAAiB,IAAI,cAAc;AAE3D,QAAM,QAAQ,SAAS,YAAY,OAAO,QAAQ;AAElD,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,EAAA;AAEJ;"}

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

@@ -1,6 +1,6 @@
 import { SolidThrottler } from './createThrottler.js';
 import { Accessor, Setter } from 'solid-js';
-import { ThrottlerOptions } from '@tanstack/pacer/throttler';
+import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
 /**
  * A Solid hook that creates a throttled state value that updates at most once within a specified time window.
  * This hook combines Solid's createSignal with throttling functionality to provide controlled state updates.
@@ -35,4 +35,8 @@ 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>, Setter<TValue>, SolidThrottler<Setter<TValue>>];
+export declare function createThrottledSignal<TValue, TSelected = ThrottlerState<Setter<TValue>>>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [
+    Accessor<TValue>,
+    Setter<TValue>,
+    SolidThrottler<Setter<TValue>, TSelected>
+];

package/dist/esm/throttler/createThrottledSignal.js

@@ -1,8 +1,8 @@
 import { createSignal } from "solid-js";
 import { createThrottler } from "./createThrottler.js";
-function createThrottledSignal(value, initialOptions) {
+function createThrottledSignal(value, initialOptions, selector) {
   const [throttledValue, setThrottledValue] = createSignal(value);
-  const throttler = createThrottler(setThrottledValue, initialOptions);
+  const throttler = createThrottler(setThrottledValue, initialOptions, selector);
   return [throttledValue, throttler.maybeExecute, throttler];
 }
 export {

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>>,\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;"}
+{"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 {\n  ThrottlerOptions,\n  ThrottlerState,\n} 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<\n  TValue,\n  TSelected = ThrottlerState<Setter<TValue>>,\n>(\n  value: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): [\n  Accessor<TValue>,\n  Setter<TValue>,\n  SolidThrottler<Setter<TValue>, TSelected>,\n] {\n  const [throttledValue, setThrottledValue] = createSignal<TValue>(value)\n  const throttler = createThrottler(setThrottledValue, initialOptions, selector)\n  return [throttledValue, throttler.maybeExecute as Setter<TValue>, throttler]\n}\n"],"names":[],"mappings":";;AA2CO,SAAS,sBAId,OACA,gBACA,UAKA;AACA,QAAM,CAAC,gBAAgB,iBAAiB,IAAI,aAAqB,KAAK;AACtE,QAAM,YAAY,gBAAgB,mBAAmB,gBAAgB,QAAQ;AAC7E,SAAO,CAAC,gBAAgB,UAAU,cAAgC,SAAS;AAC7E;"}

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

@@ -1,6 +1,6 @@
 import { SolidThrottler } from './createThrottler.js';
 import { Accessor, Setter } from 'solid-js';
-import { ThrottlerOptions } from '@tanstack/pacer/throttler';
+import { ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
 /**
  * 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.
@@ -29,4 +29,4 @@ import { ThrottlerOptions } from '@tanstack/pacer/throttler';
  * throttler.cancel(); // Cancel any pending updates
  * ```
  */
-export declare function createThrottledValue<TValue>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>): [Accessor<TValue>, SolidThrottler<Setter<TValue>>];
+export declare function createThrottledValue<TValue, TSelected = ThrottlerState<Setter<TValue>>>(value: Accessor<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): [Accessor<TValue>, SolidThrottler<Setter<TValue>, TSelected>];

package/dist/esm/throttler/createThrottledValue.js

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

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

@@ -1 +1 @@
-{"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;"}
+{"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 {\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 * @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<\n  TValue,\n  TSelected = ThrottlerState<Setter<TValue>>,\n>(\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"],"names":[],"mappings":";;AAqCO,SAAS,qBAId,OACA,gBACA,UAC+D;AAC/D,QAAM,CAAC,gBAAgB,mBAAmB,SAAS,IAAI;AAAA,IACrD,MAAA;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAGF,eAAa,MAAM;AACjB,sBAAkB,OAAc;AAAA,EAAA,CACjC;AAED,SAAO,CAAC,gBAAgB,SAAS;AACnC;"}

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

@@ -1,14 +1,13 @@
-import { Throttler, ThrottlerOptions } from '@tanstack/pacer/throttler';
+import { Throttler, ThrottlerOptions, ThrottlerState } from '@tanstack/pacer/throttler';
 import { Accessor } from 'solid-js';
 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> extends Omit<Throttler<TFn>, 'getExecutionCount' | 'getIsPending' | 'getLastExecutionTime' | 'getNextExecutionTime'> {
-    executionCount: Accessor<number>;
-    isPending: Accessor<boolean>;
-    lastExecutionTime: Accessor<number>;
-    nextExecutionTime: Accessor<number>;
+export interface SolidThrottler<TFn extends AnyFunction, TSelected = ThrottlerState<TFn>> 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>>;
 }
 /**
  * A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute.
@@ -44,4 +43,4 @@ export interface SolidThrottler<TFn extends AnyFunction> extends Omit<Throttler<
  * console.log(throttler.nextExecutionTime()); // timestamp of next allowed execution
  * ```
  */
-export declare function createThrottler<TFn extends AnyFunction>(fn: TFn, initialOptions: ThrottlerOptions<TFn>): SolidThrottler<TFn>;
+export declare function createThrottler<TFn extends AnyFunction, TSelected = ThrottlerState<TFn>>(fn: TFn, initialOptions: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;

package/dist/esm/throttler/createThrottler.js

@@ -1,44 +1,17 @@
 import { Throttler } from "@tanstack/pacer/throttler";
-import { createSignal, createEffect, onCleanup } from "solid-js";
-import { bindInstanceMethods } from "@tanstack/pacer/utils";
-function createThrottler(fn, initialOptions) {
-  const throttler = bindInstanceMethods(new Throttler(fn, initialOptions));
-  const [executionCount, setExecutionCount] = createSignal(
-    throttler.getExecutionCount()
-  );
-  const [isPending, setIsPending] = createSignal(throttler.getIsPending());
-  const [lastExecutionTime, setLastExecutionTime] = createSignal(
-    throttler.getLastExecutionTime()
-  );
-  const [nextExecutionTime, setNextExecutionTime] = createSignal(
-    throttler.getNextExecutionTime()
-  );
-  function setOptions(newOptions) {
-    throttler.setOptions({
-      ...newOptions,
-      onExecute: (throttler2) => {
-        setExecutionCount(throttler2.getExecutionCount());
-        setIsPending(throttler2.getIsPending());
-        setLastExecutionTime(throttler2.getLastExecutionTime());
-        setNextExecutionTime(throttler2.getNextExecutionTime());
-        const onExecute = newOptions.onExecute ?? initialOptions.onExecute;
-        onExecute == null ? void 0 : onExecute(throttler2);
-      }
-    });
-  }
-  setOptions(initialOptions);
+import { createEffect, onCleanup } from "solid-js";
+import { useStore } from "@tanstack/solid-store";
+function createThrottler(fn, initialOptions, selector) {
+  const asyncThrottler = new Throttler(fn, initialOptions);
+  const state = useStore(asyncThrottler.store, selector);
   createEffect(() => {
     onCleanup(() => {
-      throttler.cancel();
+      asyncThrottler.cancel();
     });
   });
   return {
-    ...throttler,
-    executionCount,
-    isPending,
-    lastExecutionTime,
-    nextExecutionTime,
-    setOptions
+    ...asyncThrottler,
+    state
   };
 }
 export {

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 { 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;"}
+{"version":3,"file":"createThrottler.js","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 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 = ThrottlerState<TFn>,\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\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  TSelected = ThrottlerState<TFn>,\n>(\n  fn: TFn,\n  initialOptions: ThrottlerOptions<TFn>,\n  selector?: (state: ThrottlerState<TFn>) => TSelected,\n): SolidThrottler<TFn, TSelected> {\n  const asyncThrottler = new Throttler<TFn>(fn, initialOptions)\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"],"names":[],"mappings":";;;AAwDO,SAAS,gBAId,IACA,gBACA,UACgC;AAChC,QAAM,iBAAiB,IAAI,UAAe,IAAI,cAAc;AAE5D,QAAM,QAAQ,SAAS,eAAe,OAAO,QAAQ;AAErD,eAAa,MAAM;AACjB,cAAU,MAAM;AACd,qBAAe,OAAA;AAAA,IAAO,CACvB;AAAA,EAAA,CACF;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,EAAA;AAEJ;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -37,6 +37,16 @@
         "default": "./dist/cjs/index.cjs"
       }
     },
+    "./async-batcher": {
+      "import": {
+        "types": "./dist/esm/async-batcher/index.d.ts",
+        "default": "./dist/esm/async-batcher/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/async-batcher/index.d.cts",
+        "default": "./dist/cjs/async-batcher/index.cjs"
+      }
+    },
     "./async-debouncer": {
       "import": {
         "types": "./dist/esm/async-debouncer/index.d.ts",
@@ -152,11 +162,12 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/pacer": "0.7.0"
+    "@tanstack/solid-store": "^0.7.3",
+    "@tanstack/pacer": "0.9.0"
   },
   "devDependencies": {
-    "solid-js": "^1.9.6",
-    "vite-plugin-solid": "^2.11.6"
+    "solid-js": "^1.9.7",
+    "vite-plugin-solid": "^2.11.7"
   },
   "peerDependencies": {
     "solid-js": ">=1.9.5"

package/src/async-batcher/createAsyncBatcher.ts

@@ -0,0 +1,98 @@
+import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
+import { useStore } from '@tanstack/solid-store'
+import type { Accessor } from 'solid-js'
+import type {
+  AsyncBatcherOptions,
+  AsyncBatcherState,
+} from '@tanstack/pacer/async-batcher'
+
+export interface SolidAsyncBatcher<
+  TValue,
+  TSelected = AsyncBatcherState<TValue>,
+> extends Omit<AsyncBatcher<TValue>, 'store'> {
+  /**
+   * Reactive state that will be updated when the batcher state changes
+   *
+   * Use this instead of `batcher.store.state`
+   */
+  readonly state: Accessor<Readonly<TSelected>>
+}
+
+/**
+ * Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.
+ *
+ * This is the async version of the createBatcher hook. Unlike the sync version, this async batcher:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ * - Returns the result of the batch function execution
+ *
+ * Features:
+ * - Configurable batch size and wait time
+ * - Custom batch processing logic via getShouldExecute
+ * - Event callbacks for monitoring batch operations
+ * - Error handling for failed batch operations
+ * - Automatic or manual batch processing
+ * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity
+ *
+ * The batcher collects items and processes them in batches based on:
+ * - Maximum batch size (number of items per batch)
+ * - Time-based batching (process after X milliseconds)
+ * - Custom batch processing logic via getShouldExecute
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and batcher instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together; the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncBatcher instance
+ *
+ * Example usage:
+ * ```tsx
+ * // Basic async batcher for API requests
+ * const asyncBatcher = createAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onSuccess: (result) => {
+ *       console.log('Batch processed successfully:', result);
+ *     },
+ *     onError: (error) => {
+ *       console.error('Batch processing failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Add items to batch
+ * asyncBatcher.addItem(newItem);
+ *
+ * // Manually execute batch
+ * const result = await asyncBatcher.execute();
+ *
+ * // Use Solid signals in your UI
+ * const items = asyncBatcher.state().items;
+ * const isExecuting = asyncBatcher.state().isExecuting;
+ * ```
+ */
+export function createAsyncBatcher<
+  TValue,
+  TSelected = AsyncBatcherState<TValue>,
+>(
+  fn: (items: Array<TValue>) => Promise<any>,
+  initialOptions: AsyncBatcherOptions<TValue> = {},
+  selector?: (state: AsyncBatcherState<TValue>) => TSelected,
+): SolidAsyncBatcher<TValue, TSelected> {
+  const asyncBatcher = new AsyncBatcher<TValue>(fn, initialOptions)
+
+  const state = useStore(asyncBatcher.store, selector)
+
+  return {
+    ...asyncBatcher,
+    state,
+  } as unknown as SolidAsyncBatcher<TValue, TSelected> // omit `store` in favor of `state`
+}

package/src/async-batcher/index.ts

@@ -0,0 +1,3 @@
+export * from '@tanstack/pacer/async-batcher'
+
+export * from './createAsyncBatcher'

package/src/async-debouncer/createAsyncDebouncer.ts

@@ -1,24 +1,23 @@
 import { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'
-import { createSignal } from 'solid-js'
-import { bindInstanceMethods } from '@tanstack/pacer/utils'
-import type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
+import { useStore } from '@tanstack/solid-store'
+import { createEffect, onCleanup } from 'solid-js'
 import type { Accessor } from 'solid-js'
+import type {
+  AsyncDebouncerOptions,
+  AsyncDebouncerState,
+} from '@tanstack/pacer/async-debouncer'
+import type { AnyAsyncFunction } from '@tanstack/pacer/types'
 
-export interface SolidAsyncDebouncer<TFn extends AnyAsyncFunction>
-  extends Omit<
-    AsyncDebouncer<TFn>,
-    | 'getErrorCount'
-    | 'getIsPending'
-    | 'getLastResult'
-    | 'getSettleCount'
-    | 'getSuccessCount'
-  > {
-  errorCount: Accessor<number>
-  isPending: Accessor<boolean>
-  lastResult: Accessor<ReturnType<TFn> | undefined>
-  settleCount: Accessor<number>
-  successCount: Accessor<number>
+export interface SolidAsyncDebouncer<
+  TFn extends AnyAsyncFunction,
+  TSelected = AsyncDebouncerState<TFn>,
+> extends Omit<AsyncDebouncer<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated when the debouncer state changes
+   *
+   * Use this instead of `debouncer.store.state`
+   */
+  readonly state: Accessor<Readonly<TSelected>>
 }
 
 /**
@@ -74,50 +73,26 @@ export interface SolidAsyncDebouncer<TFn extends AnyAsyncFunction>
  * );
  * ```
  */
-export function createAsyncDebouncer<TFn extends AnyAsyncFunction>(
+export function createAsyncDebouncer<
+  TFn extends AnyAsyncFunction,
+  TSelected = AsyncDebouncerState<TFn>,
+>(
   fn: TFn,
   initialOptions: AsyncDebouncerOptions<TFn>,
-): SolidAsyncDebouncer<TFn> {
+  selector?: (state: AsyncDebouncerState<TFn>) => TSelected,
+): SolidAsyncDebouncer<TFn, TSelected> {
   const asyncDebouncer = new AsyncDebouncer<TFn>(fn, initialOptions)
 
-  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(),
-  )
+  const state = useStore(asyncDebouncer.store, selector)
 
-  function setOptions(newOptions: Partial<AsyncDebouncerOptions<TFn>>) {
-    asyncDebouncer.setOptions({
-      ...newOptions,
-      onSettled: (asyncDebouncer) => {
-        setSuccessCount(asyncDebouncer.getSuccessCount())
-        setErrorCount(asyncDebouncer.getErrorCount())
-        setSettleCount(asyncDebouncer.getSettleCount())
-        setIsPending(asyncDebouncer.getIsPending())
-        setLastResult(asyncDebouncer.getLastResult())
-        const onSettled = newOptions.onSettled ?? initialOptions.onSettled
-        onSettled?.(asyncDebouncer)
-      },
+  createEffect(() => {
+    onCleanup(() => {
+      asyncDebouncer.cancel()
     })
-  }
-
-  setOptions(initialOptions)
+  })
 
   return {
-    ...bindInstanceMethods(asyncDebouncer),
-    errorCount,
-    isPending,
-    lastResult,
-    settleCount,
-    successCount,
-    setOptions,
-  } as SolidAsyncDebouncer<TFn>
+    ...asyncDebouncer,
+    state,
+  } as unknown as SolidAsyncDebouncer<TFn, TSelected> // omit `store` in favor of `state`
 }