@tanstack/preact-pacer 0.0.1 → 0.18.0

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

@@ -0,0 +1,173 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { AsyncRateLimiter } from "@tanstack/pacer/async-rate-limiter";
+
+//#region src/async-rate-limiter/useAsyncRateLimiter.ts
+/**
+* A low-level Preact 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 (useState, Redux, Zustand, Jotai, etc).
+*
+* Rate limiting allows an async function to execute up to a specified limit within a time window,
+* then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
+* managing resource constraints, or controlling bursts of async operations.
+*
+* Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+* making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+* instead of setting the result on a state variable from within the rate-limited function.
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All executions within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+*   consistent rate of execution over time.
+*
+* 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:
+* - `errorCount`: Number of function executions that have resulted in errors
+* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+* - `isExecuting`: Whether the rate-limited function is currently executing asynchronously
+* - `lastResult`: The result from the most recent successful function execution
+* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+* - `settleCount`: Number of function executions that have completed (success or error)
+* - `successCount`: Number of function executions that have completed successfully
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   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 execution state changes (optimized for loading indicators)
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { limit: 5, window: 1000 },
+*   (state) => ({ isExecuting: state.isExecuting })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   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 re-render when error/rejection state changes (optimized for error handling)
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   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 re-render when execution metrics change (optimized for stats display)
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   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 re-render when execution times change (optimized for window calculations)
+* const asyncRateLimiter = useAsyncRateLimiter(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { limit: 5, window: 1000 },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // With state management and return value
+* const [data, setData] = useState(null);
+* const { maybeExecute, state } = useAsyncRateLimiter(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     setData(result);
+*     return result; // Return value can be used by the caller
+*   },
+*   {
+*     limit: 10,
+*     window: 60000, // 10 calls per minute
+*     onReject: (rateLimiter) => {
+*       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*     },
+*     onError: (error) => {
+*       console.error('API call failed:', error);
+*     }
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { isExecuting, lastResult, rejectionCount } = state;
+* ```
+*/
+function useAsyncRateLimiter(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().asyncRateLimiter,
+		...options
+	};
+	const [asyncRateLimiter] = useState(() => new AsyncRateLimiter(fn, mergedOptions));
+	asyncRateLimiter.fn = fn;
+	asyncRateLimiter.setOptions(mergedOptions);
+	const state = useStore(asyncRateLimiter.store, selector);
+	return useMemo(() => ({
+		...asyncRateLimiter,
+		state
+	}), [asyncRateLimiter, state]);
+}
+
+//#endregion
+export { useAsyncRateLimiter };
+//# sourceMappingURL=useAsyncRateLimiter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncRateLimiter.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\n\nexport interface ReactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: 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 Preact 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 (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\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 * 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 * 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 * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\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 execution state changes (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\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 re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\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 re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\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 re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\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 re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\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 * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as AsyncRateLimiterOptions<TFn>\n\n  const [asyncRateLimiter] = useState(\n    () => new AsyncRateLimiter<TFn>(fn, mergedOptions),\n  )\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(asyncRateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as ReactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkLA,SAAgB,oBAId,IACA,SACA,kBACG,EAAE,GACkC;CACvC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,oBAAoB,eACnB,IAAI,iBAAsB,IAAI,cAAc,CACnD;AAED,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,QAAQ,SAAS,iBAAiB,OAAO,SAAS;AAExD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}

package/dist/async-retryer/index.cjs

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

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

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/async-retryer";

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

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/async-retryer";

package/dist/async-retryer/index.js

@@ -0,0 +1,3 @@
+export * from "@tanstack/pacer/async-retryer"
+
+export {  };

package/dist/async-throttler/index.cjs

@@ -0,0 +1,12 @@
+const require_useAsyncThrottler = require('./useAsyncThrottler.cjs');
+const require_useAsyncThrottledCallback = require('./useAsyncThrottledCallback.cjs');
+
+exports.useAsyncThrottledCallback = require_useAsyncThrottledCallback.useAsyncThrottledCallback;
+exports.useAsyncThrottler = require_useAsyncThrottler.useAsyncThrottler;
+var __tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler");
+Object.keys(__tanstack_pacer_async_throttler).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_async_throttler[k]; }
+  });
+});

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

@@ -0,0 +1,4 @@
+import { ReactAsyncThrottler, useAsyncThrottler } from "./useAsyncThrottler.cjs";
+import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.cjs";
+export * from "@tanstack/pacer/async-throttler";
+export { ReactAsyncThrottler, useAsyncThrottledCallback, useAsyncThrottler };

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

