@tanstack/pacer 0.5.0 → 0.6.0

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

@@ -1,6 +1,9 @@
 import { AnyAsyncFunction } from './types.js';
 import { QueuePosition } from './queuer.js';
-export interface AsyncQueuerOptions<TValue> {
+export type AsyncQueuerFn = AnyAsyncFunction & {
+    priority?: number;
+};
+export interface AsyncQueuerOptions<TFn extends AsyncQueuerFn> {
     /**
      * Default position to add items to the queuer
      * @default 'back'
@@ -11,7 +14,7 @@ export interface AsyncQueuerOptions<TValue> {
      * Can be a number or a function that returns a number.
      * @default 1
      */
-    concurrency?: number | ((queuer: AsyncQueuer<TValue>) => number);
+    concurrency?: number | ((queuer: AsyncQueuer<TFn>) => number);
     /**
      * Maximum time in milliseconds that an item can stay in the queue
      * If not provided, items will never expire
@@ -21,7 +24,7 @@ export interface AsyncQueuerOptions<TValue> {
      * Function to determine if an item has expired
      * If provided, this overrides the expirationDuration behavior
      */
-    getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean;
+    getIsExpired?: (item: TFn, addedAt: number) => boolean;
     /**
      * Default position to get items from during processing
      * @default 'front'
@@ -32,47 +35,67 @@ export interface AsyncQueuerOptions<TValue> {
      * Higher priority items will be processed first
      * If not provided, will use static priority values attached to tasks
      */
-    getPriority?: (item: () => Promise<TValue>) => number;
+    getPriority?: (item: TFn) => number;
     /**
      * Initial items to populate the queuer with
      */
-    initialItems?: Array<(() => Promise<TValue>) & {
+    initialItems?: Array<TFn & {
         priority?: number;
     }>;
     /**
      * Maximum number of items allowed in the queuer
      */
     maxSize?: number;
+    /**
+     * Optional error handler for when a task throws.
+     * If provided, the handler will be called with the error and queuer instance.
+     * This can be used alongside throwOnError - the handler will be called before any error is thrown.
+     */
+    onError?: (error: unknown, queuer: AsyncQueuer<TFn>) => void;
+    /**
+     * Callback fired whenever an item expires in the queuer
+     */
+    onExpire?: (item: TFn, queuer: AsyncQueuer<TFn>) => void;
     /**
      * Callback fired whenever an item is removed from the queuer
      */
-    onGetNextItem?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    onGetNextItem?: (item: TFn, queuer: AsyncQueuer<TFn>) => void;
     /**
      * Callback fired whenever the queuer's running state changes
      */
-    onIsRunningChange?: (queuer: AsyncQueuer<TValue>) => void;
+    onIsRunningChange?: (queuer: AsyncQueuer<TFn>) => void;
     /**
      * Callback fired whenever an item is added or removed from the queuer
      */
-    onItemsChange?: (queuer: AsyncQueuer<TValue>) => void;
+    onItemsChange?: (queuer: AsyncQueuer<TFn>) => void;
     /**
      * Callback fired whenever an item is rejected from being added to the queuer
      */
-    onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    onReject?: (item: TFn, queuer: AsyncQueuer<TFn>) => void;
     /**
-     * Callback fired whenever an item expires in the queuer
+     * Optional callback to call when a task is settled
      */
-    onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    onSettled?: (queuer: AsyncQueuer<TFn>) => void;
+    /**
+     * Optional callback to call when a task succeeds
+     */
+    onSuccess?: (result: TFn, queuer: AsyncQueuer<TFn>) => void;
     /**
      * Whether the queuer should start processing tasks immediately or not.
      */
     started?: boolean;
+    /**
+     * Whether to throw errors when they occur.
+     * Defaults to true if no onError handler is provided, false if an onError handler is provided.
+     * Can be explicitly set to override these defaults.
+     */
+    throwOnError?: boolean;
     /**
      * Time in milliseconds to wait between processing items.
      * Can be a number or a function that returns a number.
      * @default 0
      */
-    wait?: number | ((queuer: AsyncQueuer<TValue>) => number);
+    wait?: number | ((queuer: AsyncQueuer<TFn>) => number);
 }
 /**
  * A flexible asynchronous queue that processes tasks with configurable concurrency control.
@@ -89,44 +112,51 @@ export interface AsyncQueuerOptions<TValue> {
  * 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
+ *
  * @example
  * ```ts
- * const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });
+ * const asyncQueuer = new AsyncQueuer<string>({
+ *   concurrency: 2,
+ *   onSuccess: (result) => {
+ *     console.log(result); // 'Hello'
+ *   }
+ * });
  *
  * asyncQueuer.addItem(async () => {
  *   return 'Hello';
  * });
  *
  * asyncQueuer.start();
- *
- * asyncQueuer.onSuccess((result) => {
- *   console.log(result); // 'Hello'
- * });
  * ```
  */
-export declare class AsyncQueuer<TValue> {
+export declare class AsyncQueuer<TFn extends AsyncQueuerFn> {
     private _options;
     private _activeItems;
-    private _executionCount;
+    private _successCount;
+    private _errorCount;
+    private _settledCount;
     private _rejectionCount;
     private _expirationCount;
     private _items;
     private _itemTimestamps;
-    private _onErrorCallbacks;
-    private _onSettledCallbacks;
-    private _onSuccessCallbacks;
     private _pendingTick;
     private _running;
-    constructor(initialOptions?: AsyncQueuerOptions<TValue>);
+    constructor(initialOptions?: AsyncQueuerOptions<TFn>);
     /**
      * Updates the queuer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): void;
+    setOptions(newOptions: Partial<AsyncQueuerOptions<TFn>>): void;
     /**
      * Returns the current queuer options
      */
-    getOptions(): Required<AsyncQueuerOptions<TValue>>;
+    getOptions(): AsyncQueuerOptions<TFn>;
     /**
      * Returns the current wait time between processing items
      */
@@ -162,17 +192,15 @@ export declare class AsyncQueuer<TValue> {
     /**
      * Adds a task to the queuer
      */
-    addItem(fn: AnyAsyncFunction & {
-        priority?: number;
-    }, position?: QueuePosition, runOnItemsChange?: boolean): Promise<TValue>;
+    addItem(fn: TFn, position?: QueuePosition, runOnItemsChange?: boolean): void;
     /**
      * Removes and returns an item from the queuer
      */
-    getNextItem(position?: QueuePosition): (() => Promise<TValue>) | undefined;
+    getNextItem(position?: QueuePosition): TFn | undefined;
     /**
      * Returns an item without removing it
      */
-    getPeek(position?: QueuePosition): (() => Promise<TValue>) | undefined;
+    getPeek(position?: QueuePosition): TFn | undefined;
     /**
      * Returns true if the queuer is empty
      */
@@ -188,19 +216,27 @@ export declare class AsyncQueuer<TValue> {
     /**
      * Returns a copy of all items in the queuer
      */
-    getAllItems(): Array<() => Promise<TValue>>;
+    getAllItems(): Array<TFn>;
     /**
      * Returns the active items
      */
-    getActiveItems(): Array<() => Promise<TValue>>;
+    getActiveItems(): Array<TFn>;
     /**
      * Returns the pending items
      */
-    getPendingItems(): Array<() => Promise<TValue>>;
+    getPendingItems(): Array<TFn>;
+    /**
+     * Returns the number of items that have been successfully processed
+     */
+    getSuccessCount(): number;
     /**
-     * Returns the number of items that have been removed from the queuer
+     * Returns the number of items that have failed processing
      */
-    getExecutionCount(): number;
+    getErrorCount(): number;
+    /**
+     * Returns the number of items that have completed processing (success or error)
+     */
+    getSettledCount(): number;
     /**
      * Returns the number of items that have been rejected from the queuer
      */
@@ -213,18 +249,6 @@ export declare class AsyncQueuer<TValue> {
      * Returns true if the queuer is running but has no items to process
      */
     getIsIdle(): boolean;
-    /**
-     * Adds a callback to be called when a task succeeds
-     */
-    onSuccess(cb: (result: TValue) => void): () => void;
-    /**
-     * Adds a callback to be called when a task errors
-     */
-    onError(cb: (error: Error) => void): () => void;
-    /**
-     * Adds a callback to be called when a task is settled
-     */
-    onSettled(cb: (result: TValue | Error) => void): () => void;
     /**
      * Returns the number of items that have expired from the queuer
      */
@@ -234,6 +258,13 @@ export declare class AsyncQueuer<TValue> {
  * Creates a new AsyncQueuer instance with the given options and returns a bound addItem function.
  * The queuer is automatically started and ready to process items.
  *
+ * 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
  * ```ts
  * const enqueue = asyncQueue<string>();
@@ -247,6 +278,4 @@ export declare class AsyncQueuer<TValue> {
  * @param options - Configuration options for the AsyncQueuer
  * @returns A bound addItem function that can be used to add tasks to the queuer
  */
-export declare function asyncQueue<TValue>(options: AsyncQueuerOptions<TValue>): (fn: AnyAsyncFunction & {
-    priority?: number;
-}, position?: QueuePosition, runOnItemsChange?: boolean) => Promise<TValue>;
+export declare function asyncQueue<TFn extends AsyncQueuerFn>(options: AsyncQueuerOptions<TFn>): (fn: TFn, position?: QueuePosition, runOnItemsChange?: boolean) => void;

package/dist/esm/async-queuer.js

@@ -8,32 +8,25 @@ const defaultOptions = {
   getPriority: (item) => (item == null ? void 0 : item.priority) ?? 0,
   initialItems: [],
   maxSize: Infinity,
-  onGetNextItem: () => {
-  },
-  onIsRunningChange: () => {
-  },
-  onItemsChange: () => {
-  },
-  onReject: () => {
-  },
-  onExpire: () => {
-  },
   started: true,
   wait: 0
 };
 class AsyncQueuer {
   constructor(initialOptions = defaultOptions) {
     this._activeItems = /* @__PURE__ */ new Set();
-    this._executionCount = 0;
+    this._successCount = 0;
+    this._errorCount = 0;
+    this._settledCount = 0;
     this._rejectionCount = 0;
     this._expirationCount = 0;
     this._items = [];
     this._itemTimestamps = [];
-    this._onErrorCallbacks = [];
-    this._onSettledCallbacks = [];
-    this._onSuccessCallbacks = [];
     this._pendingTick = false;
-    this._options = { ...defaultOptions, ...initialOptions };
+    this._options = {
+      ...defaultOptions,
+      ...initialOptions,
+      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError
+    };
     this._running = this._options.started;
     for (let i = 0; i < this._options.initialItems.length; i++) {
       const item = this._options.initialItems[i];
@@ -70,6 +63,7 @@ class AsyncQueuer {
    * Processes items in the queuer
    */
   tick() {
+    var _a, _b;
     if (!this._running) {
       this._pendingTick = false;
       return;
@@ -81,26 +75,28 @@ class AsyncQueuer {
         break;
       }
       this._activeItems.add(nextFn);
-      this._options.onItemsChange(this);
+      (_b = (_a = this._options).onItemsChange) == null ? void 0 : _b.call(_a, this);
       (async () => {
-        let success = false;
+        var _a2, _b2, _c, _d, _e, _f, _g, _h;
         let res;
-        let error;
         try {
           res = await nextFn();
-          success = true;
-        } catch (e) {
-          error = e;
+          this._successCount++;
+          (_b2 = (_a2 = this._options).onSuccess) == null ? void 0 : _b2.call(_a2, res, this);
+        } catch (error) {
+          this._errorCount++;
+          (_d = (_c = this._options).onError) == null ? void 0 : _d.call(_c, error, this);
+          if (this._options.throwOnError) {
+            throw error;
+          } else {
+            console.error(error);
+          }
         } finally {
+          this._settledCount++;
           this._activeItems.delete(nextFn);
-          this._options.onItemsChange(this);
-        }
-        if (success) {
-          this._onSuccessCallbacks.forEach((cb) => cb(res));
-        } else {
-          this._onErrorCallbacks.forEach((cb) => cb(error));
+          (_f = (_e = this._options).onItemsChange) == null ? void 0 : _f.call(_e, this);
+          (_h = (_g = this._options).onSettled) == null ? void 0 : _h.call(_g, this);
         }
-        this._onSettledCallbacks.forEach((cb) => cb(success ? res : error));
         const wait = this.getWait();
         if (wait > 0) {
           setTimeout(() => this.tick(), wait);
@@ -115,6 +111,7 @@ class AsyncQueuer {
    * Checks for and removes expired items from the queuer
    */
   checkExpiredItems() {
+    var _a, _b, _c, _d;
     if (this._options.expirationDuration === Infinity && this._options.getIsExpired === defaultOptions.getIsExpired)
       return;
     const now = Date.now();
@@ -137,22 +134,23 @@ class AsyncQueuer {
       this._items.splice(index, 1);
       this._itemTimestamps.splice(index, 1);
       this._expirationCount++;
-      this._options.onExpire(expiredItem, this);
+      (_b = (_a = this._options).onExpire) == null ? void 0 : _b.call(_a, expiredItem, this);
     }
     if (expiredIndices.length > 0) {
-      this._options.onItemsChange(this);
+      (_d = (_c = this._options).onItemsChange) == null ? void 0 : _d.call(_c, this);
     }
   }
   /**
    * Starts the queuer and processes items
    */
   start() {
+    var _a, _b;
     this._running = true;
     if (!this._pendingTick && !this.getIsEmpty()) {
       this._pendingTick = true;
       this.tick();
     }
-    this._options.onIsRunningChange(this);
+    (_b = (_a = this._options).onIsRunningChange) == null ? void 0 : _b.call(_a, this);
     return new Promise((resolve) => {
       const checkIdle = () => {
         if (this.getIsIdle()) {
@@ -168,23 +166,27 @@ class AsyncQueuer {
    * Stops the queuer from processing items
    */
   stop() {
+    var _a, _b;
     this._running = false;
     this._pendingTick = false;
-    this._options.onIsRunningChange(this);
+    (_b = (_a = this._options).onIsRunningChange) == null ? void 0 : _b.call(_a, this);
   }
   /**
    * Removes all items from the queuer
    */
   clear() {
+    var _a, _b;
     this._items = [];
-    this._options.onItemsChange(this);
+    (_b = (_a = this._options).onItemsChange) == null ? void 0 : _b.call(_a, this);
   }
   /**
    * Resets the queuer to its initial state
    */
   reset(withInitialItems) {
     this.clear();
-    this._executionCount = 0;
+    this._successCount = 0;
+    this._errorCount = 0;
+    this._settledCount = 0;
     if (withInitialItems) {
       this._items = [...this._options.initialItems];
     }
@@ -194,60 +196,47 @@ class AsyncQueuer {
    * Adds a task to the queuer
    */
   addItem(fn, position = this._options.addItemsTo, runOnItemsChange = true) {
+    var _a, _b, _c, _d;
     if (this.getIsFull()) {
       this._rejectionCount++;
-      this._options.onReject(fn, this);
-      return Promise.reject(new Error("Queuer is full"));
+      (_b = (_a = this._options).onReject) == null ? void 0 : _b.call(_a, fn, this);
+      return;
     }
-    return new Promise((resolve, reject) => {
-      const task = Object.assign(
-        async () => {
-          try {
-            const result = await fn();
-            resolve(result);
-            return result;
-          } catch (error) {
-            reject(error);
-            throw error;
-          }
-        },
-        { priority: fn.priority ?? void 0 }
-      );
-      const priority = this._options.getPriority !== defaultOptions.getPriority ? this._options.getPriority(task) : task.priority;
-      if (priority !== void 0) {
-        const insertIndex = this._items.findIndex((existing) => {
-          const existingPriority = this._options.getPriority !== defaultOptions.getPriority ? this._options.getPriority(existing) : existing.priority;
-          return existingPriority > priority;
-        });
-        if (insertIndex === -1) {
-          this._items.push(task);
-          this._itemTimestamps.push(Date.now());
-        } else {
-          this._items.splice(insertIndex, 0, task);
-          this._itemTimestamps.splice(insertIndex, 0, Date.now());
-        }
+    const priority = this._options.getPriority !== defaultOptions.getPriority ? this._options.getPriority(fn) : fn.priority;
+    if (priority !== void 0) {
+      const insertIndex = this._items.findIndex((existing) => {
+        const existingPriority = this._options.getPriority !== defaultOptions.getPriority ? this._options.getPriority(existing) : existing.priority;
+        return existingPriority > priority;
+      });
+      if (insertIndex === -1) {
+        this._items.push(fn);
+        this._itemTimestamps.push(Date.now());
       } else {
-        if (position === "front") {
-          this._items.unshift(task);
-          this._itemTimestamps.unshift(Date.now());
-        } else {
-          this._items.push(task);
-          this._itemTimestamps.push(Date.now());
-        }
-      }
-      if (runOnItemsChange) {
-        this._options.onItemsChange(this);
+        this._items.splice(insertIndex, 0, fn);
+        this._itemTimestamps.splice(insertIndex, 0, Date.now());
       }
-      if (this._running && !this._pendingTick) {
-        this._pendingTick = true;
-        this.tick();
+    } else {
+      if (position === "front") {
+        this._items.unshift(fn);
+        this._itemTimestamps.unshift(Date.now());
+      } else {
+        this._items.push(fn);
+        this._itemTimestamps.push(Date.now());
       }
-    });
+    }
+    if (runOnItemsChange) {
+      (_d = (_c = this._options).onItemsChange) == null ? void 0 : _d.call(_c, this);
+    }
+    if (this._running && !this._pendingTick) {
+      this._pendingTick = true;
+      this.tick();
+    }
   }
   /**
    * Removes and returns an item from the queuer
    */
   getNextItem(position = this._options.getItemsFrom) {
+    var _a, _b, _c, _d;
     let item;
     if (position === "front") {
       item = this._items.shift();
@@ -257,9 +246,8 @@ class AsyncQueuer {
       this._itemTimestamps.pop();
     }
     if (item !== void 0) {
-      this._executionCount++;
-      this._options.onItemsChange(this);
-      this._options.onGetNextItem(item, this);
+      (_b = (_a = this._options).onItemsChange) == null ? void 0 : _b.call(_a, this);
+      (_d = (_c = this._options).onGetNextItem) == null ? void 0 : _d.call(_c, item, this);
     }
     return item;
   }
@@ -309,10 +297,22 @@ class AsyncQueuer {
     return [...this._items];
   }
   /**
-   * Returns the number of items that have been removed from the queuer
+   * Returns the number of items that have been successfully processed
+   */
+  getSuccessCount() {
+    return this._successCount;
+  }
+  /**
+   * Returns the number of items that have failed processing
    */
-  getExecutionCount() {
-    return this._executionCount;
+  getErrorCount() {
+    return this._errorCount;
+  }
+  /**
+   * Returns the number of items that have completed processing (success or error)
+   */
+  getSettledCount() {
+    return this._settledCount;
   }
   /**
    * Returns the number of items that have been rejected from the queuer
@@ -332,37 +332,6 @@ class AsyncQueuer {
   getIsIdle() {
     return this._running && this.getIsEmpty() && this._activeItems.size === 0;
   }
-  /**
-   * Adds a callback to be called when a task succeeds
-   */
-  onSuccess(cb) {
-    this._onSuccessCallbacks.push(cb);
-    return () => {
-      this._onSuccessCallbacks = this._onSuccessCallbacks.filter(
-        (d) => d !== cb
-      );
-    };
-  }
-  /**
-   * Adds a callback to be called when a task errors
-   */
-  onError(cb) {
-    this._onErrorCallbacks.push(cb);
-    return () => {
-      this._onErrorCallbacks = this._onErrorCallbacks.filter((d) => d !== cb);
-    };
-  }
-  /**
-   * Adds a callback to be called when a task is settled
-   */
-  onSettled(cb) {
-    this._onSettledCallbacks.push(cb);
-    return () => {
-      this._onSettledCallbacks = this._onSettledCallbacks.filter(
-        (d) => d !== cb
-      );
-    };
-  }
   /**
    * Returns the number of items that have expired from the queuer
    */