@tanstack/solid-pacer 0.22.0 → 0.23.0

package/dist/async-rate-limiter/createAsyncRateLimiter.cjs

@@ -1,193 +0,0 @@
-const require_PacerProvider = require('../provider/PacerProvider.cjs');
-let solid_js = require("solid-js");
-let _tanstack_solid_store = require("@tanstack/solid-store");
-let _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
-
-//#region src/async-rate-limiter/createAsyncRateLimiter.ts
-/**
-* A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
-*
-* This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
-* you can integrate with any state management solution (createSignal, etc).
-*
-* Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
-* then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
-* all executions happen immediately, followed by a complete block.
-*
-* 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.
-*
-* 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.
-*
-* For smoother execution patterns, consider using:
-* - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
-* - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
-*
-* Rate limiting is best used for hard API limits or resource constraints. For UI updates or
-* smoothing out frequent events, throttling or debouncing usually provide better user experience.
-*
-* Error Handling:
-* - If an `onError` handler is provided, it will be called with the error and rate limiter 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 AsyncRateLimiter instance
-* - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
-*
-* ## State Management and Selector
-*
-* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
-* in two ways:
-*
-* **1. Using `rateLimiter.Subscribe` component (Recommended for component tree subscriptions)**
-*
-* Use the `Subscribe` component to subscribe to state changes deep in your component tree without
-* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
-* in child components.
-*
-* **2. Using the `selector` parameter (For hook-level subscriptions)**
-*
-* The `selector` parameter allows you to specify which state changes will trigger reactive updates
-* at the hook level, optimizing performance by preventing unnecessary updates when irrelevant
-* state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary
-* updates and gives you full control over when your component tracks state changes.
-*
-* Available state properties:
-* - `currentWindowStart`: Timestamp when the current window started
-* - `executionCount`: Number of function executions that have been completed
-* - `hasError`: Whether the last execution resulted in an error
-* - `isExecuting`: Whether an async function execution is currently in progress
-* - `lastError`: The error from the most recent failed execution (if any)
-* - `lastResult`: The result from the most recent successful execution
-* - `nextWindowTime`: Timestamp when the next window begins
-* - `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
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data; // Return value is preserved
-*   },
-*   { limit: 5, window: 1000 } // 5 calls per second
-* );
-*
-* // Subscribe to state changes deep in component tree using Subscribe component
-* <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
-*   {(state) => (
-*     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
-*   )}
-* </asyncRateLimiter.Subscribe>
-*
-* // Opt-in to track execution state changes at hook level (optimized for loading indicators)
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({ isExecuting: state.isExecuting })
-* );
-*
-* // Opt-in to track results when available (optimized for data display)
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({
-*     lastResult: state.lastResult,
-*     successCount: state.successCount
-*   })
-* );
-*
-* // Opt-in to track error/rejection state changes (optimized for error handling)
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   {
-*     limit: 5,
-*     window: 1000,
-*     onError: (error) => console.error('API call failed:', error),
-*     onReject: (rateLimiter) => console.log('Rate limit exceeded')
-*   },
-*   (state) => ({
-*     errorCount: state.errorCount,
-*     rejectionCount: state.rejectionCount
-*   })
-* );
-*
-* // Opt-in to track execution metrics changes (optimized for stats display)
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({
-*     successCount: state.successCount,
-*     errorCount: state.errorCount,
-*     settleCount: state.settleCount,
-*     rejectionCount: state.rejectionCount
-*   })
-* );
-*
-* // Opt-in to track execution times changes (optimized for window calculations)
-* const asyncRateLimiter = createAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({ executionTimes: state.executionTimes })
-* );
-*
-* // Access the selected state (will be empty object {} unless selector provided)
-* const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();
-* ```
-*/
-function createAsyncRateLimiter(fn, options, selector = () => ({})) {
-	const mergedOptions = {
-		...require_PacerProvider.useDefaultPacerOptions().asyncRateLimiter,
-		...options
-	};
-	const asyncRateLimiter = new _tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, mergedOptions);
-	asyncRateLimiter.Subscribe = function Subscribe(props) {
-		const selected = (0, _tanstack_solid_store.useSelector)(asyncRateLimiter.store, props.selector, { compare: _tanstack_solid_store.shallow });
-		return typeof props.children === "function" ? props.children(selected) : props.children;
-	};
-	const state = (0, _tanstack_solid_store.useSelector)(asyncRateLimiter.store, selector, { compare: _tanstack_solid_store.shallow });
-	(0, solid_js.createEffect)(() => {
-		(0, solid_js.onCleanup)(() => {
-			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncRateLimiter);
-			else asyncRateLimiter.abort();
-		});
-	});
-	return {
-		...asyncRateLimiter,
-		state
-	};
-}
-
-//#endregion
-exports.createAsyncRateLimiter = createAsyncRateLimiter;
-//# sourceMappingURL=createAsyncRateLimiter.cjs.map