@@ -0,0 +1,4 @@
+import { ReactAsyncThrottler, useAsyncThrottler } from "./useAsyncThrottler.js";
+import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.js";
+export * from "@tanstack/pacer/async-throttler";
+export { ReactAsyncThrottler, useAsyncThrottledCallback, useAsyncThrottler };

package/dist/async-throttler/index.js

@@ -0,0 +1,6 @@
+import { useAsyncThrottler } from "./useAsyncThrottler.js";
+import { useAsyncThrottledCallback } from "./useAsyncThrottledCallback.js";
+
+export * from "@tanstack/pacer/async-throttler"
+
+export { useAsyncThrottledCallback, useAsyncThrottler };

package/dist/async-throttler/useAsyncThrottledCallback.cjs

@@ -0,0 +1,48 @@
+const require_useAsyncThrottler = require('./useAsyncThrottler.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/async-throttler/useAsyncThrottledCallback.ts
+/**
+* A Preact hook that creates a throttled version of an async callback function.
+* This hook is a convenient wrapper around the `useAsyncThrottler` hook,
+* providing a stable, throttled async function reference for use in Preact components.
+*
+* The throttled async function will execute at most once within the specified wait time period,
+* regardless of how many times it is called. If called multiple times during the wait period,
+* only the first invocation will execute, and subsequent calls will be ignored until
+* the wait period has elapsed. The returned function always returns a promise
+* that resolves or rejects with the result of the original async function.
+*
+* This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
+* async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution/error state
+* - Custom useCallback dependencies
+*
+* Consider using the `useAsyncThrottler` hook instead.
+*
+*
+* @example
+* ```tsx
+* // Throttle an async API call
+* const handleApiCall = useAsyncThrottledCallback(async (data) => {
+*   const result = await sendDataToServer(data);
+*   return result;
+* }, {
+*   wait: 200 // Execute at most once every 200ms
+* });
+*
+* // Use in an event handler
+* <button onClick={() => handleApiCall(formData)}>Send</button>
+* ```
+*/
+function useAsyncThrottledCallback(fn, options) {
+	const asyncThrottledFn = require_useAsyncThrottler.useAsyncThrottler(fn, options).maybeExecute;
+	return (0, preact_hooks.useCallback)((...args) => asyncThrottledFn(...args), [asyncThrottledFn]);
+}
+
+//#endregion
+exports.useAsyncThrottledCallback = useAsyncThrottledCallback;
+//# sourceMappingURL=useAsyncThrottledCallback.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncThrottledCallback.cjs","names":["useAsyncThrottler"],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmBA,4CAAkB,IAAI,QAAQ,CAAC;AACxD,uCACG,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}

package/dist/async-throttler/useAsyncThrottledCallback.d.cts

@@ -0,0 +1,45 @@
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+import { AsyncThrottlerOptions } from "@tanstack/pacer/async-throttler";
+
+//#region src/async-throttler/useAsyncThrottledCallback.d.ts
+
+/**
+ * A Preact hook that creates a throttled version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncThrottler` hook,
+ * providing a stable, throttled async function reference for use in Preact components.
+ *
+ * The throttled async function will execute at most once within the specified wait time period,
+ * regardless of how many times it is called. If called multiple times during the wait period,
+ * only the first invocation will execute, and subsequent calls will be ignored until
+ * the wait period has elapsed. The returned function always returns a promise
+ * that resolves or rejects with the result of the original async function.
+ *
+ * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
+ * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution/error state
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncThrottler` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Throttle an async API call
+ * const handleApiCall = useAsyncThrottledCallback(async (data) => {
+ *   const result = await sendDataToServer(data);
+ *   return result;
+ * }, {
+ *   wait: 200 // Execute at most once every 200ms
+ * });
+ *
+ * // Use in an event handler
+ * <button onClick={() => handleApiCall(formData)}>Send</button>
+ * ```
+ */
+declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncThrottledCallback };
+//# sourceMappingURL=useAsyncThrottledCallback.d.cts.map

package/dist/async-throttler/useAsyncThrottledCallback.d.ts

