@tanstack/solid-pacer 0.18.4 → 0.19.0

package/dist/throttler/createThrottler.d.cts

@@ -4,6 +4,13 @@ import { AnyFunction } from "@tanstack/pacer/types";
 import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
 
 //#region src/throttler/createThrottler.d.ts
+interface SolidThrottlerOptions<TFn extends AnyFunction, TSelected = {}> extends ThrottlerOptions<TFn> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the throttler instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
+   */
+  onUnmount?: (throttler: SolidThrottler<TFn, TSelected>) => void;
+}
 interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
   /**
    * A Solid component that allows you to subscribe to the throttler state.
@@ -77,6 +84,18 @@ interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<T
  * - `nextExecutionTime`: Timestamp of the next allowed execution
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive cancels any pending execution when the owning component unmounts.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```tsx
+ * const throttler = createThrottler(fn, {
+ *   wait: 1000,
+ *   onUnmount: (t) => t.flush()
+ * });
+ * ```
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -123,7 +142,7 @@ interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<T
  * const { isPending, executionCount } = throttler.state();
  * ```
  */
-declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: SolidThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
 //#endregion
-export { SolidThrottler, createThrottler };
+export { SolidThrottler, SolidThrottlerOptions, createThrottler };
 //# sourceMappingURL=createThrottler.d.cts.map

package/dist/throttler/createThrottler.d.ts

@@ -4,6 +4,13 @@ import { Throttler, ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/thr
 import { AnyFunction } from "@tanstack/pacer/types";
 
 //#region src/throttler/createThrottler.d.ts
+interface SolidThrottlerOptions<TFn extends AnyFunction, TSelected = {}> extends ThrottlerOptions<TFn> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the throttler instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
+   */
+  onUnmount?: (throttler: SolidThrottler<TFn, TSelected>) => void;
+}
 interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<Throttler<TFn>, 'store'> {
   /**
    * A Solid component that allows you to subscribe to the throttler state.
@@ -77,6 +84,18 @@ interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<T
  * - `nextExecutionTime`: Timestamp of the next allowed execution
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive cancels any pending execution when the owning component unmounts.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```tsx
+ * const throttler = createThrottler(fn, {
+ *   wait: 1000,
+ *   onUnmount: (t) => t.flush()
+ * });
+ * ```
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -123,7 +142,7 @@ interface SolidThrottler<TFn extends AnyFunction, TSelected = {}> extends Omit<T
  * const { isPending, executionCount } = throttler.state();
  * ```
  */
-declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: ThrottlerOptions<TFn>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
+declare function createThrottler<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: SolidThrottlerOptions<TFn, TSelected>, selector?: (state: ThrottlerState<TFn>) => TSelected): SolidThrottler<TFn, TSelected>;
 //#endregion
-export { SolidThrottler, createThrottler };
+export { SolidThrottler, SolidThrottlerOptions, createThrottler };
 //# sourceMappingURL=createThrottler.d.ts.map

package/dist/throttler/createThrottler.js

@@ -46,6 +46,18 @@ import { Throttler } from "@tanstack/pacer/throttler";
 * - `nextExecutionTime`: Timestamp of the next allowed execution
 * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
 *