package/dist/async-rate-limiter/createAsyncRateLimiter.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter","useSelector","shallow"],"sources":["../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { shallow, useSelector } 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 { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: SolidAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface SolidAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Solid component that allows you to subscribe to the rate limiter state.\n   *\n   * This is useful for tracking specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>\n   *   {(state) => (\n   *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\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   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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 `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\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 approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\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 * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 `rateLimiter.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 * - `currentWindowStart`: Timestamp when the current window started\n * - `executionCount`: Number of function executions that have been completed\n * - `hasError`: Whether the last execution resulted in an error\n * - `isExecuting`: Whether an async function execution is currently in progress\n * - `lastError`: The error from the most recent failed execution (if any)\n * - `lastResult`: The result from the most recent successful execution\n * - `nextWindowTime`: Timestamp when the next window begins\n * - `rejectionCount`: Number of function calls that were rejected due to rate limiting\n * - `remainingInWindow`: Number of executions remaining in the current window\n *\n * ## Unmount behavior\n *\n * By default, the primitive aborts any in-flight execution when the owning component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe component\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>\n *   {(state) => (\n *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to track execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to track results when available (optimized for data display)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to track error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to track execution metrics changes (optimized for stats display)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to track execution times changes (optimized for window calculations)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();\n * ```\n */\nexport function createAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: SolidAsyncRateLimiterOptions<TFn, TSelected>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as SolidAsyncRateLimiterOptions<TFn, TSelected>\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidAsyncRateLimiter<TFn, TSelected>\n\n  asyncRateLimiter.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(asyncRateLimiter.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(asyncRateLimiter.store, selector, {\n    compare: shallow,\n  })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncRateLimiter)\n      } else {\n        asyncRateLimiter.abort()\n      }\n    })\n  })\n\n  return {\n    ...asyncRateLimiter,\n    state,\n  } as SolidAsyncRateLimiter<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2NA,SAAgB,uBAId,IACA,SACA,kBACG,CAAC,IACmC;CACvC,MAAM,gBAAgB;EACpB,GAAGA,6CAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,mBAAmB,IAAIC,oDAC3B,IACA,aACF;CAEA,iBAAiB,YAAY,SAAS,UAAqB,OAGxD;EACD,MAAM,eAAWC,mCAAY,iBAAiB,OAAO,MAAM,UAAU,EACnE,SAASC,8BACX,CAAC;EAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;CACZ;CAEA,MAAM,YAAQD,mCAAY,iBAAiB,OAAO,UAAU,EAC1D,SAASC,8BACX,CAAC;CAED,iCAAmB;EACjB,8BAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,gBAAgB;QAExC,iBAAiB,MAAM;EAE3B,CAAC;CACH,CAAC;CAED,OAAO;EACL,GAAG;EACH;CACF;AACF"}

package/dist/async-rate-limiter/createAsyncRateLimiter.d.cts

@@ -1,208 +0,0 @@
-import { Store } from "@tanstack/solid-store";
-import { Accessor, JSX } from "solid-js";
-import { AnyAsyncFunction } from "@tanstack/pacer/types";
-import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
-//#region src/async-rate-limiter/createAsyncRateLimiter.d.ts
-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;
-}
-interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
-  /**
-   * A Solid component that allows you to subscribe to the rate limiter state.
-   *
-   * This is useful for tracking specific parts of the rate limiter state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
-   *   {(state) => (
-   *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
-   *   )}
-   * </rateLimiter.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncRateLimiterState<TFn>) => TSelected;
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element;
-  }) => JSX.Element;
-  /**
-   * Reactive state that will be updated when the rate limiter state changes
-   *
-   * Use this instead of `rateLimiter.store.state`
-   */
-  readonly state: Accessor<Readonly<TSelected>>;
-  /**
-   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
-   * Although, you can make the state reactive by using the `useSelector` in your own usage.
-   */
-  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
-}
-/**
- * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
- *
- * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
- * you can integrate with any state management solution (createSignal, etc).
- *
- * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
- * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
- * all executions happen immediately, followed by a complete block.
- *
- * 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.
- *
- * 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.
- *
- * For smoother execution patterns, consider using:
- * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
- * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
- *
- * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
- * smoothing out frequent events, throttling or debouncing usually provide better user experience.
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and rate limiter 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 AsyncRateLimiter instance
- * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `rateLimiter.Subscribe` component (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` component to subscribe to state changes deep in your component tree without
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
- * in child components.
- *
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
- *
- * The `selector` parameter allows you to specify which state changes will trigger reactive updates
- * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant
- * state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary
- * updates and gives you full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `currentWindowStart`: Timestamp when the current window started
- * - `executionCount`: Number of function executions that have been completed
- * - `hasError`: Whether the last execution resulted in an error
- * - `isExecuting`: Whether an async function execution is currently in progress
- * - `lastError`: The error from the most recent failed execution (if any)
- * - `lastResult`: The result from the most recent successful execution
- * - `nextWindowTime`: Timestamp when the next window begins
- * - `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
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data; // Return value is preserved
- *   },
- *   { limit: 5, window: 1000 } // 5 calls per second
- * );
- *
- * // Subscribe to state changes deep in component tree using Subscribe component
- * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
- *   {(state) => (
- *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
- *   )}
- * </asyncRateLimiter.Subscribe>
- *
- * // Opt-in to track execution state changes at hook level (optimized for loading indicators)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ isExecuting: state.isExecuting })
- * );
- *
- * // Opt-in to track results when available (optimized for data display)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     lastResult: state.lastResult,
- *     successCount: state.successCount
- *   })
- * );
- *
- * // Opt-in to track error/rejection state changes (optimized for error handling)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   {
- *     limit: 5,
- *     window: 1000,
- *     onError: (error) => console.error('API call failed:', error),
- *     onReject: (rateLimiter) => console.log('Rate limit exceeded')
- *   },
- *   (state) => ({
- *     errorCount: state.errorCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to track execution metrics changes (optimized for stats display)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     successCount: state.successCount,
- *     errorCount: state.errorCount,
- *     settleCount: state.settleCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to track execution times changes (optimized for window calculations)
- * const asyncRateLimiter = createAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ executionTimes: state.executionTimes })
- * );
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();
- * ```
- */
-declare function createAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: SolidAsyncRateLimiterOptions<TFn, TSelected>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): SolidAsyncRateLimiter<TFn, TSelected>;
-//#endregion
-export { SolidAsyncRateLimiter, SolidAsyncRateLimiterOptions, createAsyncRateLimiter };
-//# sourceMappingURL=createAsyncRateLimiter.d.cts.map

