@tanstack/solid-pacer 0.15.3 → 0.16.1

package/dist/async-queuer/createAsyncQueuer.js

@@ -0,0 +1,114 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useStore } from "@tanstack/solid-store";
+import { AsyncQueuer } from "@tanstack/pacer/async-queuer";
+
+//#region src/async-queuer/createAsyncQueuer.ts
+/**
+* Creates a Solid-compatible AsyncQueuer instance for managing an asynchronous queue of items, exposing Solid signals for all stateful properties.
+*
+* Features:
+* - Priority queueing via `getPriority` or item `priority` property
+* - Configurable concurrency limit
+* - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
+* - Pause/resume processing
+* - Task cancellation
+* - Item expiration
+* - Lifecycle callbacks for success, error, settled, items change, etc.
+* - All stateful properties (active items, pending items, counts, etc.) are exposed as Solid signals for reactivity
+*
+* Tasks are processed concurrently up to the configured concurrency limit. When a task completes,
+* the next pending task is processed if the concurrency limit allows.
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and queuer 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 AsyncQueuer instance
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, optimizing performance by preventing
+* unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `activeItems`: Array of items currently being processed
+* - `errorCount`: Number of items that failed processing
+* - `isRunning`: Whether the queuer is currently running (not stopped)
+* - `pendingItems`: Array of items waiting to be processed
+* - `rejectionCount`: Number of items that were rejected (expired or failed validation)
+* - `settleCount`: Number of items that have completed processing (successful or failed)
+* - `successCount`: Number of items that were processed successfully
+*
+* Example usage:
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const asyncQueuer = createAsyncQueuer(async (item) => {
+*   // process item
+*   return await fetchData(item);
+* }, {
+*   initialItems: [],
+*   concurrency: 2,
+*   maxSize: 100,
+*   started: false,
+*   onSuccess: (result) => {
+*     console.log('Item processed:', result);
+*   },
+*   onError: (error) => {
+*     console.error('Processing failed:', error);
+*   }
+* });
+*
+* // Opt-in to re-render when queue state changes (optimized for UI updates)
+* const asyncQueuer = createAsyncQueuer(
+*   async (item) => await fetchData(item),
+*   { concurrency: 2, started: true },
+*   (state) => ({
+*     pendingItems: state.pendingItems,
+*     activeItems: state.activeItems,
+*     isRunning: state.isRunning
+*   })
+* );
+*
+* // Opt-in to re-render when processing metrics change (optimized for tracking progress)
+* const asyncQueuer = createAsyncQueuer(
+*   async (item) => await fetchData(item),
+*   { concurrency: 2, started: true },
+*   (state) => ({
+*     successCount: state.successCount,
+*     errorCount: state.errorCount,
+*     settleCount: state.settleCount
+*   })
+* );
+*
+* // Add items to queue
+* asyncQueuer.addItem(newItem);
+*
+* // Start processing
+* asyncQueuer.start();
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { pendingItems, activeItems } = asyncQueuer.state();
+* ```
+*/
+function createAsyncQueuer(fn, options = {}, selector = () => ({})) {
+	const asyncQueuer = new AsyncQueuer(fn, {
+		...useDefaultPacerOptions().asyncQueuer,
+		...options
+	});
+	const state = useStore(asyncQueuer.store, selector);
+	return {
+		...asyncQueuer,
+		state
+	};
+}
+
+//#endregion
+export { createAsyncQueuer };
+//# sourceMappingURL=createAsyncQueuer.js.map

package/dist/async-queuer/createAsyncQueuer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/createAsyncQueuer.ts"],"sourcesContent":["import { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\nexport interface SolidAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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<AsyncQueuerState<TValue>>>\n}\n\n/**\n * Creates a Solid-compatible AsyncQueuer instance for managing an asynchronous queue of items, exposing Solid signals for all stateful properties.\n *\n * Features:\n * - Priority queueing via `getPriority` or item `priority` property\n * - Configurable concurrency limit\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume processing\n * - Task cancellation\n * - Item expiration\n * - Lifecycle callbacks for success, error, settled, items change, etc.\n * - All stateful properties (active items, pending items, counts, etc.) are exposed as Solid signals for reactivity\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if the concurrency limit allows.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and queuer 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 AsyncQueuer instance\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `activeItems`: Array of items currently being processed\n * - `errorCount`: Number of items that failed processing\n * - `isRunning`: Whether the queuer is currently running (not stopped)\n * - `pendingItems`: Array of items waiting to be processed\n * - `rejectionCount`: Number of items that were rejected (expired or failed validation)\n * - `settleCount`: Number of items that have completed processing (successful or failed)\n * - `successCount`: Number of items that were processed successfully\n *\n * Example usage:\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncQueuer = createAsyncQueuer(async (item) => {\n *   // process item\n *   return await fetchData(item);\n * }, {\n *   initialItems: [],\n *   concurrency: 2,\n *   maxSize: 100,\n *   started: false,\n *   onSuccess: (result) => {\n *     console.log('Item processed:', result);\n *   },\n *   onError: (error) => {\n *     console.error('Processing failed:', error);\n *   }\n * });\n *\n * // Opt-in to re-render when queue state changes (optimized for UI updates)\n * const asyncQueuer = createAsyncQueuer(\n *   async (item) => await fetchData(item),\n *   { concurrency: 2, started: true },\n *   (state) => ({\n *     pendingItems: state.pendingItems,\n *     activeItems: state.activeItems,\n *     isRunning: state.isRunning\n *   })\n * );\n *\n * // Opt-in to re-render when processing metrics change (optimized for tracking progress)\n * const asyncQueuer = createAsyncQueuer(\n *   async (item) => await fetchData(item),\n *   { concurrency: 2, started: true },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount\n *   })\n * );\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { pendingItems, activeItems } = asyncQueuer.state();\n * ```\n */\nexport function createAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as AsyncQueuerOptions<TValue>\n\n  const asyncQueuer = new AsyncQueuer<TValue>(fn, mergedOptions)\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return {\n    ...asyncQueuer,\n    state,\n  } as SolidAsyncQueuer<TValue, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0HA,SAAgB,kBACd,IACA,UAAsC,EAAE,EACxC,kBACG,EAAE,GACgC;CAMrC,MAAM,cAAc,IAAI,YAAoB,IALtB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAE6D;CAE9D,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/async-queuer/index.cjs