+* ## Unmount behavior
+*
+* By default, the primitive cancels any pending execution when the owning component unmounts.
+* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+*
+* ```tsx
+* const throttler = createThrottler(fn, {
+*   wait: 1000,
+*   onUnmount: (t) => t.flush()
+* });
+* ```
+*
 * @example
 * ```tsx
 * // Default behavior - no reactive state subscriptions
@@ -93,10 +105,11 @@ import { Throttler } from "@tanstack/pacer/throttler";
 * ```
 */
 function createThrottler(fn, options, selector = () => ({})) {
-	const asyncThrottler = new Throttler(fn, {
+	const mergedOptions = {
 		...useDefaultPacerOptions().throttler,
 		...options
-	});
+	};
+	const asyncThrottler = new Throttler(fn, mergedOptions);
 	asyncThrottler.Subscribe = function Subscribe(props) {
 		const selected = useStore(asyncThrottler.store, props.selector);
 		return typeof props.children === "function" ? props.children(selected) : props.children;
@@ -104,7 +117,8 @@ function createThrottler(fn, options, selector = () => ({})) {
 	const state = useStore(asyncThrottler.store, selector);
 	createEffect(() => {
 		onCleanup(() => {
-			asyncThrottler.cancel();
+			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncThrottler);
+			else asyncThrottler.cancel();
 		});
 	});
 	return {

package/dist/throttler/createThrottler.js.map

@@ -1 +1 @@
-{"version":3,"file":"createThrottler.js","names":[],"sources":["../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor, JSX } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface SolidThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * A Solid component that allows you to subscribe to the throttler state.\n   *\n   * This is useful for tracking specific parts of the throttler state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {(state) => (\n   *     <div>{state().isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\n  /**\n   * Reactive state that will be updated when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Solid's createSignal, see createThrottledSignal.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` component (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` component to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger reactive updates\n * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary\n * updates and gives you full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe component\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {(state) => (\n *     <div>{state().isPending ? 'Loading...' : 'Ready'}</div>\n *   )}\n * </throttler.Subscribe>\n *\n * // Opt-in to track isPending changes at hook level (optimized for loading states)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to track executionCount changes (optimized for tracking execution)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - track when any of these change\n * const throttler = createThrottler(\n *   setValue,\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending, executionCount } = throttler.state();\n * ```\n */\nexport function createThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): SolidThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const asyncThrottler = new Throttler<TFn>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidThrottler<TFn, TSelected>\n\n  asyncThrottler.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useStore(asyncThrottler.store, props.selector)\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  createEffect(() => {\n    onCleanup(() => {\n      asyncThrottler.cancel()\n    })\n  })\n\n  return {\n    ...asyncThrottler,\n    state,\n  } as SolidThrottler<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuIA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,iBAAiB,IAAI,UACzB,IANoB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAKA;AAED,gBAAe,YAAY,SAAS,UAAqB,OAGtD;EACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,SAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;CAGZ,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,oBAAmB;AACjB,kBAAgB;AACd,kBAAe,QAAQ;IACvB;GACF;AAEF,QAAO;EACL,GAAG;EACH;EACD"}
+{"version":3,"file":"createThrottler.js","names":[],"sources":["../../src/throttler/createThrottler.ts"],"sourcesContent":["import { Throttler } from '@tanstack/pacer/throttler'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor, JSX } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface SolidThrottlerOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends ThrottlerOptions<TFn> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the throttler instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.\n   */\n  onUnmount?: (throttler: SolidThrottler<TFn, TSelected>) => void\n}\n\nexport interface SolidThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * A Solid component that allows you to subscribe to the throttler state.\n   *\n   * This is useful for tracking specific parts of the throttler state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {(state) => (\n   *     <div>{state().isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\n  /**\n   * Reactive state that will be updated when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (createSignal, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Solid's createSignal, see createThrottledSignal.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `throttler.Subscribe` component (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` component to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger reactive updates\n * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary\n * updates and gives you full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Unmount behavior\n *\n * By default, the primitive cancels any pending execution when the owning component unmounts.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = createThrottler(fn, {\n *   wait: 1000,\n *   onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const throttler = createThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe component\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {(state) => (\n *     <div>{state().isPending ? 'Loading...' : 'Ready'}</div>\n *   )}\n * </throttler.Subscribe>\n *\n * // Opt-in to track isPending changes at hook level (optimized for loading states)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to track executionCount changes (optimized for tracking execution)\n * const throttler = createThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - track when any of these change\n * const throttler = createThrottler(\n *   setValue,\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   },\n *   (state) => ({\n *     isPending: state.isPending,\n *     executionCount: state.executionCount,\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending, executionCount } = throttler.state();\n * ```\n */\nexport function createThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: SolidThrottlerOptions<TFn, TSelected>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): SolidThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as SolidThrottlerOptions<TFn, TSelected>\n  const asyncThrottler = new Throttler<TFn>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidThrottler<TFn, TSelected>\n\n  asyncThrottler.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useStore(asyncThrottler.store, props.selector)\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncThrottler)\n      } else {\n        asyncThrottler.cancel()\n      }\n    })\n  })\n\n  return {\n    ...asyncThrottler,\n    state,\n  } as SolidThrottler<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8JA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC/B;CAChC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,iBAAiB,IAAI,UACzB,IACA,cACD;AAED,gBAAe,YAAY,SAAS,UAAqB,OAGtD;EACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,SAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;CAGZ,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,oBAAmB;AACjB,kBAAgB;AACd,OAAI,cAAc,UAChB,eAAc,UAAU,eAAe;OAEvC,gBAAe,QAAQ;IAEzB;GACF;AAEF,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/throttler/index.cjs

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_createThrottler = require('./createThrottler.cjs');
 const require_createThrottledSignal = require('./createThrottledSignal.cjs');
 const require_createThrottledValue = require('./createThrottledValue.cjs');

package/dist/throttler/index.d.cts

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

package/dist/throttler/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.18.4",
+  "version": "0.19.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -28,60 +28,60 @@
   "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     },
     "./async-batcher": {
-      "require": "./dist/async-batcher/index.cjs",
-      "import": "./dist/async-batcher/index.js"
+      "import": "./dist/async-batcher/index.js",
+      "require": "./dist/async-batcher/index.cjs"
     },
     "./async-debouncer": {
-      "require": "./dist/async-debouncer/index.cjs",
-      "import": "./dist/async-debouncer/index.js"
+      "import": "./dist/async-debouncer/index.js",
+      "require": "./dist/async-debouncer/index.cjs"
     },
     "./async-queuer": {
-      "require": "./dist/async-queuer/index.cjs",
-      "import": "./dist/async-queuer/index.js"
+      "import": "./dist/async-queuer/index.js",
+      "require": "./dist/async-queuer/index.cjs"
     },
     "./async-rate-limiter": {
-      "require": "./dist/async-rate-limiter/index.cjs",
-      "import": "./dist/async-rate-limiter/index.js"
+      "import": "./dist/async-rate-limiter/index.js",
+      "require": "./dist/async-rate-limiter/index.cjs"
     },
     "./async-throttler": {
-      "require": "./dist/async-throttler/index.cjs",
-      "import": "./dist/async-throttler/index.js"
+      "import": "./dist/async-throttler/index.js",
+      "require": "./dist/async-throttler/index.cjs"
     },
     "./batcher": {
-      "require": "./dist/batcher/index.cjs",
-      "import": "./dist/batcher/index.js"
+      "import": "./dist/batcher/index.js",
+      "require": "./dist/batcher/index.cjs"
     },
     "./debouncer": {
-      "require": "./dist/debouncer/index.cjs",
-      "import": "./dist/debouncer/index.js"
+      "import": "./dist/debouncer/index.js",
+      "require": "./dist/debouncer/index.cjs"
     },
     "./provider": {
-      "require": "./dist/provider/index.cjs",
-      "import": "./dist/provider/index.js"
+      "import": "./dist/provider/index.js",
+      "require": "./dist/provider/index.cjs"
     },
     "./queuer": {
-      "require": "./dist/queuer/index.cjs",
-      "import": "./dist/queuer/index.js"
+      "import": "./dist/queuer/index.js",
+      "require": "./dist/queuer/index.cjs"
     },
     "./rate-limiter": {
-      "require": "./dist/rate-limiter/index.cjs",
-      "import": "./dist/rate-limiter/index.js"
+      "import": "./dist/rate-limiter/index.js",
+      "require": "./dist/rate-limiter/index.cjs"
     },
     "./throttler": {
-      "require": "./dist/throttler/index.cjs",
-      "import": "./dist/throttler/index.js"
+      "import": "./dist/throttler/index.js",
+      "require": "./dist/throttler/index.cjs"
     },
     "./types": {
-      "require": "./dist/types/index.cjs",
-      "import": "./dist/types/index.js"
+      "import": "./dist/types/index.js",
+      "require": "./dist/types/index.cjs"
     },
     "./utils": {
-      "require": "./dist/utils/index.cjs",
-      "import": "./dist/utils/index.js"
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.cjs"
     },
     "./package.json": "./package.json"
   },
@@ -94,8 +94,8 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/solid-store": "^0.8.0",
-    "@tanstack/pacer": "0.18.0"
+    "@tanstack/solid-store": "^0.8.1",
+    "@tanstack/pacer": "0.19.0"
   },
   "devDependencies": {
     "solid-js": "^1.9.11",
@@ -106,6 +106,7 @@
   },
   "scripts": {
     "clean": "premove ./build ./dist",
+    "lint:fix": "eslint ./src --fix",
     "test:eslint": "eslint ./src",
     "test:lib": "vitest --passWithNoTests",
     "test:lib:dev": "pnpm test:lib --watch",

package/src/async-batcher/createAsyncBatcher.ts

@@ -1,5 +1,6 @@
 import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
 import { useStore } from '@tanstack/solid-store'
+import { createEffect, onCleanup } from 'solid-js'
 import { useDefaultPacerOptions } from '../provider/PacerProvider'
 import type { Store } from '@tanstack/solid-store'
 import type { Accessor, JSX } from 'solid-js'
@@ -8,6 +9,17 @@ import type {
   AsyncBatcherState,
 } from '@tanstack/pacer/async-batcher'
 
+export interface SolidAsyncBatcherOptions<
+  TValue,
+  TSelected = {},
+> extends AsyncBatcherOptions<TValue> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the batcher instance.
+   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
+   */
+  onUnmount?: (batcher: SolidAsyncBatcher<TValue, TSelected>) => void
+}
+
 export interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<
   AsyncBatcher<TValue>,
   'store'
@@ -105,6 +117,25 @@ export interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<
  * - `settleCount`: Number of batch executions that have completed (successful or failed)
  * - `successCount`: Number of successful batch executions
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive cancels any pending batch and aborts any in-flight execution when the owning component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```tsx
+ * const batcher = createAsyncBatcher(fn, {
+ *   maxSize: 10,
+ *   wait: 2000,
+ *   onUnmount: (b) => b.flush()
+ * });
+ * ```
+ *
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
+ * If your batch function updates Solid signals, those updates may run after the component has
+ * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
+ * using onUnmount with flush.
+ *
  * Example usage:
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -157,15 +188,14 @@ export interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<
  */
 export function createAsyncBatcher<TValue, TSelected = {}>(
   fn: (items: Array<TValue>) => Promise<any>,
-  options: AsyncBatcherOptions<TValue> = {},
+  options: SolidAsyncBatcherOptions<TValue, TSelected> = {},
   selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>
     ({}) as TSelected,
 ): SolidAsyncBatcher<TValue, TSelected> {
   const mergedOptions = {
     ...useDefaultPacerOptions().asyncBatcher,
     ...options,
-  } as AsyncBatcherOptions<TValue>
-
+  } as SolidAsyncBatcherOptions<TValue, TSelected>
   const asyncBatcher = new AsyncBatcher<TValue>(
     fn,
     mergedOptions,
@@ -184,6 +214,17 @@ export function createAsyncBatcher<TValue, TSelected = {}>(
 
   const state = useStore(asyncBatcher.store, selector)
 
+  createEffect(() => {
+    onCleanup(() => {
+      if (mergedOptions.onUnmount) {
+        mergedOptions.onUnmount(asyncBatcher)
+      } else {
+        asyncBatcher.cancel()
+        asyncBatcher.abort()
+      }
+    })
+  })
+
   return {
     ...asyncBatcher,
     state,

package/src/async-debouncer/createAsyncDebouncer.ts

@@ -10,6 +10,17 @@ import type {
 } from '@tanstack/pacer/async-debouncer'
 import type { AnyAsyncFunction } from '@tanstack/pacer/types'
 
+export interface SolidAsyncDebouncerOptions<
+  TFn extends AnyAsyncFunction,
+  TSelected = {},
+> extends AsyncDebouncerOptions<TFn> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the debouncer instance.
+   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
+   */
+  onUnmount?: (debouncer: SolidAsyncDebouncer<TFn, TSelected>) => void
+}
+
 export interface SolidAsyncDebouncer<
   TFn extends AnyAsyncFunction,
   TSelected = {},
@@ -101,6 +112,24 @@ export interface SolidAsyncDebouncer<
  * - `lastResult`: The result from the most recent successful execution
  * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing')
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive cancels any pending execution and aborts any in-flight execution when the owning component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```tsx
+ * const debouncer = createAsyncDebouncer(fn, {
+ *   wait: 500,
+ *   onUnmount: (d) => d.flush()
+ * });
+ * ```
+ *
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
+ * If your debounced function updates Solid signals, those updates may run after the component has
+ * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
+ * using onUnmount with flush.
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -148,15 +177,14 @@ export function createAsyncDebouncer<
   TSelected = {},
 >(
   fn: TFn,
-  options: AsyncDebouncerOptions<TFn>,
+  options: SolidAsyncDebouncerOptions<TFn, TSelected>,
   selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>
     ({}) as TSelected,
 ): SolidAsyncDebouncer<TFn, TSelected> {
   const mergedOptions = {
     ...useDefaultPacerOptions().asyncDebouncer,
     ...options,
-  } as AsyncDebouncerOptions<TFn>
-
+  } as SolidAsyncDebouncerOptions<TFn, TSelected>
   const asyncDebouncer = new AsyncDebouncer<TFn>(
     fn,
     mergedOptions,
@@ -177,7 +205,12 @@ export function createAsyncDebouncer<
 
   createEffect(() => {
     onCleanup(() => {
-      asyncDebouncer.cancel()
+      if (mergedOptions.onUnmount) {
+        mergedOptions.onUnmount(asyncDebouncer)
+      } else {
+        asyncDebouncer.cancel()
+        asyncDebouncer.abort()
+      }
     })
   })
 

package/src/async-queuer/createAsyncQueuer.ts

@@ -1,5 +1,6 @@
 import { AsyncQueuer } from '@tanstack/pacer/async-queuer'
 import { useStore } from '@tanstack/solid-store'
+import { createEffect, onCleanup } from 'solid-js'
 import { useDefaultPacerOptions } from '../provider/PacerProvider'
 import type { Store } from '@tanstack/solid-store'
 import type { Accessor, JSX } from 'solid-js'
@@ -8,6 +9,17 @@ import type {
   AsyncQueuerState,
 } from '@tanstack/pacer/async-queuer'
 
+export interface SolidAsyncQueuerOptions<
+  TValue,
+  TSelected = {},
+> extends AsyncQueuerOptions<TValue> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the queuer instance.
+   * When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc.
+   */
+  onUnmount?: (queuer: SolidAsyncQueuer<TValue, TSelected>) => void
+}
+
 export interface SolidAsyncQueuer<TValue, TSelected = {}> extends Omit<
   AsyncQueuer<TValue>,
   'store'
@@ -96,6 +108,25 @@ export interface SolidAsyncQueuer<TValue, TSelected = {}> extends Omit<
  * - `settleCount`: Number of items that have completed processing (successful or failed)
  * - `successCount`: Number of items that were processed successfully
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive stops the queuer and aborts any in-flight task executions when the owning component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this. For example, to flush pending items instead:
+ *
+ * ```tsx
+ * const queuer = createAsyncQueuer(fn, {
+ *   concurrency: 2,
+ *   started: false,
+ *   onUnmount: (q) => q.flush()
+ * });
+ * ```
+ *
+ * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
+ * If your task function updates Solid signals, those updates may run after the component has
+ * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
+ * using onUnmount with flush.
+ *
  * Example usage:
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -149,15 +180,14 @@ export interface SolidAsyncQueuer<TValue, TSelected = {}> extends Omit<
  */
 export function createAsyncQueuer<TValue, TSelected = {}>(
   fn: (value: TValue) => Promise<any>,
-  options: AsyncQueuerOptions<TValue> = {},
+  options: SolidAsyncQueuerOptions<TValue, TSelected> = {},
   selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>
     ({}) as TSelected,
 ): SolidAsyncQueuer<TValue, TSelected> {
   const mergedOptions = {
     ...useDefaultPacerOptions().asyncQueuer,
     ...options,
-  } as AsyncQueuerOptions<TValue>
-
+  } as SolidAsyncQueuerOptions<TValue, TSelected>
   const asyncQueuer = new AsyncQueuer<TValue>(
     fn,
     mergedOptions,
@@ -176,6 +206,17 @@ export function createAsyncQueuer<TValue, TSelected = {}>(
 
   const state = useStore(asyncQueuer.store, selector)
 
+  createEffect(() => {
+    onCleanup(() => {
+      if (mergedOptions.onUnmount) {
+        mergedOptions.onUnmount(asyncQueuer)
+      } else {
+        asyncQueuer.stop()
+        asyncQueuer.abort()
+      }
+    })
+  })
+
   return {
     ...asyncQueuer,
     state,

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

@@ -1,4 +1,5 @@
 import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'
+import { createEffect, onCleanup } from 'solid-js'
 import { useStore } from '@tanstack/solid-store'
 import { useDefaultPacerOptions } from '../provider/PacerProvider'
 import type { Store } from '@tanstack/solid-store'
@@ -9,6 +10,17 @@ import type {
   AsyncRateLimiterState,
 } from '@tanstack/pacer/async-rate-limiter'
 
+export interface SolidAsyncRateLimiterOptions<
+  TFn extends AnyAsyncFunction,
+  TSelected = {},
+> extends AsyncRateLimiterOptions<TFn> {
+  /**
+   * Optional callback invoked when the owning component unmounts. Receives the rate limiter instance.
+   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.
+   */
+  onUnmount?: (rateLimiter: SolidAsyncRateLimiter<TFn, TSelected>) => void
+}
+
 export interface SolidAsyncRateLimiter<
   TFn extends AnyAsyncFunction,
   TSelected = {},
@@ -111,6 +123,12 @@ export interface SolidAsyncRateLimiter<
  * - `rejectionCount`: Number of function calls that were rejected due to rate limiting
  * - `remainingInWindow`: Number of executions remaining in the current window
  *
+ * ## Unmount behavior
+ *
+ * By default, the primitive aborts any in-flight execution when the owning component unmounts.
+ * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
+ * Use the `onUnmount` option to customize this.
+ *
  * @example
  * ```tsx
  * // Default behavior - no reactive state subscriptions
@@ -204,15 +222,14 @@ export function createAsyncRateLimiter<
   TSelected = {},
 >(
   fn: TFn,
-  options: AsyncRateLimiterOptions<TFn>,
+  options: SolidAsyncRateLimiterOptions<TFn, TSelected>,
   selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>
     ({}) as TSelected,
 ): SolidAsyncRateLimiter<TFn, TSelected> {
   const mergedOptions = {
     ...useDefaultPacerOptions().asyncRateLimiter,
     ...options,
-  } as AsyncRateLimiterOptions<TFn>
-
+  } as SolidAsyncRateLimiterOptions<TFn, TSelected>
   const asyncRateLimiter = new AsyncRateLimiter<TFn>(
     fn,
     mergedOptions,
@@ -231,6 +248,16 @@ export function createAsyncRateLimiter<
 
   const state = useStore(asyncRateLimiter.store, selector)
 
+  createEffect(() => {
+    onCleanup(() => {
+      if (mergedOptions.onUnmount) {
+        mergedOptions.onUnmount(asyncRateLimiter)
+      } else {
+        asyncRateLimiter.abort()
+      }
+    })
+  })
+
   return {
     ...asyncRateLimiter,
     state,