@tanstack/solid-pacer 0.4.0 → 0.6.0

package/dist/esm/async-queuer/createAsyncQueuer.d.ts

@@ -1,18 +1,18 @@
-import { AsyncQueuer, AsyncQueuerOptions } from '@tanstack/pacer/async-queuer';
+import { AsyncQueuer, AsyncQueuerFn, AsyncQueuerOptions } from '@tanstack/pacer/async-queuer';
 import { Accessor } from 'solid-js';
-export interface SolidAsyncQueuer<TValue> extends Omit<AsyncQueuer<TValue>, 'getActiveItems' | 'getAllItems' | 'getExecutionCount' | 'getIsEmpty' | 'getIsFull' | 'getIsIdle' | 'getIsRunning' | 'getPeek' | 'getPendingItems' | 'getSize'> {
+export interface SolidAsyncQueuer<TFn extends AsyncQueuerFn> extends Omit<AsyncQueuer<TFn>, 'getActiveItems' | 'getAllItems' | 'getErrorCount' | 'getIsEmpty' | 'getIsFull' | 'getIsIdle' | 'getIsRunning' | 'getPeek' | 'getPendingItems' | 'getRejectionCount' | 'getSettledCount' | 'getSize' | 'getSuccessCount'> {
     /**
      * Signal version of `getActiveItems`
      */
-    activeItems: Accessor<Array<() => Promise<TValue>>>;
+    activeItems: Accessor<Array<TFn>>;
     /**
      * Signal version of `getAllItems`
      */
-    allItems: Accessor<Array<() => Promise<TValue>>>;
+    allItems: Accessor<Array<TFn>>;
     /**
-     * Signal version of `getExecutionCount`
+     * Signal version of `getErrorCount`
      */
-    executionCount: Accessor<number>;
+    errorCount: Accessor<number>;
     /**
      * Signal version of `getIsEmpty`
      */
@@ -32,38 +32,49 @@ export interface SolidAsyncQueuer<TValue> extends Omit<AsyncQueuer<TValue>, 'get
     /**
      * Signal version of `getPeek`
      */
-    peek: Accessor<(() => Promise<TValue>) | undefined>;
+    peek: Accessor<TFn | undefined>;
     /**
      * Signal version of `getPendingItems`
      */
-    pendingItems: Accessor<Array<() => Promise<TValue>>>;
+    pendingItems: Accessor<Array<TFn>>;
     /**
      * Signal version of `getRejectionCount`
      */
     rejectionCount: Accessor<number>;
+    /**
+     * Signal version of `getSettledCount`
+     */
+    settledCount: Accessor<number>;
     /**
      * Signal version of `getSize`
      */
     size: Accessor<number>;
+    /**
+     * Signal version of `getSuccessCount`
+     */
+    successCount: Accessor<number>;
 }
 /**
- * A lower-level React hook that creates an `AsyncQueuer` instance for managing an async queue of items.
+ * A lower-level Solid hook that creates an `AsyncQueuer` instance for managing an async queue of items.
  *
- * This hook provides a flexible, state-management agnostic way to handle queued async operations.
- * It returns a queuer instance with methods to add items, control queue execution, and monitor queue state.
+ * 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
  *
- * The queue can be configured with:
- * - Maximum concurrent operations
- * - Maximum queue size
- * - Processing function for queue items
- * - Various lifecycle callbacks
+ * 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.
  *
- * The hook returns an object containing methods to:
- * - Add/remove items from the queue
- * - Start/stop queue processing
- * - Get queue status and items
- * - Register event handlers
- * - Control execution throttling
+ * 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
  *
  * @example
  * ```tsx
@@ -73,6 +84,12 @@ export interface SolidAsyncQueuer<TValue> extends Omit<AsyncQueuer<TValue>, 'get
  *   concurrency: 2,
  *   maxSize: 100,
  *   started: false,
+ *   onSuccess: (result) => {
+ *     console.log('Item processed:', result);
+ *   },
+ *   onError: (error) => {
+ *     console.error('Processing failed:', error);
+ *   }
  * });
  *
  * // Add items to queue
@@ -80,15 +97,6 @@ export interface SolidAsyncQueuer<TValue> extends Omit<AsyncQueuer<TValue>, 'get
  *
  * // Start processing
  * asyncQueuer.start();
- *
- * // Handle results
- * asyncQueuer.onSuccess((result) => {
- *   console.log('Item processed:', result);
- * });
- *
- * asyncQueuer.onError((error) => {
- *   console.error('Processing failed:', error);
- * });
  * ```
  */
-export declare function createAsyncQueuer<TValue>(initialOptions?: AsyncQueuerOptions<TValue>): SolidAsyncQueuer<TValue>;
+export declare function createAsyncQueuer<TFn extends AsyncQueuerFn>(initialOptions?: AsyncQueuerOptions<TFn>): SolidAsyncQueuer<TFn>;

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

@@ -3,8 +3,12 @@ import { createSignal } from "solid-js";
 import { bindInstanceMethods } from "@tanstack/pacer/utils";
 function createAsyncQueuer(initialOptions = {}) {
   const asyncQueuer = new AsyncQueuer(initialOptions);
-  const [executionCount, setExecutionCount] = createSignal(
-    asyncQueuer.getExecutionCount()
+  const [successCount, setSuccessCount] = createSignal(
+    asyncQueuer.getSuccessCount()
+  );
+  const [errorCount, setErrorCount] = createSignal(asyncQueuer.getErrorCount());
+  const [settledCount, setSettledCount] = createSignal(
+    asyncQueuer.getSettledCount()
   );
   const [rejectionCount, setRejectionCount] = createSignal(
     asyncQueuer.getRejectionCount()
@@ -16,24 +20,29 @@ function createAsyncQueuer(initialOptions = {}) {
   const [allItems, setAllItems] = createSignal(
     asyncQueuer.getAllItems()
   );
-  const [activeItems, setActiveItems] = createSignal(asyncQueuer.getActiveItems());
-  const [pendingItems, setPendingItems] = createSignal(asyncQueuer.getPendingItems());
-  const [peek, setPeek] = createSignal(
-    asyncQueuer.getPeek()
+  const [activeItems, setActiveItems] = createSignal(
+    asyncQueuer.getActiveItems()
+  );
+  const [pendingItems, setPendingItems] = createSignal(
+    asyncQueuer.getPendingItems()
   );
+  const [peek, setPeek] = createSignal(asyncQueuer.getPeek());
   const [size, setSize] = createSignal(asyncQueuer.getSize());
   asyncQueuer.setOptions({
     onItemsChange: (queuer) => {
       var _a;
-      setExecutionCount(queuer.getExecutionCount());
+      setActiveItems(queuer.getActiveItems());
+      setAllItems(queuer.getAllItems());
+      setErrorCount(queuer.getErrorCount());
       setIsEmpty(queuer.getIsEmpty());
       setIsFull(queuer.getIsFull());
       setIsIdle(queuer.getIsIdle());
-      setAllItems(queuer.getAllItems());
-      setActiveItems(queuer.getActiveItems());
-      setPendingItems(queuer.getPendingItems());
       setPeek(() => queuer.getPeek());
+      setPendingItems(queuer.getPendingItems());
+      setRejectionCount(queuer.getRejectionCount());
+      setSettledCount(queuer.getSettledCount());
       setSize(queuer.getSize());
+      setSuccessCount(queuer.getSuccessCount());
       (_a = initialOptions.onItemsChange) == null ? void 0 : _a.call(initialOptions, queuer);
     },
     onIsRunningChange: (queuer) => {
@@ -51,16 +60,18 @@ function createAsyncQueuer(initialOptions = {}) {
   return {
     ...bindInstanceMethods(asyncQueuer),
     activeItems,
-    executionCount,
+    allItems,
+    errorCount,
     isEmpty,
     isFull,
     isIdle,
     isRunning,
-    allItems,
     peek,
     pendingItems,
     rejectionCount,
-    size
+    settledCount,
+    size,
+    successCount
   };
 }
 export {

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

@@ -1 +1 @@
-{"version":3,"file":"createAsyncQueuer.js","sources":["../../../src/async-queuer/createAsyncQueuer.ts"],"sourcesContent":["import { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AsyncQueuerOptions } from '@tanstack/pacer/async-queuer'\n\nexport interface SolidAsyncQueuer<TValue>\n  extends Omit<\n    AsyncQueuer<TValue>,\n    | 'getActiveItems'\n    | 'getAllItems'\n    | 'getExecutionCount'\n    | 'getIsEmpty'\n    | 'getIsFull'\n    | 'getIsIdle'\n    | 'getIsRunning'\n    | 'getPeek'\n    | 'getPendingItems'\n    | 'getSize'\n  > {\n  /**\n   * Signal version of `getActiveItems`\n   */\n  activeItems: Accessor<Array<() => Promise<TValue>>>\n  /**\n   * Signal version of `getAllItems`\n   */\n  allItems: Accessor<Array<() => Promise<TValue>>>\n  /**\n   * Signal version of `getExecutionCount`\n   */\n  executionCount: Accessor<number>\n  /**\n   * Signal version of `getIsEmpty`\n   */\n  isEmpty: Accessor<boolean>\n  /**\n   * Signal version of `getIsFull`\n   */\n  isFull: Accessor<boolean>\n  /**\n   * Signal version of `getIsIdle`\n   */\n  isIdle: Accessor<boolean>\n  /**\n   * Signal version of `getIsRunning`\n   */\n  isRunning: Accessor<boolean>\n  /**\n   * Signal version of `getPeek`\n   */\n  peek: Accessor<(() => Promise<TValue>) | undefined>\n  /**\n   * Signal version of `getPendingItems`\n   */\n  pendingItems: Accessor<Array<() => Promise<TValue>>>\n  /**\n   * Signal version of `getRejectionCount`\n   */\n  rejectionCount: Accessor<number>\n  /**\n   * Signal version of `getSize`\n   */\n  size: Accessor<number>\n}\n\n/**\n * A lower-level React hook that creates an `AsyncQueuer` instance for managing an async queue of items.\n *\n * This hook provides a flexible, state-management agnostic way to handle queued async operations.\n * It returns a queuer instance with methods to add items, control queue execution, and monitor queue state.\n *\n * The queue can be configured with:\n * - Maximum concurrent operations\n * - Maximum queue size\n * - Processing function for queue items\n * - Various lifecycle callbacks\n *\n * The hook returns an object containing methods to:\n * - Add/remove items from the queue\n * - Start/stop queue processing\n * - Get queue status and items\n * - Register event handlers\n * - Control execution throttling\n *\n * @example\n * ```tsx\n * // Basic async queuer for API requests\n * const asyncQueuer = createAsyncQueuer({\n *   initialItems: [],\n *   concurrency: 2,\n *   maxSize: 100,\n *   started: false,\n * });\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n *\n * // Handle results\n * asyncQueuer.onSuccess((result) => {\n *   console.log('Item processed:', result);\n * });\n *\n * asyncQueuer.onError((error) => {\n *   console.error('Processing failed:', error);\n * });\n * ```\n */\nexport function createAsyncQueuer<TValue>(\n  initialOptions: AsyncQueuerOptions<TValue> = {},\n): SolidAsyncQueuer<TValue> {\n  const asyncQueuer = new AsyncQueuer<TValue>(initialOptions)\n\n  const [executionCount, setExecutionCount] = createSignal(\n    asyncQueuer.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncQueuer.getRejectionCount(),\n  )\n  const [isEmpty, setIsEmpty] = createSignal(asyncQueuer.getIsEmpty())\n  const [isFull, setIsFull] = createSignal(asyncQueuer.getIsFull())\n  const [isIdle, setIsIdle] = createSignal(asyncQueuer.getIsIdle())\n  const [isRunning, setIsRunning] = createSignal(asyncQueuer.getIsRunning())\n  const [allItems, setAllItems] = createSignal<Array<() => Promise<TValue>>>(\n    asyncQueuer.getAllItems(),\n  )\n  const [activeItems, setActiveItems] = createSignal<\n    Array<() => Promise<TValue>>\n  >(asyncQueuer.getActiveItems())\n  const [pendingItems, setPendingItems] = createSignal<\n    Array<() => Promise<TValue>>\n  >(asyncQueuer.getPendingItems())\n  const [peek, setPeek] = createSignal<(() => Promise<TValue>) | undefined>(\n    asyncQueuer.getPeek(),\n  )\n  const [size, setSize] = createSignal(asyncQueuer.getSize())\n\n  asyncQueuer.setOptions({\n    onItemsChange: (queuer) => {\n      setExecutionCount(queuer.getExecutionCount())\n      setIsEmpty(queuer.getIsEmpty())\n      setIsFull(queuer.getIsFull())\n      setIsIdle(queuer.getIsIdle())\n      setAllItems(queuer.getAllItems())\n      setActiveItems(queuer.getActiveItems())\n      setPendingItems(queuer.getPendingItems())\n      setPeek(() => queuer.getPeek())\n      setSize(queuer.getSize())\n      initialOptions.onItemsChange?.(queuer)\n    },\n    onIsRunningChange: (queuer) => {\n      setIsRunning(queuer.getIsRunning())\n      setIsIdle(queuer.getIsIdle())\n      initialOptions.onIsRunningChange?.(queuer)\n    },\n    onReject: (item, queuer) => {\n      setRejectionCount(queuer.getRejectionCount())\n      initialOptions.onReject?.(item, queuer)\n    },\n  })\n\n  return {\n    ...bindInstanceMethods(asyncQueuer),\n    activeItems,\n    executionCount,\n    isEmpty,\n    isFull,\n    isIdle,\n    isRunning,\n    allItems,\n    peek,\n    pendingItems,\n    rejectionCount,\n    size,\n  } as SolidAsyncQueuer<TValue>\n}\n"],"names":[],"mappings":";;;AA+GgB,SAAA,kBACd,iBAA6C,IACnB;AACpB,QAAA,cAAc,IAAI,YAAoB,cAAc;AAEpD,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACA,QAAM,CAAC,SAAS,UAAU,IAAI,aAAa,YAAY,YAAY;AACnE,QAAM,CAAC,QAAQ,SAAS,IAAI,aAAa,YAAY,WAAW;AAChE,QAAM,CAAC,QAAQ,SAAS,IAAI,aAAa,YAAY,WAAW;AAChE,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,YAAY,cAAc;AACnE,QAAA,CAAC,UAAU,WAAW,IAAI;AAAA,IAC9B,YAAY,YAAY;AAAA,EAC1B;AACA,QAAM,CAAC,aAAa,cAAc,IAAI,aAEpC,YAAY,gBAAgB;AAC9B,QAAM,CAAC,cAAc,eAAe,IAAI,aAEtC,YAAY,iBAAiB;AACzB,QAAA,CAAC,MAAM,OAAO,IAAI;AAAA,IACtB,YAAY,QAAQ;AAAA,EACtB;AACA,QAAM,CAAC,MAAM,OAAO,IAAI,aAAa,YAAY,SAAS;AAE1D,cAAY,WAAW;AAAA,IACrB,eAAe,CAAC,WAAW;;AACP,wBAAA,OAAO,mBAAmB;AACjC,iBAAA,OAAO,YAAY;AACpB,gBAAA,OAAO,WAAW;AAClB,gBAAA,OAAO,WAAW;AAChB,kBAAA,OAAO,aAAa;AACjB,qBAAA,OAAO,gBAAgB;AACtB,sBAAA,OAAO,iBAAiB;AAChC,cAAA,MAAM,OAAO,SAAS;AACtB,cAAA,OAAO,SAAS;AACxB,2BAAe,kBAAf,wCAA+B;AAAA,IACjC;AAAA,IACA,mBAAmB,CAAC,WAAW;;AAChB,mBAAA,OAAO,cAAc;AACxB,gBAAA,OAAO,WAAW;AAC5B,2BAAe,sBAAf,wCAAmC;AAAA,IACrC;AAAA,IACA,UAAU,CAAC,MAAM,WAAW;;AACR,wBAAA,OAAO,mBAAmB;AAC7B,2BAAA,aAAA,wCAAW,MAAM;AAAA,IAAM;AAAA,EACxC,CACD;AAEM,SAAA;AAAA,IACL,GAAG,oBAAoB,WAAW;AAAA,IAClC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createAsyncQueuer.js","sources":["../../../src/async-queuer/createAsyncQueuer.ts"],"sourcesContent":["import { AsyncQueuer } from '@tanstack/pacer/async-queuer'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type {\n  AsyncQueuerFn,\n  AsyncQueuerOptions,\n} from '@tanstack/pacer/async-queuer'\n\nexport interface SolidAsyncQueuer<TFn extends AsyncQueuerFn>\n  extends Omit<\n    AsyncQueuer<TFn>,\n    | 'getActiveItems'\n    | 'getAllItems'\n    | 'getErrorCount'\n    | 'getIsEmpty'\n    | 'getIsFull'\n    | 'getIsIdle'\n    | 'getIsRunning'\n    | 'getPeek'\n    | 'getPendingItems'\n    | 'getRejectionCount'\n    | 'getSettledCount'\n    | 'getSize'\n    | 'getSuccessCount'\n  > {\n  /**\n   * Signal version of `getActiveItems`\n   */\n  activeItems: Accessor<Array<TFn>>\n  /**\n   * Signal version of `getAllItems`\n   */\n  allItems: Accessor<Array<TFn>>\n  /**\n   * Signal version of `getErrorCount`\n   */\n  errorCount: Accessor<number>\n  /**\n   * Signal version of `getIsEmpty`\n   */\n  isEmpty: Accessor<boolean>\n  /**\n   * Signal version of `getIsFull`\n   */\n  isFull: Accessor<boolean>\n  /**\n   * Signal version of `getIsIdle`\n   */\n  isIdle: Accessor<boolean>\n  /**\n   * Signal version of `getIsRunning`\n   */\n  isRunning: Accessor<boolean>\n  /**\n   * Signal version of `getPeek`\n   */\n  peek: Accessor<TFn | undefined>\n  /**\n   * Signal version of `getPendingItems`\n   */\n  pendingItems: Accessor<Array<TFn>>\n  /**\n   * Signal version of `getRejectionCount`\n   */\n  rejectionCount: Accessor<number>\n  /**\n   * Signal version of `getSettledCount`\n   */\n  settledCount: Accessor<number>\n  /**\n   * Signal version of `getSize`\n   */\n  size: Accessor<number>\n  /**\n   * Signal version of `getSuccessCount`\n   */\n  successCount: Accessor<number>\n}\n\n/**\n * A lower-level Solid 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 * @example\n * ```tsx\n * // Basic async queuer for API requests\n * const asyncQueuer = createAsyncQueuer({\n *   initialItems: [],\n *   concurrency: 2,\n *   maxSize: 100,\n *   started: false,\n *   onSuccess: (result) => {\n *     console.log('Item processed:', result);\n *   },\n *   onError: (error) => {\n *     console.error('Processing failed:', error);\n *   }\n * });\n *\n * // Add items to queue\n * asyncQueuer.addItem(newItem);\n *\n * // Start processing\n * asyncQueuer.start();\n * ```\n */\nexport function createAsyncQueuer<TFn extends AsyncQueuerFn>(\n  initialOptions: AsyncQueuerOptions<TFn> = {},\n): SolidAsyncQueuer<TFn> {\n  const asyncQueuer = new AsyncQueuer<TFn>(initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncQueuer.getSuccessCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(asyncQueuer.getErrorCount())\n  const [settledCount, setSettledCount] = createSignal(\n    asyncQueuer.getSettledCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncQueuer.getRejectionCount(),\n  )\n  const [isEmpty, setIsEmpty] = createSignal(asyncQueuer.getIsEmpty())\n  const [isFull, setIsFull] = createSignal(asyncQueuer.getIsFull())\n  const [isIdle, setIsIdle] = createSignal(asyncQueuer.getIsIdle())\n  const [isRunning, setIsRunning] = createSignal(asyncQueuer.getIsRunning())\n  const [allItems, setAllItems] = createSignal<Array<TFn>>(\n    asyncQueuer.getAllItems(),\n  )\n  const [activeItems, setActiveItems] = createSignal<Array<TFn>>(\n    asyncQueuer.getActiveItems(),\n  )\n  const [pendingItems, setPendingItems] = createSignal<Array<TFn>>(\n    asyncQueuer.getPendingItems(),\n  )\n  const [peek, setPeek] = createSignal<TFn | undefined>(asyncQueuer.getPeek())\n  const [size, setSize] = createSignal(asyncQueuer.getSize())\n\n  asyncQueuer.setOptions({\n    onItemsChange: (queuer) => {\n      setActiveItems(queuer.getActiveItems())\n      setAllItems(queuer.getAllItems())\n      setErrorCount(queuer.getErrorCount())\n      setIsEmpty(queuer.getIsEmpty())\n      setIsFull(queuer.getIsFull())\n      setIsIdle(queuer.getIsIdle())\n      setPeek(() => queuer.getPeek())\n      setPendingItems(queuer.getPendingItems())\n      setRejectionCount(queuer.getRejectionCount())\n      setSettledCount(queuer.getSettledCount())\n      setSize(queuer.getSize())\n      setSuccessCount(queuer.getSuccessCount())\n      initialOptions.onItemsChange?.(queuer)\n    },\n    onIsRunningChange: (queuer) => {\n      setIsRunning(queuer.getIsRunning())\n      setIsIdle(queuer.getIsIdle())\n      initialOptions.onIsRunningChange?.(queuer)\n    },\n    onReject: (item, queuer) => {\n      setRejectionCount(queuer.getRejectionCount())\n      initialOptions.onReject?.(item, queuer)\n    },\n  })\n\n  return {\n    ...bindInstanceMethods(asyncQueuer),\n    activeItems,\n    allItems,\n    errorCount,\n    isEmpty,\n    isFull,\n    isIdle,\n    isRunning,\n    peek,\n    pendingItems,\n    rejectionCount,\n    settledCount,\n    size,\n    successCount,\n  } as SolidAsyncQueuer<TFn>\n}\n"],"names":[],"mappings":";;;AA6HgB,SAAA,kBACd,iBAA0C,IACnB;AACjB,QAAA,cAAc,IAAI,YAAiB,cAAc;AAEjD,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,YAAY,gBAAgB;AAAA,EAC9B;AACA,QAAM,CAAC,YAAY,aAAa,IAAI,aAAa,YAAY,eAAe;AACtE,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,YAAY,gBAAgB;AAAA,EAC9B;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACA,QAAM,CAAC,SAAS,UAAU,IAAI,aAAa,YAAY,YAAY;AACnE,QAAM,CAAC,QAAQ,SAAS,IAAI,aAAa,YAAY,WAAW;AAChE,QAAM,CAAC,QAAQ,SAAS,IAAI,aAAa,YAAY,WAAW;AAChE,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,YAAY,cAAc;AACnE,QAAA,CAAC,UAAU,WAAW,IAAI;AAAA,IAC9B,YAAY,YAAY;AAAA,EAC1B;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,YAAY,eAAe;AAAA,EAC7B;AACM,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,YAAY,gBAAgB;AAAA,EAC9B;AACA,QAAM,CAAC,MAAM,OAAO,IAAI,aAA8B,YAAY,SAAS;AAC3E,QAAM,CAAC,MAAM,OAAO,IAAI,aAAa,YAAY,SAAS;AAE1D,cAAY,WAAW;AAAA,IACrB,eAAe,CAAC,WAAW;;AACV,qBAAA,OAAO,gBAAgB;AAC1B,kBAAA,OAAO,aAAa;AAClB,oBAAA,OAAO,eAAe;AACzB,iBAAA,OAAO,YAAY;AACpB,gBAAA,OAAO,WAAW;AAClB,gBAAA,OAAO,WAAW;AACpB,cAAA,MAAM,OAAO,SAAS;AACd,sBAAA,OAAO,iBAAiB;AACtB,wBAAA,OAAO,mBAAmB;AAC5B,sBAAA,OAAO,iBAAiB;AAChC,cAAA,OAAO,SAAS;AACR,sBAAA,OAAO,iBAAiB;AACxC,2BAAe,kBAAf,wCAA+B;AAAA,IACjC;AAAA,IACA,mBAAmB,CAAC,WAAW;;AAChB,mBAAA,OAAO,cAAc;AACxB,gBAAA,OAAO,WAAW;AAC5B,2BAAe,sBAAf,wCAAmC;AAAA,IACrC;AAAA,IACA,UAAU,CAAC,MAAM,WAAW;;AACR,wBAAA,OAAO,mBAAmB;AAC7B,2BAAA,aAAA,wCAAW,MAAM;AAAA,IAAM;AAAA,EACxC,CACD;AAEM,SAAA;AAAA,IACL,GAAG,oBAAoB,WAAW;AAAA,IAClC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

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

@@ -15,13 +15,9 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction> extends Omi
  * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
  * you can integrate with any state management solution (createSignal, etc).
  *
- * Rate limiting 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.
+ * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
+ * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
+ * all executions happen immediately, followed by a complete block.
  *
  * The rate limiter supports two types of windows:
  * - 'fixed': A strict window that resets after the window period. All executions within the window count
@@ -29,6 +25,25 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction> extends Omi
  * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
  *   consistent rate of execution over time.
  *
+ * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
+ * For smoother execution patterns, consider using:
+ * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
+ * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
+ *
+ * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
+ * smoothing out frequent events, throttling or debouncing usually provide better user experience.
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and rate limiter instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncRateLimiter instance
+ * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
+ *
  * @example
  * ```tsx
  * // Basic API call rate limiting with return value

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

@@ -1 +1 @@
-{"version":3,"file":"createAsyncRateLimiter.js","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting 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 * @example\n * ```tsx\n * // Basic API call rate limiting with return value\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management and return value\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\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: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":[],"mappings":";;;AAwEgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAM,mBAAmB,IAAI,iBAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,iBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,iBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,iBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,iBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrE,qBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,gBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createAsyncRateLimiter.js","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * @example\n * ```tsx\n * // Basic API call rate limiting with return value\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management and return value\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\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: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":[],"mappings":";;;AAuFgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAM,mBAAmB,IAAI,iBAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,iBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,iBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,iBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,iBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrE,qBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,gBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/dist/esm/async-throttler/createAsyncThrottler.d.ts

@@ -21,6 +21,17 @@ export interface SolidAsyncThrottler<TFn extends AnyAsyncFunction> extends Omit<
  * 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
+ *
  * @example
  * ```tsx
  * // Basic API call throttling
@@ -42,7 +53,10 @@ export interface SolidAsyncThrottler<TFn extends AnyAsyncFunction> extends Omit<
  *   {
  *     wait: 2000,
  *     leading: true,   // Execute immediately on first call
- *     trailing: false  // Skip trailing edge updates
+ *     trailing: false, // Skip trailing edge updates
+ *     onError: (error) => {
+ *       console.error('API call failed:', error);
+ *     }
  *   }
  * );
  * ```

package/dist/esm/async-throttler/createAsyncThrottler.js.map

@@ -1 +1 @@
-{"version":3,"file":"createAsyncThrottler.js","sources":["../../../src/async-throttler/createAsyncThrottler.ts"],"sourcesContent":["import { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\n\nexport interface SolidAsyncThrottler<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncThrottler<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getIsPending'\n    | 'getIsExecuting'\n    | 'getLastResult'\n    | 'getLastExecutionTime'\n    | 'getNextExecutionTime'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  isPending: Accessor<boolean>\n  isExecuting: Accessor<boolean>\n  lastResult: Accessor<ReturnType<TFn> | undefined>\n  lastExecutionTime: Accessor<number>\n  nextExecutionTime: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Async throttling ensures an async function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,\n * database operations, or other async tasks.\n *\n * @example\n * ```tsx\n * // Basic API call throttling\n * const { maybeExecute } = createAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 }\n * );\n *\n * // With state management\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *   },\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n * ```\n */\n\nexport function createAsyncThrottler<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncThrottlerOptions<TFn>,\n): SolidAsyncThrottler<TFn> {\n  const asyncThrottler = bindInstanceMethods(\n    new AsyncThrottler<TFn>(fn, initialOptions),\n  )\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncThrottler.getSuccessCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncThrottler.getSettleCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncThrottler.getErrorCount(),\n  )\n  const [isPending, setIsPending] = createSignal(asyncThrottler.getIsPending())\n  const [isExecuting, setIsExecuting] = createSignal(\n    asyncThrottler.getIsExecuting(),\n  )\n  const [lastResult, setLastResult] = createSignal(\n    asyncThrottler.getLastResult(),\n  )\n  const [lastExecutionTime, setLastExecutionTime] = createSignal(\n    asyncThrottler.getLastExecutionTime(),\n  )\n  const [nextExecutionTime, setNextExecutionTime] = createSignal(\n    asyncThrottler.getNextExecutionTime(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncThrottlerOptions<TFn>>) {\n    asyncThrottler.setOptions({\n      ...newOptions,\n      onSettled: (throttler) => {\n        setSuccessCount(throttler.getSuccessCount())\n        setSettleCount(throttler.getSettleCount())\n        setErrorCount(throttler.getErrorCount())\n        setIsPending(throttler.getIsPending())\n        setIsExecuting(throttler.getIsExecuting())\n        setLastExecutionTime(throttler.getLastExecutionTime())\n        setNextExecutionTime(throttler.getNextExecutionTime())\n        setLastResult(throttler.getLastResult())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(throttler)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...asyncThrottler,\n    errorCount,\n    isExecuting,\n    isPending,\n    lastExecutionTime,\n    lastResult,\n    nextExecutionTime,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncThrottler<TFn>\n}\n"],"names":[],"mappings":";;;AAkEgB,SAAA,qBACd,IACA,gBAC0B;AAC1B,QAAM,iBAAiB;AAAA,IACrB,IAAI,eAAoB,IAAI,cAAc;AAAA,EAC5C;AAEM,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,eAAe,gBAAgB;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,eAAe,eAAe;AAAA,EAChC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,eAAe,cAAc;AAAA,EAC/B;AACA,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,eAAe,cAAc;AACtE,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,eAAe,eAAe;AAAA,EAChC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,eAAe,cAAc;AAAA,EAC/B;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,eAAe,qBAAqB;AAAA,EACtC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,eAAe,qBAAqB;AAAA,EACtC;AAEA,WAAS,WAAW,YAAiD;AACnE,mBAAe,WAAW;AAAA,MACxB,GAAG;AAAA,MACH,WAAW,CAAC,cAAc;AACR,wBAAA,UAAU,iBAAiB;AAC5B,uBAAA,UAAU,gBAAgB;AAC3B,sBAAA,UAAU,eAAe;AAC1B,qBAAA,UAAU,cAAc;AACtB,uBAAA,UAAU,gBAAgB;AACpB,6BAAA,UAAU,sBAAsB;AAChC,6BAAA,UAAU,sBAAsB;AACvC,sBAAA,UAAU,eAAe;AAEjC,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MAAS;AAAA,IACvB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createAsyncThrottler.js","sources":["../../../src/async-throttler/createAsyncThrottler.ts"],"sourcesContent":["import { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncThrottlerOptions } from '@tanstack/pacer/async-throttler'\n\nexport interface SolidAsyncThrottler<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncThrottler<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getIsPending'\n    | 'getIsExecuting'\n    | 'getLastResult'\n    | 'getLastExecutionTime'\n    | 'getNextExecutionTime'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  isPending: Accessor<boolean>\n  isExecuting: Accessor<boolean>\n  lastResult: Accessor<ReturnType<TFn> | undefined>\n  lastExecutionTime: Accessor<number>\n  nextExecutionTime: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Async throttling ensures an async function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting expensive API calls,\n * database operations, or other async tasks.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncThrottler instance\n *\n * @example\n * ```tsx\n * // Basic API call throttling\n * const { maybeExecute } = createAsyncThrottler(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { wait: 1000 }\n * );\n *\n * // With state management\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncThrottler(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *   },\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false, // Skip trailing edge updates\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n * ```\n */\nexport function createAsyncThrottler<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncThrottlerOptions<TFn>,\n): SolidAsyncThrottler<TFn> {\n  const asyncThrottler = bindInstanceMethods(\n    new AsyncThrottler<TFn>(fn, initialOptions),\n  )\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncThrottler.getSuccessCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncThrottler.getSettleCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncThrottler.getErrorCount(),\n  )\n  const [isPending, setIsPending] = createSignal(asyncThrottler.getIsPending())\n  const [isExecuting, setIsExecuting] = createSignal(\n    asyncThrottler.getIsExecuting(),\n  )\n  const [lastResult, setLastResult] = createSignal(\n    asyncThrottler.getLastResult(),\n  )\n  const [lastExecutionTime, setLastExecutionTime] = createSignal(\n    asyncThrottler.getLastExecutionTime(),\n  )\n  const [nextExecutionTime, setNextExecutionTime] = createSignal(\n    asyncThrottler.getNextExecutionTime(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncThrottlerOptions<TFn>>) {\n    asyncThrottler.setOptions({\n      ...newOptions,\n      onSettled: (throttler) => {\n        setSuccessCount(throttler.getSuccessCount())\n        setSettleCount(throttler.getSettleCount())\n        setErrorCount(throttler.getErrorCount())\n        setIsPending(throttler.getIsPending())\n        setIsExecuting(throttler.getIsExecuting())\n        setLastExecutionTime(throttler.getLastExecutionTime())\n        setNextExecutionTime(throttler.getNextExecutionTime())\n        setLastResult(throttler.getLastResult())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(throttler)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...asyncThrottler,\n    errorCount,\n    isExecuting,\n    isPending,\n    lastExecutionTime,\n    lastResult,\n    nextExecutionTime,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncThrottler<TFn>\n}\n"],"names":[],"mappings":";;;AA+EgB,SAAA,qBACd,IACA,gBAC0B;AAC1B,QAAM,iBAAiB;AAAA,IACrB,IAAI,eAAoB,IAAI,cAAc;AAAA,EAC5C;AAEM,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,eAAe,gBAAgB;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,eAAe,eAAe;AAAA,EAChC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,eAAe,cAAc;AAAA,EAC/B;AACA,QAAM,CAAC,WAAW,YAAY,IAAI,aAAa,eAAe,cAAc;AACtE,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,eAAe,eAAe;AAAA,EAChC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,eAAe,cAAc;AAAA,EAC/B;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,eAAe,qBAAqB;AAAA,EACtC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,eAAe,qBAAqB;AAAA,EACtC;AAEA,WAAS,WAAW,YAAiD;AACnE,mBAAe,WAAW;AAAA,MACxB,GAAG;AAAA,MACH,WAAW,CAAC,cAAc;AACR,wBAAA,UAAU,iBAAiB;AAC5B,uBAAA,UAAU,gBAAgB;AAC3B,sBAAA,UAAU,eAAe;AAC1B,qBAAA,UAAU,cAAc;AACtB,uBAAA,UAAU,gBAAgB;AACpB,6BAAA,UAAU,sBAAsB;AAChC,6BAAA,UAAU,sBAAsB;AACvC,sBAAA,UAAU,eAAe;AAEjC,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MAAS;AAAA,IACvB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/dist/esm/rate-limiter/createRateLimiter.d.ts

@@ -34,17 +34,11 @@ export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimi
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
- *   windowType: 'sliding'
- * });
- *
- * // Monitor rate limit status
- * const handleClick = () => {
- *   if (rateLimiter.remainingInWindow() > 0) {
- *     rateLimiter.maybeExecute(data);
- *   } else {
- *     showRateLimitWarning();
+ *   windowType: 'sliding',
+ *   onReject: (rateLimiter) => {
+ *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }
- * };
+ * });
  *
  * // Access rate limiter state via signals
  * console.log('Executions:', rateLimiter.executionCount());

package/dist/esm/rate-limiter/createRateLimiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\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 * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute with a sliding window\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter"],"mappings":";;;AAmEgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAM,cAAc;AAAA,IAClB,IAAI,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\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 * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute with a sliding window\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter"],"mappings":";;;AA6DgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAM,cAAc;AAAA,IAClB,IAAI,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -142,7 +142,7 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/pacer": "0.4.0"
+    "@tanstack/pacer": "0.6.0"
   },
   "devDependencies": {
     "solid-js": "^1.9.6",

package/src/async-debouncer/createAsyncDebouncer.ts

@@ -28,8 +28,22 @@ export interface SolidAsyncDebouncer<TFn extends AnyAsyncFunction>
  * you can integrate with any state management solution (createSignal, etc).
  *
  * Async debouncing ensures that an async function only executes after a specified delay has passed since its last invocation.
- * This is useful for handling fast-changing inputs like search fields, form validation, or any scenario where you want to
- * wait for user input to settle before making expensive async calls.
+ * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing
+ * or input changes where you only want to execute the handler after the events have stopped occurring.
+ *
+ * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until
+ * the function stops being called for the specified delay period.
+ *
+ * Unlike the non-async Debouncer, this async version supports returning values from the debounced 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 debounced function.
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and debouncer 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 AsyncDebouncer instance
  *
  * @example
  * ```tsx
@@ -51,11 +65,15 @@ export interface SolidAsyncDebouncer<TFn extends AnyAsyncFunction>
  *   },
  *   {
  *     wait: 300,
+ *     leading: true,   // Execute immediately on first call
+ *     trailing: false, // Skip trailing edge updates
+ *     onError: (error) => {
+ *       console.error('API call failed:', error);
+ *     }
  *   }
  * );
  * ```
  */
-
 export function createAsyncDebouncer<TFn extends AnyAsyncFunction>(
   fn: TFn,
   initialOptions: AsyncDebouncerOptions<TFn>,