package/dist/async-rate-limiter/createAsyncRateLimiter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { shallow, useSelector } 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 { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: SolidAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface SolidAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Solid component that allows you to subscribe to the rate limiter state.\n   *\n   * This is useful for tracking specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>\n   *   {(state) => (\n   *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\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   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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 `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\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 approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\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 * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\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 `rateLimiter.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 * - `currentWindowStart`: Timestamp when the current window started\n * - `executionCount`: Number of function executions that have been completed\n * - `hasError`: Whether the last execution resulted in an error\n * - `isExecuting`: Whether an async function execution is currently in progress\n * - `lastError`: The error from the most recent failed execution (if any)\n * - `lastResult`: The result from the most recent successful execution\n * - `nextWindowTime`: Timestamp when the next window begins\n * - `rejectionCount`: Number of function calls that were rejected due to rate limiting\n * - `remainingInWindow`: Number of executions remaining in the current window\n *\n * ## Unmount behavior\n *\n * By default, the primitive aborts any in-flight execution when the owning component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe component\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>\n *   {(state) => (\n *     <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to track execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to track results when available (optimized for data display)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to track error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to track execution metrics changes (optimized for stats display)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to track execution times changes (optimized for window calculations)\n * const asyncRateLimiter = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();\n * ```\n */\nexport function createAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: SolidAsyncRateLimiterOptions<TFn, TSelected>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as SolidAsyncRateLimiterOptions<TFn, TSelected>\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidAsyncRateLimiter<TFn, TSelected>\n\n  asyncRateLimiter.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(asyncRateLimiter.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(asyncRateLimiter.store, selector, {\n    compare: shallow,\n  })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncRateLimiter)\n      } else {\n        asyncRateLimiter.abort()\n      }\n    })\n  })\n\n  return {\n    ...asyncRateLimiter,\n    state,\n  } as SolidAsyncRateLimiter<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2NA,SAAgB,uBAId,IACA,SACA,kBACG,CAAC,IACmC;CACvC,MAAM,gBAAgB;EACpB,GAAG,uBAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,mBAAmB,IAAI,iBAC3B,IACA,aACF;CAEA,iBAAiB,YAAY,SAAS,UAAqB,OAGxD;EACD,MAAM,WAAW,YAAY,iBAAiB,OAAO,MAAM,UAAU,EACnE,SAAS,QACX,CAAC;EAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;CACZ;CAEA,MAAM,QAAQ,YAAY,iBAAiB,OAAO,UAAU,EAC1D,SAAS,QACX,CAAC;CAED,mBAAmB;EACjB,gBAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,gBAAgB;QAExC,iBAAiB,MAAM;EAE3B,CAAC;CACH,CAAC;CAED,OAAO;EACL,GAAG;EACH;CACF;AACF"}

package/dist/async-rate-limiter/index.cjs

@@ -1,11 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_createAsyncRateLimiter = require('./createAsyncRateLimiter.cjs');
-
-exports.createAsyncRateLimiter = require_createAsyncRateLimiter.createAsyncRateLimiter;
-var _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
-Object.keys(_tanstack_pacer_async_rate_limiter).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_async_rate_limiter[k]; }
-  });
-});

