@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/async-queuer/useAsyncQueuer.js

@@ -0,0 +1,165 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { AsyncQueuer } from "@tanstack/pacer/async-queuer";
+
+//#region src/async-queuer/useAsyncQueuer.ts
+/**
+* A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.
+*
+* Features:
+* - Priority queue support via getPriority option
+* - Configurable concurrency limit
+* - Task success/error/completion callbacks
+* - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
+* - Pause/resume task processing
+* - Task cancellation
+* - Item expiration to clear stale items from the queue
+*
+* Tasks are processed concurrently up to the configured concurrency limit. When a task completes,
+* the next pending task is processed if below the concurrency limit.
+*
+* 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`: Items currently being processed by the queuer
+* - `errorCount`: Number of task executions that have resulted in errors
+* - `expirationCount`: Number of items that have been removed due to expiration
+* - `isEmpty`: Whether the queuer has no items to process
+* - `isFull`: Whether the queuer has reached its maximum capacity
+* - `isIdle`: Whether the queuer is not currently processing any items
+* - `isRunning`: Whether the queuer is active and will process items automatically
+* - `items`: Array of items currently waiting to be processed
+* - `itemTimestamps`: Timestamps when items were added for expiration tracking
+* - `lastResult`: The result from the most recent task execution
+* - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+* - `rejectionCount`: Number of items that have been rejected from being added
+* - `settledCount`: Number of task executions that have completed (success or error)
+* - `size`: Number of items currently in the queue
+* - `status`: Current processing status ('idle' | 'running' | 'stopped')
+* - `successCount`: Number of task executions that have completed successfully
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const asyncQueuer = useAsyncQueuer(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: false }
+* );
+*
+* // Opt-in to re-render when queue size changes (optimized for displaying queue length)
+* const asyncQueuer = useAsyncQueuer(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: false },
+*   (state) => ({
+*     size: state.size,
+*     isEmpty: state.isEmpty,
+*     isFull: state.isFull
+*   })
+* );
+*
+* // Opt-in to re-render when processing state changes (optimized for loading indicators)
+* const asyncQueuer = useAsyncQueuer(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: false },
+*   (state) => ({
+*     isRunning: state.isRunning,
+*     isIdle: state.isIdle,
+*     status: state.status,
+*     activeItems: state.activeItems,
+*     pendingTick: state.pendingTick
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for stats display)
+* const asyncQueuer = useAsyncQueuer(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   { concurrency: 2, maxSize: 100, started: false },
+*   (state) => ({
+*     successCount: state.successCount,
+*     errorCount: state.errorCount,
+*     settledCount: state.settledCount,
+*     expirationCount: state.expirationCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Opt-in to re-render when results are available (optimized for data display)
+* const asyncQueuer = useAsyncQueuer(
+*   async (item) => {
+*     const result = await processItem(item);
+*     return result;
+*   },
+*   {
+*     concurrency: 2,
+*     maxSize: 100,
+*     started: false,
+*     onSuccess: (result) => {
+*       console.log('Item processed:', result);
+*     },
+*     onError: (error) => {
+*       console.error('Processing failed:', error);
+*     }
+*   },
+*   (state) => ({
+*     lastResult: state.lastResult,
+*     successCount: state.successCount
+*   })
+* );
+*
+* // Add items to queue
+* asyncQueuer.addItem(newItem);
+*
+* // Start processing
+* asyncQueuer.start();
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { size, isRunning, activeItems } = asyncQueuer.state;
+* ```
+*/
+function useAsyncQueuer(fn, options = {}, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().asyncQueuer,
+		...options
+	};
+	const [asyncQueuer] = useState(() => new AsyncQueuer(fn, mergedOptions));
+	asyncQueuer.fn = fn;
+	asyncQueuer.setOptions(mergedOptions);
+	const state = useStore(asyncQueuer.store, selector);
+	return useMemo(() => ({
+		...asyncQueuer,
+		state
+	}), [asyncQueuer, state]);
+}
+
+//#endregion
+export { useAsyncQueuer };
+//# sourceMappingURL=useAsyncQueuer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncQueuer.js","names":[],"sources":["../../src/async-queuer/useAsyncQueuer.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  AsyncQueuerOptions,\n  AsyncQueuerState,\n} from '@tanstack/pacer/async-queuer'\n\nexport interface ReactAsyncQueuer<TValue, TSelected = {}> extends Omit<\n  AsyncQueuer<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: 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 * A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\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`: Items currently being processed by the queuer\n * - `errorCount`: Number of task executions that have resulted in errors\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `lastResult`: The result from the most recent task execution\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `settledCount`: Number of task executions that have completed (success or error)\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n * - `successCount`: Number of task executions that have completed successfully\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false }\n * );\n *\n * // Opt-in to re-render when queue size changes (optimized for displaying queue length)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty,\n *     isFull: state.isFull\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     activeItems: state.activeItems,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   { concurrency: 2, maxSize: 100, started: false },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settledCount: state.settledCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncQueuer = useAsyncQueuer(\n *   async (item) => {\n *     const result = await processItem(item);\n *     return result;\n *   },\n *   {\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 *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\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 { size, isRunning, activeItems } = asyncQueuer.state;\n * ```\n */\nexport function useAsyncQueuer<TValue, TSelected = {}>(\n  fn: (value: TValue) => Promise<any>,\n  options: AsyncQueuerOptions<TValue> = {},\n  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): ReactAsyncQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncQueuer,\n    ...options,\n  } as AsyncQueuerOptions<TValue>\n\n  const [asyncQueuer] = useState(\n    () => new AsyncQueuer<TValue>(fn, mergedOptions),\n  )\n\n  asyncQueuer.fn = fn\n  asyncQueuer.setOptions(mergedOptions)\n\n  const state = useStore(asyncQueuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncQueuer,\n        state,\n      }) as ReactAsyncQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [asyncQueuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyKA,SAAgB,eACd,IACA,UAAsC,EAAE,EACxC,kBACG,EAAE,GACgC;CACrC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,eAAe,eACd,IAAI,YAAoB,IAAI,cAAc,CACjD;AAED,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,QAAQ,SAAS,YAAY,OAAO,SAAS;AAEnD,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}

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