@@ -0,0 +1,45 @@
+import { AsyncThrottlerOptions } from "@tanstack/pacer/async-throttler";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-throttler/useAsyncThrottledCallback.d.ts
+
+/**
+ * A Preact hook that creates a throttled version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncThrottler` hook,
+ * providing a stable, throttled async function reference for use in Preact components.
+ *
+ * The throttled async function will execute at most once within the specified wait time period,
+ * regardless of how many times it is called. If called multiple times during the wait period,
+ * only the first invocation will execute, and subsequent calls will be ignored until
+ * the wait period has elapsed. The returned function always returns a promise
+ * that resolves or rejects with the result of the original async function.
+ *
+ * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
+ * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution/error state
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncThrottler` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Throttle an async API call
+ * const handleApiCall = useAsyncThrottledCallback(async (data) => {
+ *   const result = await sendDataToServer(data);
+ *   return result;
+ * }, {
+ *   wait: 200 // Execute at most once every 200ms
+ * });
+ *
+ * // Use in an event handler
+ * <button onClick={() => handleApiCall(formData)}>Send</button>
+ * ```
+ */
+declare function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncThrottledCallback };
+//# sourceMappingURL=useAsyncThrottledCallback.d.ts.map

package/dist/async-throttler/useAsyncThrottledCallback.js

@@ -0,0 +1,48 @@
+import { useAsyncThrottler } from "./useAsyncThrottler.js";
+import { useCallback } from "preact/hooks";
+
+//#region src/async-throttler/useAsyncThrottledCallback.ts
+/**
+* A Preact hook that creates a throttled version of an async callback function.
+* This hook is a convenient wrapper around the `useAsyncThrottler` hook,
+* providing a stable, throttled async function reference for use in Preact components.
+*
+* The throttled async function will execute at most once within the specified wait time period,
+* regardless of how many times it is called. If called multiple times during the wait period,
+* only the first invocation will execute, and subsequent calls will be ignored until
+* the wait period has elapsed. The returned function always returns a promise
+* that resolves or rejects with the result of the original async function.
+*
+* This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic
+* async throttling needs. However, it does not expose the underlying AsyncThrottler instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution/error state
+* - Custom useCallback dependencies
+*
+* Consider using the `useAsyncThrottler` hook instead.
+*
+*
+* @example
+* ```tsx
+* // Throttle an async API call
+* const handleApiCall = useAsyncThrottledCallback(async (data) => {
+*   const result = await sendDataToServer(data);
+*   return result;
+* }, {
+*   wait: 200 // Execute at most once every 200ms
+* });
+*
+* // Use in an event handler
+* <button onClick={() => handleApiCall(formData)}>Send</button>
+* ```
+*/
+function useAsyncThrottledCallback(fn, options) {
+	const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute;
+	return useCallback((...args) => asyncThrottledFn(...args), [asyncThrottledFn]);
+}
+
+//#endregion
+export { useAsyncThrottledCallback };
+//# sourceMappingURL=useAsyncThrottledCallback.js.map

package/dist/async-throttler/useAsyncThrottledCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncThrottledCallback.js","names":[],"sources":["../../src/async-throttler/useAsyncThrottledCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncThrottler } from './useAsyncThrottler'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\n\n/**\n * A Preact hook that creates a throttled version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncThrottler` hook,\n * providing a stable, throttled async function reference for use in Preact components.\n *\n * The throttled async function will execute at most once within the specified wait time period,\n * regardless of how many times it is called. If called multiple times during the wait period,\n * only the first invocation will execute, and subsequent calls will be ignored until\n * the wait period has elapsed. The returned function always returns a promise\n * that resolves or rejects with the result of the original async function.\n *\n * This hook provides a simpler API compared to `useAsyncThrottler`, making it ideal for basic\n * async throttling needs. However, it does not expose the underlying AsyncThrottler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution/error state\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncThrottler` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Throttle an async API call\n * const handleApiCall = useAsyncThrottledCallback(async (data) => {\n *   const result = await sendDataToServer(data);\n *   return result;\n * }, {\n *   wait: 200 // Execute at most once every 200ms\n * });\n *\n * // Use in an event handler\n * <button onClick={() => handleApiCall(formData)}>Send</button>\n * ```\n */\nexport function useAsyncThrottledCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncThrottledFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncThrottledFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,0BACd,IACA,SACwD;CACxD,MAAM,mBAAmB,kBAAkB,IAAI,QAAQ,CAAC;AACxD,QAAO,aACJ,GAAG,SACF,iBAAiB,GAAG,KAAK,EAC3B,CAAC,iBAAiB,CACnB"}

package/dist/async-throttler/useAsyncThrottler.cjs