package/dist/async-rate-limiter/index.d.cts

@@ -1,3 +0,0 @@
-import { SolidAsyncRateLimiter, SolidAsyncRateLimiterOptions, createAsyncRateLimiter } from "./createAsyncRateLimiter.cjs";
-export * from "@tanstack/pacer/async-rate-limiter";
-export { SolidAsyncRateLimiter, SolidAsyncRateLimiterOptions, createAsyncRateLimiter };

package/dist/async-throttler/createAsyncThrottler.cjs

@@ -1,151 +0,0 @@
-const require_PacerProvider = require('../provider/PacerProvider.cjs');
-let solid_js = require("solid-js");
-let _tanstack_solid_store = require("@tanstack/solid-store");
-let _tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler");
-
-//#region src/async-throttler/createAsyncThrottler.ts
-/**
-* A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
-*
-* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
-* you can integrate with any state management solution (createSignal, etc).
-*
-* Async throttling ensures an async function executes at most once within a specified time window,
-* regardless of how many times it is called. This is useful for rate-limiting expensive API calls,
-* database operations, or other async tasks.
-*
-* Unlike the non-async Throttler, this async version supports returning values from the throttled 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 throttled function.
-*
-* Error Handling:
-* - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler instance
-*
-* ## State Management and Selector
-*
-* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
-* in two ways:
-*
-* **1. Using `throttler.Subscribe` component (Recommended for component tree subscriptions)**
-*
-* Use the `Subscribe` component to subscribe to state changes deep in your component tree without
-* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
-* in child components.
-*
-* **2. Using the `selector` parameter (For hook-level subscriptions)**
-*
-* The `selector` parameter allows you to specify which state changes will trigger reactive updates
-* at the hook level, optimizing performance by preventing unnecessary updates when irrelevant
-* state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary
-* updates and gives you full control over when your component tracks state changes.
-*
-* Available state properties:
-* - `canLeadingExecute`: Whether the throttler can execute on the leading edge
-* - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
-* - `executionCount`: Number of function executions that have been completed
-* - `hasError`: Whether the last execution resulted in an error
-* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
-* - `isExecuting`: Whether an async function execution is currently in progress
-* - `lastArgs`: The arguments from the most recent call to maybeExecute
-* - `lastError`: The error from the most recent failed execution (if any)
-* - `lastExecutionTime`: Timestamp of the last execution
-* - `lastResult`: The result from the most recent successful execution
-* - `nextExecutionTime`: Timestamp of the next allowed 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 throttler = createAsyncThrottler(fn, {
-*   wait: 1000,
-*   onUnmount: (t) => t.flush()
-* });
-* ```
-*
-* Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
-* If your throttled 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
-* const { maybeExecute } = createAsyncThrottler(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { wait: 1000 }
-* );
-*
-* // Opt-in to track isPending or isExecuting changes (optimized for loading states)
-* const throttler = createAsyncThrottler(
-*   async (query) => {
-*     const result = await searchAPI(query);
-*     return result;
-*   },
-*   { wait: 2000 },
-*   (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })
-* );
-*
-* // Opt-in to track error state changes (optimized for error handling)
-* const throttler = createAsyncThrottler(
-*   async (query) => {
-*     const result = await searchAPI(query);
-*     return result;
-*   },
-*   {
-*     wait: 2000,
-*     leading: true,   // Execute immediately on first call
-*     trailing: false, // Skip trailing edge updates
-*     onError: (error) => {
-*       console.error('API call failed:', error);
-*     }
-*   },
-*   (state) => ({ hasError: state.hasError, lastError: state.lastError })
-* );
-*
-* // Access the selected state (will be empty object {} unless selector provided)
-* const { isPending, isExecuting } = throttler.state();
-* ```
-*/
-function createAsyncThrottler(fn, options, selector = () => ({})) {
-	const mergedOptions = {
-		...require_PacerProvider.useDefaultPacerOptions().asyncThrottler,
-		...options
-	};
-	const asyncThrottler = new _tanstack_pacer_async_throttler.AsyncThrottler(fn, mergedOptions);
-	asyncThrottler.Subscribe = function Subscribe(props) {
-		const selected = (0, _tanstack_solid_store.useSelector)(asyncThrottler.store, props.selector, { compare: _tanstack_solid_store.shallow });
-		return typeof props.children === "function" ? props.children(selected) : props.children;
-	};
-	const state = (0, _tanstack_solid_store.useSelector)(asyncThrottler.store, selector, { compare: _tanstack_solid_store.shallow });
-	(0, solid_js.createEffect)(() => {
-		(0, solid_js.onCleanup)(() => {
-			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncThrottler);
-			else {
-				asyncThrottler.cancel();
-				asyncThrottler.abort();
-			}
-		});
-	});
-	return {
-		...asyncThrottler,
-		state
-	};
-}
-
-//#endregion
-exports.createAsyncThrottler = createAsyncThrottler;
-//# sourceMappingURL=createAsyncThrottler.cjs.map