@@ -0,0 +1,12 @@
+const require_useAsyncRateLimiter = require('./useAsyncRateLimiter.cjs');
+const require_useAsyncRateLimitedCallback = require('./useAsyncRateLimitedCallback.cjs');
+
+exports.useAsyncRateLimitedCallback = require_useAsyncRateLimitedCallback.useAsyncRateLimitedCallback;
+exports.useAsyncRateLimiter = require_useAsyncRateLimiter.useAsyncRateLimiter;
+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,4 @@
+import { ReactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
+import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.cjs";
+export * from "@tanstack/pacer/async-rate-limiter";
+export { ReactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };

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

@@ -0,0 +1,4 @@
+import { ReactAsyncRateLimiter, useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
+import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.js";
+export * from "@tanstack/pacer/async-rate-limiter";
+export { ReactAsyncRateLimiter, useAsyncRateLimitedCallback, useAsyncRateLimiter };

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

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

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

@@ -0,0 +1,65 @@
+const require_useAsyncRateLimiter = require('./useAsyncRateLimiter.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/async-rate-limiter/useAsyncRateLimitedCallback.ts
+/**
+* A Preact hook that creates a rate-limited version of an async callback function.
+* This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
+* providing a stable, async rate-limited function reference for use in Preact components.
+*
+* Async rate limiting is a "hard limit" approach for async functions: it allows all calls
+* until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
+* Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
+* This can lead to bursts of rapid executions followed by periods where all calls are blocked.
+*
+* The async 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.
+*
+* For smoother execution patterns, consider:
+* - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
+* - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
+*
+* Async rate limiting should primarily be used when you need to enforce strict limits
+* on async operations, like API rate limits or other scenarios requiring hard caps
+* on execution frequency.
+*
+* This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
+* async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution counts
+* - Custom useCallback dependencies
+*
+* Consider using the `useAsyncRateLimiter` hook instead.
+*
+*
+* @example
+* ```tsx
+* // Rate limit async API calls to maximum 5 calls per minute with a sliding window
+* const makeApiCall = useAsyncRateLimitedCallback(
+*   async (data: ApiData) => {
+*     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
+*   },
+*   {
+*     limit: 5,
+*     window: 60000, // 1 minute
+*     windowType: 'sliding',
+*     onReject: () => {
+*       console.warn('API rate limit reached. Please wait before trying again.');
+*     }
+*   }
+* );
+* ```
+*/
+function useAsyncRateLimitedCallback(fn, options) {
+	const asyncRateLimitedFn = require_useAsyncRateLimiter.useAsyncRateLimiter(fn, options).maybeExecute;
+	return (0, preact_hooks.useCallback)((...args) => asyncRateLimitedFn(...args), [asyncRateLimitedFn]);
+}
+
+//#endregion
+exports.useAsyncRateLimitedCallback = useAsyncRateLimitedCallback;
+//# sourceMappingURL=useAsyncRateLimitedCallback.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncRateLimitedCallback.cjs","names":["useAsyncRateLimiter"],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async 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 * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqBA,gDAAoB,IAAI,QAAQ,CAAC;AAC5D,uCACG,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}

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

@@ -0,0 +1,62 @@
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+import { AsyncRateLimiterOptions } from "@tanstack/pacer/async-rate-limiter";
+
+//#region src/async-rate-limiter/useAsyncRateLimitedCallback.d.ts
+
+/**
+ * A Preact hook that creates a rate-limited version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
+ * providing a stable, async rate-limited function reference for use in Preact components.
+ *
+ * Async rate limiting is a "hard limit" approach for async functions: it allows all calls
+ * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
+ * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
+ * This can lead to bursts of rapid executions followed by periods where all calls are blocked.
+ *
+ * The async 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.
+ *
+ * For smoother execution patterns, consider:
+ * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
+ * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
+ *
+ * Async rate limiting should primarily be used when you need to enforce strict limits
+ * on async operations, like API rate limits or other scenarios requiring hard caps
+ * on execution frequency.
+ *
+ * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
+ * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncRateLimiter` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Rate limit async API calls to maximum 5 calls per minute with a sliding window
+ * const makeApiCall = useAsyncRateLimitedCallback(
+ *   async (data: ApiData) => {
+ *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
+ *   },
+ *   {
+ *     limit: 5,
+ *     window: 60000, // 1 minute
+ *     windowType: 'sliding',
+ *     onReject: () => {
+ *       console.warn('API rate limit reached. Please wait before trying again.');
+ *     }
+ *   }
+ * );
+ * ```
+ */
+declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncRateLimitedCallback };
+//# sourceMappingURL=useAsyncRateLimitedCallback.d.cts.map

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

@@ -0,0 +1,62 @@
+import { AsyncRateLimiterOptions } from "@tanstack/pacer/async-rate-limiter";
+import { AnyAsyncFunction } from "@tanstack/pacer/types";
+
+//#region src/async-rate-limiter/useAsyncRateLimitedCallback.d.ts
+
+/**
+ * A Preact hook that creates a rate-limited version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
+ * providing a stable, async rate-limited function reference for use in Preact components.
+ *
+ * Async rate limiting is a "hard limit" approach for async functions: it allows all calls
+ * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
+ * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
+ * This can lead to bursts of rapid executions followed by periods where all calls are blocked.
+ *
+ * The async 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.
+ *
+ * For smoother execution patterns, consider:
+ * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
+ * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
+ *
+ * Async rate limiting should primarily be used when you need to enforce strict limits
+ * on async operations, like API rate limits or other scenarios requiring hard caps
+ * on execution frequency.
+ *
+ * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
+ * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual cancellation
+ * - Access to execution counts
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncRateLimiter` hook instead.
+ *
+ *
+ * @example
+ * ```tsx
+ * // Rate limit async API calls to maximum 5 calls per minute with a sliding window
+ * const makeApiCall = useAsyncRateLimitedCallback(
+ *   async (data: ApiData) => {
+ *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
+ *   },
+ *   {
+ *     limit: 5,
+ *     window: 60000, // 1 minute
+ *     windowType: 'sliding',
+ *     onReject: () => {
+ *       console.warn('API rate limit reached. Please wait before trying again.');
+ *     }
+ *   }
+ * );
+ * ```
+ */
+declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>>;
+//#endregion
+export { useAsyncRateLimitedCallback };
+//# sourceMappingURL=useAsyncRateLimitedCallback.d.ts.map

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

@@ -0,0 +1,65 @@
+import { useAsyncRateLimiter } from "./useAsyncRateLimiter.js";
+import { useCallback } from "preact/hooks";
+
+//#region src/async-rate-limiter/useAsyncRateLimitedCallback.ts
+/**
+* A Preact hook that creates a rate-limited version of an async callback function.
+* This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
+* providing a stable, async rate-limited function reference for use in Preact components.
+*
+* Async rate limiting is a "hard limit" approach for async functions: it allows all calls
+* until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
+* Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
+* This can lead to bursts of rapid executions followed by periods where all calls are blocked.
+*
+* The async 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.
+*
+* For smoother execution patterns, consider:
+* - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
+* - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
+*
+* Async rate limiting should primarily be used when you need to enforce strict limits
+* on async operations, like API rate limits or other scenarios requiring hard caps
+* on execution frequency.
+*
+* This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
+* async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
+*
+* For advanced usage requiring features like:
+* - Manual cancellation
+* - Access to execution counts
+* - Custom useCallback dependencies
+*
+* Consider using the `useAsyncRateLimiter` hook instead.
+*
+*
+* @example
+* ```tsx
+* // Rate limit async API calls to maximum 5 calls per minute with a sliding window
+* const makeApiCall = useAsyncRateLimitedCallback(
+*   async (data: ApiData) => {
+*     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
+*   },
+*   {
+*     limit: 5,
+*     window: 60000, // 1 minute
+*     windowType: 'sliding',
+*     onReject: () => {
+*       console.warn('API rate limit reached. Please wait before trying again.');
+*     }
+*   }
+* );
+* ```
+*/
+function useAsyncRateLimitedCallback(fn, options) {
+	const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute;
+	return useCallback((...args) => asyncRateLimitedFn(...args), [asyncRateLimitedFn]);
+}
+
+//#endregion
+export { useAsyncRateLimitedCallback };
+//# sourceMappingURL=useAsyncRateLimitedCallback.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAsyncRateLimitedCallback.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async 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 * For smoother execution patterns, consider:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: AsyncRateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => Promise<ReturnType<TFn>> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) =>\n      asyncRateLimitedFn(...args) as Promise<ReturnType<TFn>>,\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SACwD;CACxD,MAAM,qBAAqB,oBAAoB,IAAI,QAAQ,CAAC;AAC5D,QAAO,aACJ,GAAG,SACF,mBAAmB,GAAG,KAAK,EAC7B,CAAC,mBAAmB,CACrB"}