@@ -0,0 +1,158 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let __tanstack_preact_store = require("@tanstack/preact-store");
+let __tanstack_pacer_async_throttler = require("@tanstack/pacer/async-throttler");
+
+//#region src/async-throttler/useAsyncThrottler.ts
+/**
+* A low-level Preact 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 (useState, Redux, Zustand, Jotai, 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. 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:
+* - `errorCount`: Number of function executions that have resulted in errors
+* - `isExecuting`: Whether the throttled function is currently executing asynchronously
+* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
+* - `lastResult`: The result from the most recent successful function execution
+* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
+* - `settleCount`: Number of function executions that have completed (success or error)
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
+* - `successCount`: Number of function executions that have completed successfully
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data; // Return value is preserved
+*   },
+*   { wait: 1000 }
+* );
+*
+* // Opt-in to re-render when execution state changes (optimized for loading indicators)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     isExecuting: state.isExecuting,
+*     isPending: state.isPending,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount,
+*     settleCount: state.settleCount
+*   })
+* );
+*
+* // Opt-in to re-render when error state changes (optimized for error handling)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   {
+*     wait: 1000,
+*     onError: (error) => console.error('API call failed:', error)
+*   },
+*   (state) => ({
+*     errorCount: state.errorCount,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when timing information changes (optimized for timing displays)
+* const asyncThrottler = useAsyncThrottler(
+*   async (id: string) => {
+*     const data = await api.fetchData(id);
+*     return data;
+*   },
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With state management and return value
+* const [data, setData] = useState(null);
+* const { maybeExecute, state } = useAsyncThrottler(
+*   async (query) => {
+*     const result = await searchAPI(query);
+*     setData(result);
+*     return result; // Return value can be used by the caller
+*   },
+*   {
+*     wait: 2000,
+*     leading: true,   // Execute immediately on first call
+*     trailing: false  // Skip trailing edge updates
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { isExecuting, lastResult } = state;
+* ```
+*/
+function useAsyncThrottler(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().asyncThrottler,
+		...options
+	};
+	const [asyncThrottler] = (0, preact_hooks.useState)(() => new __tanstack_pacer_async_throttler.AsyncThrottler(fn, mergedOptions));
+	asyncThrottler.fn = fn;
+	asyncThrottler.setOptions(mergedOptions);
+	const state = (0, __tanstack_preact_store.useStore)(asyncThrottler.store, selector);
+	(0, preact_hooks.useEffect)(() => {
+		return () => asyncThrottler.cancel();
+	}, [asyncThrottler]);
+	return (0, preact_hooks.useMemo)(() => ({
+		...asyncThrottler,
+		state
+	}), [asyncThrottler, state]);
+}
+
+//#endregion
+exports.useAsyncThrottler = useAsyncThrottler;
+//# sourceMappingURL=useAsyncThrottler.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncThrottler.cjs","names":["useDefaultPacerOptions","AsyncThrottler"],"sources":["../../src/async-throttler/useAsyncThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncThrottlerOptions,\n  AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\n\nexport interface ReactAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n  /**\n   * Reactive state that will be updated and re-rendered when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact 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 (useState, Redux, Zustand, Jotai, 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. 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 * - `errorCount`: Number of function executions that have resulted in errors\n * - `isExecuting`: Whether the throttled function is currently executing asynchronously\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `lastResult`: The result from the most recent successful function execution\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')\n * - `successCount`: Number of function executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { wait: 1000 }\n * );\n *\n * // Opt-in to re-render when execution state changes (optimized for loading indicators)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     isExecuting: state.isExecuting,\n *     isPending: state.isPending,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount,\n *     settleCount: state.settleCount\n *   })\n * );\n *\n * // Opt-in to re-render when error state changes (optimized for error handling)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     wait: 1000,\n *     onError: (error) => console.error('API call failed:', error)\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const asyncThrottler = useAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 },\n *   (state) => ({\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult } = state;\n * ```\n */\nexport function useAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncThrottler,\n    ...options,\n  } as AsyncThrottlerOptions<TFn>\n\n  const [asyncThrottler] = useState(\n    () => new AsyncThrottler<TFn>(fn, mergedOptions),\n  )\n\n  asyncThrottler.fn = fn\n  asyncThrottler.setOptions(mergedOptions)\n\n  const state = useStore(asyncThrottler.store, selector)\n\n  useEffect(() => {\n    return () => asyncThrottler.cancel()\n  }, [asyncThrottler])\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncThrottler,\n        state,\n      }) as ReactAsyncThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncThrottler, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgKA,SAAgB,kBACd,IACA,SACA,kBACG,EAAE,GACgC;CACrC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,mDACC,IAAIC,gDAAoB,IAAI,cAAc,CACjD;AAED,gBAAe,KAAK;AACpB,gBAAe,WAAW,cAAc;CAExC,MAAM,8CAAiB,eAAe,OAAO,SAAS;AAEtD,mCAAgB;AACd,eAAa,eAAe,QAAQ;IACnC,CAAC,eAAe,CAAC;AAEpB,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,gBAAgB,MAAM,CACxB"}