@@ -0,0 +1,10 @@
+const require_createAsyncQueuer = require('./createAsyncQueuer.cjs');
+
+exports.createAsyncQueuer = require_createAsyncQueuer.createAsyncQueuer;
+var __tanstack_pacer_async_queuer = require("@tanstack/pacer/async-queuer");
+Object.keys(__tanstack_pacer_async_queuer).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_async_queuer[k]; }
+  });
+});

package/dist/async-queuer/index.d.cts

@@ -0,0 +1,3 @@
+import { SolidAsyncQueuer, createAsyncQueuer } from "./createAsyncQueuer.cjs";
+export * from "@tanstack/pacer/async-queuer";
+export { SolidAsyncQueuer, createAsyncQueuer };

package/dist/async-queuer/index.d.ts

@@ -0,0 +1,3 @@
+import { SolidAsyncQueuer, createAsyncQueuer } from "./createAsyncQueuer.js";
+export * from "@tanstack/pacer/async-queuer";
+export { SolidAsyncQueuer, createAsyncQueuer };

package/dist/async-queuer/index.js

@@ -0,0 +1,5 @@
+import { createAsyncQueuer } from "./createAsyncQueuer.js";
+
+export * from "@tanstack/pacer/async-queuer"
+
+export { createAsyncQueuer };

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

@@ -0,0 +1,120 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+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. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, optimizing performance by preventing
+* unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `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
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const { maybeExecute } = createAsyncRateLimiter(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data; // Return value is preserved
+*   },
+*   { limit: 5, window: 1000 } // 5 calls per second
+* );
+*
+* // Opt-in to re-render when rate limit and execution state changes (optimized for UI feedback)
+* const rateLimiter = createAsyncRateLimiter(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     return result;
+*   },
+*   { limit: 10, window: 60000 },
+*   (state) => ({
+*     remainingInWindow: state.remainingInWindow,
+*     isExecuting: state.isExecuting,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const rateLimiter = createAsyncRateLimiter(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     return result;
+*   },
+*   {
+*     limit: 10,
+*     window: 60000, // 10 calls per minute
+*     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)
+*   },
+*   (state) => ({ hasError: state.hasError, lastError: state.lastError })
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { remainingInWindow, isExecuting } = rateLimiter.state();
+* ```
+*/
+function createAsyncRateLimiter(fn, options, selector = () => ({})) {
+	const asyncRateLimiter = new __tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, {
+		...require_PacerProvider.useDefaultPacerOptions().asyncRateLimiter,
+		...options
+	});
+	const state = (0, __tanstack_solid_store.useStore)(asyncRateLimiter.store, selector);
+	return {
+		...asyncRateLimiter,
+		state
+	};
+}
+
+//#endregion
+exports.createAsyncRateLimiter = createAsyncRateLimiter;
+//# sourceMappingURL=createAsyncRateLimiter.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createAsyncRateLimiter.cjs","names":["AsyncRateLimiter","useDefaultPacerOptions"],"sources":["../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @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 `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<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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `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 * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const { maybeExecute } = 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 * // Opt-in to re-render when rate limit and execution state changes (optimized for UI feedback)\n * const rateLimiter = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   { limit: 10, window: 60000 },\n *   (state) => ({\n *     remainingInWindow: state.remainingInWindow,\n *     isExecuting: state.isExecuting,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const rateLimiter = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\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 { remainingInWindow, isExecuting } = rateLimiter.state();\n * ```\n */\nexport function createAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return {\n    ...asyncRateLimiter,\n    state,\n  } as SolidAsyncRateLimiter<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiIA,SAAgB,uBAId,IACA,SACA,kBACG,EAAE,GACkC;CAMvC,MAAM,mBAAmB,IAAIA,qDAAsB,IAL7B;EACpB,GAAGC,8CAAwB,CAAC;EAC5B,GAAG;EACJ,CAEoE;CAErE,MAAM,6CAAiB,iBAAiB,OAAO,SAAS;AAExD,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/{cjs/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.cts