package/dist/async-throttler/createAsyncThrottler.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createAsyncThrottler.cjs","names":["useDefaultPacerOptions","AsyncThrottler","useSelector","shallow"],"sources":["../../src/async-throttler/createAsyncThrottler.ts"],"sourcesContent":["import { createEffect, onCleanup } from 'solid-js'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { shallow, useSelector } 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 { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncThrottlerOptions,\n  AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\n\nexport interface SolidAsyncThrottlerOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncThrottlerOptions<TFn> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the throttler instance.\n   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n   */\n  onUnmount?: (throttler: SolidAsyncThrottler<TFn, TSelected>) => void\n}\n\nexport interface SolidAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncThrottler<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, isExecuting: state.isExecuting })}>\n   *   {(state) => (\n   *     <div>{state().isPending ? 'Pending...' : state().isExecuting ? 'Executing...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncThrottlerState<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 `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async 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, etc).\n *\n * Async throttling ensures an async 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 expensive API calls,\n * database operations, or other async tasks.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncThrottler instance\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 * - `hasError`: Whether the last execution resulted in an error\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `isExecuting`: Whether an async function execution is currently in progress\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastError`: The error from the most recent failed execution (if any)\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `lastResult`: The result from the most recent successful execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing')\n *\n * ## Unmount behavior\n *\n * By default, the primitive cancels any pending execution and aborts any in-flight execution when the owning component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const throttler = createAsyncThrottler(fn, {\n *   wait: 1000,\n *   onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your throttled function updates Solid signals, those updates may run after the component has\n * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when\n * using onUnmount with flush.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const { maybeExecute } = createAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 }\n * );\n *\n * // Opt-in to track isPending or isExecuting changes (optimized for loading states)\n * const throttler = createAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   { wait: 2000 },\n *   (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to track error state changes (optimized for error handling)\n * const throttler = createAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false, // Skip trailing edge updates\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   },\n *   (state) => ({ hasError: state.hasError, lastError: state.lastError })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending, isExecuting } = throttler.state();\n * ```\n */\nexport function createAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: SolidAsyncThrottlerOptions<TFn, TSelected>,\n  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncThrottler,\n    ...options,\n  } as SolidAsyncThrottlerOptions<TFn, TSelected>\n  const asyncThrottler = new AsyncThrottler(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidAsyncThrottler<TFn, TSelected>\n\n  asyncThrottler.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: AsyncThrottlerState<TFn>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(asyncThrottler.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(asyncThrottler.store, selector, {\n    compare: shallow,\n  })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncThrottler)\n      } else {\n        asyncThrottler.cancel()\n        asyncThrottler.abort()\n      }\n    })\n  })\n\n  return {\n    ...asyncThrottler,\n    state,\n  } as SolidAsyncThrottler<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8KA,SAAgB,qBAId,IACA,SACA,kBACG,CAAC,IACiC;CACrC,MAAM,gBAAgB;EACpB,GAAGA,6CAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CACA,MAAM,iBAAiB,IAAIC,+CACzB,IACA,aACF;CAEA,eAAe,YAAY,SAAS,UAAqB,OAGtD;EACD,MAAM,eAAWC,mCAAY,eAAe,OAAO,MAAM,UAAU,EACjE,SAASC,8BACX,CAAC;EAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;CACZ;CAEA,MAAM,YAAQD,mCAAY,eAAe,OAAO,UAAU,EACxD,SAASC,8BACX,CAAC;CAED,iCAAmB;EACjB,8BAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,cAAc;QACjC;IACL,eAAe,OAAO;IACtB,eAAe,MAAM;GACvB;EACF,CAAC;CACH,CAAC;CAED,OAAO;EACL,GAAG;EACH;CACF;AACF"}