@tanstack/preact-pacer 0.0.1 → 0.18.0

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

@@ -0,0 +1,173 @@
+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_rate_limiter = require("@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 = {
+		...require_PacerProvider.useDefaultPacerOptions().asyncRateLimiter,
+		...options
+	};
+	const [asyncRateLimiter] = (0, preact_hooks.useState)(() => new __tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, mergedOptions));
+	asyncRateLimiter.fn = fn;
+	asyncRateLimiter.setOptions(mergedOptions);
+	const state = (0, __tanstack_preact_store.useStore)(asyncRateLimiter.store, selector);
+	return (0, preact_hooks.useMemo)(() => ({
+		...asyncRateLimiter,
+		state
+	}), [asyncRateLimiter, state]);
+}
+
+//#endregion
+exports.useAsyncRateLimiter = useAsyncRateLimiter;
+//# sourceMappingURL=useAsyncRateLimiter.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","AsyncRateLimiter"],"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,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,qDACC,IAAIC,qDAAsB,IAAI,cAAc,CACnD;AAED,kBAAiB,KAAK;AACtB,kBAAiB,WAAW,cAAc;CAE1C,MAAM,8CAAiB,iBAAiB,OAAO,SAAS;AAExD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,kBAAkB,MAAM,CAC1B"}

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

@@ -0,0 +1,172 @@
+import { Store } from "@tanstack/preact-store";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
+
+//#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
+interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the rate limiter state changes
+   *
+   * Use this instead of `rateLimiter.store.state`
+   */
+  readonly state: 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 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;
+ * ```
+ */
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): ReactAsyncRateLimiter<TFn, TSelected>;
+//#endregion
+export { ReactAsyncRateLimiter, useAsyncRateLimiter };
+//# sourceMappingURL=useAsyncRateLimiter.d.cts.map

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

@@ -0,0 +1,172 @@
+import { Store } from "@tanstack/preact-store";
+import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
+interface ReactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated and re-rendered when the rate limiter state changes
+   *
+   * Use this instead of `rateLimiter.store.state`
+   */
+  readonly state: 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 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;
+ * ```
+ */
+declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncRateLimiterOptions<TFn>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): ReactAsyncRateLimiter<TFn, TSelected>;
+//#endregion
+export { ReactAsyncRateLimiter, useAsyncRateLimiter };
+//# sourceMappingURL=useAsyncRateLimiter.d.ts.map