@@ -1,20 +1,22 @@
-import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from '@tanstack/pacer/async-rate-limiter';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyAsyncFunction } from '@tanstack/pacer/types';
-export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
-    /**
-     * 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 `useStore` hook internally.
-     * Although, you can make the state reactive by using the `useStore` in your own usage.
-     */
-    readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
+import { Store } from "@tanstack/solid-store";
+import { Accessor } 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 SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` 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.
@@ -116,4 +118,7 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected =
  * const { remainingInWindow, isExecuting } = rateLimiter.state();
  * ```
  */
-export declare function createAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): SolidAsyncRateLimiter<TFn, TSelected>;
+declare function createAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): SolidAsyncRateLimiter<TFn, TSelected>;
+//#endregion
+export { SolidAsyncRateLimiter, createAsyncRateLimiter };
+//# sourceMappingURL=createAsyncRateLimiter.d.cts.map

package/dist/{esm/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.ts

@@ -1,20 +1,22 @@
-import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from '@tanstack/pacer/async-rate-limiter';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyAsyncFunction } from '@tanstack/pacer/types';
-export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
-    /**
-     * 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 `useStore` hook internally.
-     * Although, you can make the state reactive by using the `useStore` in your own usage.
-     */
-    readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
+import { Accessor } from "solid-js";
+import { Store } from "@tanstack/solid-store";
+import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-rate-limiter/createAsyncRateLimiter.d.ts
+interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` 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.
@@ -116,4 +118,7 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected =
  * const { remainingInWindow, isExecuting } = rateLimiter.state();
  * ```
  */
-export declare function createAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): SolidAsyncRateLimiter<TFn, TSelected>;
+declare function createAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): SolidAsyncRateLimiter<TFn, TSelected>;
+//#endregion
+export { SolidAsyncRateLimiter, createAsyncRateLimiter };
+//# sourceMappingURL=createAsyncRateLimiter.d.ts.map

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

@@ -0,0 +1,120 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useStore } from "@tanstack/solid-store";
+import { AsyncRateLimiter } from "@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. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, optimizing performance by preventing
+* unnecessary re-renders when irrelevant state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `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
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const { maybeExecute } = createAsyncRateLimiter(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data; // Return value is preserved
+*   },
+*   { limit: 5, window: 1000 } // 5 calls per second
+* );
+*
+* // Opt-in to re-render when rate limit and execution state changes (optimized for UI feedback)
+* const rateLimiter = createAsyncRateLimiter(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     return result;
+*   },
+*   { limit: 10, window: 60000 },
+*   (state) => ({
+*     remainingInWindow: state.remainingInWindow,
+*     isExecuting: state.isExecuting,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const rateLimiter = createAsyncRateLimiter(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     return result;
+*   },
+*   {
+*     limit: 10,
+*     window: 60000, // 10 calls per minute
+*     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)
+*   },
+*   (state) => ({ hasError: state.hasError, lastError: state.lastError })
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { remainingInWindow, isExecuting } = rateLimiter.state();
+* ```
+*/
+function createAsyncRateLimiter(fn, options, selector = () => ({})) {
+	const asyncRateLimiter = new AsyncRateLimiter(fn, {
+		...useDefaultPacerOptions().asyncRateLimiter,
+		...options
+	});
+	const state = useStore(asyncRateLimiter.store, selector);
+	return {
+		...asyncRateLimiter,
+		state
+	};
+}
+
+//#endregion
+export { createAsyncRateLimiter };
+//# sourceMappingURL=createAsyncRateLimiter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @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 `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<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. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `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 * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const { maybeExecute } = 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 * // Opt-in to re-render when rate limit and execution state changes (optimized for UI feedback)\n * const rateLimiter = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   { limit: 10, window: 60000 },\n *   (state) => ({\n *     remainingInWindow: state.remainingInWindow,\n *     isExecuting: state.isExecuting,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const rateLimiter = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     return result;\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\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 { remainingInWindow, isExecuting } = rateLimiter.state();\n * ```\n */\nexport function createAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return {\n    ...asyncRateLimiter,\n    state,\n  } as SolidAsyncRateLimiter<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiIA,SAAgB,uBAId,IACA,SACA,kBACG,EAAE,GACkC;CAMvC,MAAM,mBAAmB,IAAI,iBAAsB,IAL7B;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAEoE;CAErE,MAAM,QAAQ,SAAS,iBAAiB,OAAO,SAAS;AAExD,QAAO;EACL,GAAG;EACH;EACD"}

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+import { createAsyncRateLimiter } from "./createAsyncRateLimiter.js";
+
+export * from "@tanstack/pacer/async-rate-limiter"
+
+export { createAsyncRateLimiter };