@tanstack/pacer 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/async-debouncer.cjs

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const defaultOptions = {
+  enabled: true,
+  leading: false,
+  trailing: true,
+  onError: () => {
+  },
+  wait: 0
+};
+class AsyncDebouncer {
+  constructor(fn, initialOptions) {
+    this.fn = fn;
+    this.abortController = null;
+    this.executionCount = 0;
+    this.isExecuting = false;
+    this.timeoutId = null;
+    this.canLeadingExecute = true;
+    this.options = {
+      ...defaultOptions,
+      ...initialOptions
+    };
+  }
+  /**
+   * Updates the debouncer options
+   * Returns the new options state
+   */
+  setOptions(newOptions) {
+    this.options = {
+      ...this.options,
+      ...newOptions
+    };
+    return this.options;
+  }
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getExecutionCount() {
+    return this.executionCount;
+  }
+  /**
+   * Cancels any pending execution
+   */
+  cancel() {
+    if (this.timeoutId) {
+      clearTimeout(this.timeoutId);
+      this.timeoutId = null;
+    }
+    if (this.abortController) {
+      this.abortController.abort();
+      this.abortController = null;
+    }
+    this.lastArgs = void 0;
+    this.canLeadingExecute = true;
+  }
+  /**
+   * Attempts to execute the debounced function
+   * If a call is already in progress, it will be queued
+   */
+  async maybeExecute(...args) {
+    this.cancel();
+    this.lastArgs = args;
+    if (this.options.leading && this.canLeadingExecute) {
+      this.canLeadingExecute = false;
+      await this.executeFunction(...args);
+    }
+    return new Promise((resolve) => {
+      this.timeoutId = setTimeout(async () => {
+        if (this.isExecuting) {
+          resolve();
+          return;
+        }
+        this.canLeadingExecute = true;
+        if (this.options.trailing) {
+          this.abortController = new AbortController();
+          try {
+            this.isExecuting = true;
+            if (this.lastArgs) {
+              await this.executeFunction(...this.lastArgs);
+            }
+          } catch (error) {
+            try {
+              this.options.onError(error);
+            } catch {
+            }
+          } finally {
+            this.isExecuting = false;
+            this.abortController = null;
+            resolve();
+          }
+        } else {
+          resolve();
+        }
+      }, this.options.wait);
+    });
+  }
+  async executeFunction(...args) {
+    if (!this.options.enabled) return;
+    this.executionCount++;
+    await this.fn(...args);
+  }
+}
+function asyncDebounce(fn, initialOptions) {
+  const asyncDebouncer = new AsyncDebouncer(fn, initialOptions);
+  return asyncDebouncer.maybeExecute.bind(asyncDebouncer);
+}
+exports.AsyncDebouncer = AsyncDebouncer;
+exports.asyncDebounce = asyncDebounce;
+//# sourceMappingURL=async-debouncer.cjs.map

package/dist/cjs/async-debouncer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-debouncer.cjs","sources":["../../src/async-debouncer.ts"],"sourcesContent":["/**\n * Options for configuring an async debounced function\n */\nexport interface AsyncDebouncerOptions {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Delay in milliseconds to wait after the last call before executing\n   * Defaults to 0ms\n   */\n  wait: number\n  /**\n   * Optional error handler for when the debounced function throws\n   */\n  onError?: (error: unknown) => void\n}\n\nconst defaultOptions: Required<AsyncDebouncerOptions> = {\n  enabled: true,\n  leading: false,\n  trailing: true,\n  onError: () => {},\n  wait: 0,\n}\n\n/**\n * A class that creates an async debounced function.\n *\n * Debouncing ensures that a function is only executed after a specified delay has passed since its last invocation.\n * Each new invocation resets the delay timer. This is useful for handling frequent events like window resizing\n * or input changes where you only want to execute the handler after the events have stopped occurring.\n *\n * Unlike throttling which allows execution at regular intervals, debouncing prevents any execution until\n * the function stops being called for the specified delay period.\n *\n * @example\n * ```ts\n * const debouncer = new AsyncDebouncer(async (value: string) => {\n *   await searchAPI(value);\n * }, { wait: 500 });\n *\n * // Called on each keystroke but only executes after 500ms of no typing\n * inputElement.addEventListener('input', () => {\n *   debouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class AsyncDebouncer<\n  TFn extends (...args: Array<any>) => Promise<any>,\n  TArgs extends Parameters<TFn>,\n> {\n  private abortController: AbortController | null = null\n  private executionCount = 0\n  private isExecuting = false\n  private lastArgs: TArgs | undefined\n  private options: Required<AsyncDebouncerOptions>\n  private timeoutId: ReturnType<typeof setTimeout> | null = null\n  private canLeadingExecute = true\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncDebouncerOptions,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the debouncer options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncDebouncerOptions>,\n  ): Required<AsyncDebouncerOptions> {\n    this.options = {\n      ...this.options,\n      ...newOptions,\n    }\n    return this.options\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this.executionCount\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this.timeoutId) {\n      clearTimeout(this.timeoutId)\n      this.timeoutId = null\n    }\n    if (this.abortController) {\n      this.abortController.abort()\n      this.abortController = null\n    }\n    this.lastArgs = undefined\n    this.canLeadingExecute = true\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  async maybeExecute(...args: TArgs): Promise<void> {\n    this.cancel()\n    this.lastArgs = args\n\n    // Handle leading execution\n    if (this.options.leading && this.canLeadingExecute) {\n      this.canLeadingExecute = false\n      await this.executeFunction(...args)\n    }\n\n    return new Promise((resolve) => {\n      this.timeoutId = setTimeout(async () => {\n        if (this.isExecuting) {\n          resolve()\n          return\n        }\n\n        this.canLeadingExecute = true\n        // Execute trailing only if enabled\n        if (this.options.trailing) {\n          this.abortController = new AbortController()\n          try {\n            this.isExecuting = true\n            if (this.lastArgs) {\n              await this.executeFunction(...this.lastArgs)\n            }\n          } catch (error) {\n            try {\n              this.options.onError(error)\n            } catch {\n              // Ignore errors from error handler\n            }\n          } finally {\n            this.isExecuting = false\n            this.abortController = null\n            resolve()\n          }\n        } else {\n          resolve()\n        }\n      }, this.options.wait)\n    })\n  }\n\n  private async executeFunction(...args: TArgs): Promise<void> {\n    if (!this.options.enabled) return\n    this.executionCount++\n    await this.fn(...args)\n  }\n}\n\n/**\n * Creates an async debounced function that delays execution until after a specified wait time.\n * The debounced function will only execute once the wait period has elapsed without any new calls.\n * If called again during the wait period, the timer resets and a new wait period begins.\n *\n * @example\n * ```ts\n * const debounced = asyncDebounce(async (value: string) => {\n *   await saveToAPI(value);\n * }, { wait: 1000 });\n *\n * // Will only execute once, 1 second after the last call\n * await debounced(\"first\");  // Cancelled\n * await debounced(\"second\"); // Cancelled\n * await debounced(\"third\");  // Executes after 1s\n * ```\n */\nexport function asyncDebounce<\n  TFn extends (...args: Array<any>) => Promise<any>,\n>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions, 'enabled'>) {\n  const asyncDebouncer = new AsyncDebouncer(fn, initialOptions)\n  return asyncDebouncer.maybeExecute.bind(asyncDebouncer)\n}\n"],"names":[],"mappings":";;AA8BA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,MAAM;AACR;AAwBO,MAAM,eAGX;AAAA,EASA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,kBAA0C;AAClD,SAAQ,iBAAiB;AACzB,SAAQ,cAAc;AAGtB,SAAQ,YAAkD;AAC1D,SAAQ,oBAAoB;AAM1B,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACiC;AACjC,SAAK,UAAU;AAAA,MACb,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAe;AACb,QAAI,KAAK,WAAW;AAClB,mBAAa,KAAK,SAAS;AAC3B,WAAK,YAAY;AAAA,IAAA;AAEnB,QAAI,KAAK,iBAAiB;AACxB,WAAK,gBAAgB,MAAM;AAC3B,WAAK,kBAAkB;AAAA,IAAA;AAEzB,SAAK,WAAW;AAChB,SAAK,oBAAoB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3B,MAAM,gBAAgB,MAA4B;AAChD,SAAK,OAAO;AACZ,SAAK,WAAW;AAGhB,QAAI,KAAK,QAAQ,WAAW,KAAK,mBAAmB;AAClD,WAAK,oBAAoB;AACnB,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAAA,IAAA;AAG7B,WAAA,IAAI,QAAQ,CAAC,YAAY;AACzB,WAAA,YAAY,WAAW,YAAY;AACtC,YAAI,KAAK,aAAa;AACZ,kBAAA;AACR;AAAA,QAAA;AAGF,aAAK,oBAAoB;AAErB,YAAA,KAAK,QAAQ,UAAU;AACpB,eAAA,kBAAkB,IAAI,gBAAgB;AACvC,cAAA;AACF,iBAAK,cAAc;AACnB,gBAAI,KAAK,UAAU;AACjB,oBAAM,KAAK,gBAAgB,GAAG,KAAK,QAAQ;AAAA,YAAA;AAAA,mBAEtC,OAAO;AACV,gBAAA;AACG,mBAAA,QAAQ,QAAQ,KAAK;AAAA,YAAA,QACpB;AAAA,YAAA;AAAA,UAER,UACA;AACA,iBAAK,cAAc;AACnB,iBAAK,kBAAkB;AACf,oBAAA;AAAA,UAAA;AAAA,QACV,OACK;AACG,kBAAA;AAAA,QAAA;AAAA,MACV,GACC,KAAK,QAAQ,IAAI;AAAA,IAAA,CACrB;AAAA,EAAA;AAAA,EAGH,MAAc,mBAAmB,MAA4B;AACvD,QAAA,CAAC,KAAK,QAAQ,QAAS;AACtB,SAAA;AACC,UAAA,KAAK,GAAG,GAAG,IAAI;AAAA,EAAA;AAEzB;AAmBgB,SAAA,cAEd,IAAS,gBAAwD;AACjE,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;;;"}

package/dist/cjs/async-debouncer.d.cts

@@ -0,0 +1,99 @@
+/**
+ * Options for configuring an async debounced function
+ */
+export interface AsyncDebouncerOptions {
+    /**
+     * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Defaults to true.
+     */
+    enabled?: boolean;
+    /**
+     * Whether to execute on the leading edge of the timeout.
+     * Defaults to false.
+     */
+    leading?: boolean;
+    /**
+     * Whether to execute on the trailing edge of the timeout.
+     * Defaults to true.
+     */
+    trailing?: boolean;
+    /**
+     * Delay in milliseconds to wait after the last call before executing
+     * Defaults to 0ms
+     */
+    wait: number;
+    /**
+     * Optional error handler for when the debounced function throws
+     */
+    onError?: (error: unknown) => void;
+}
+/**
+ * A class that creates an async debounced function.
+ *
+ * Debouncing ensures that a function is only executed after a specified delay has passed since its last invocation.
+ * 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.
+ *
+ * @example
+ * ```ts
+ * const debouncer = new AsyncDebouncer(async (value: string) => {
+ *   await searchAPI(value);
+ * }, { wait: 500 });
+ *
+ * // Called on each keystroke but only executes after 500ms of no typing
+ * inputElement.addEventListener('input', () => {
+ *   debouncer.maybeExecute(inputElement.value);
+ * });
+ * ```
+ */
+export declare class AsyncDebouncer<TFn extends (...args: Array<any>) => Promise<any>, TArgs extends Parameters<TFn>> {
+    private fn;
+    private abortController;
+    private executionCount;
+    private isExecuting;
+    private lastArgs;
+    private options;
+    private timeoutId;
+    private canLeadingExecute;
+    constructor(fn: TFn, initialOptions: AsyncDebouncerOptions);
+    /**
+     * Updates the debouncer options
+     * Returns the new options state
+     */
+    setOptions(newOptions: Partial<AsyncDebouncerOptions>): Required<AsyncDebouncerOptions>;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Cancels any pending execution
+     */
+    cancel(): void;
+    /**
+     * Attempts to execute the debounced function
+     * If a call is already in progress, it will be queued
+     */
+    maybeExecute(...args: TArgs): Promise<void>;
+    private executeFunction;
+}
+/**
+ * Creates an async debounced function that delays execution until after a specified wait time.
+ * The debounced function will only execute once the wait period has elapsed without any new calls.
+ * If called again during the wait period, the timer resets and a new wait period begins.
+ *
+ * @example
+ * ```ts
+ * const debounced = asyncDebounce(async (value: string) => {
+ *   await saveToAPI(value);
+ * }, { wait: 1000 });
+ *
+ * // Will only execute once, 1 second after the last call
+ * await debounced("first");  // Cancelled
+ * await debounced("second"); // Cancelled
+ * await debounced("third");  // Executes after 1s
+ * ```
+ */
+export declare function asyncDebounce<TFn extends (...args: Array<any>) => Promise<any>>(fn: TFn, initialOptions: Omit<AsyncDebouncerOptions, 'enabled'>): (...args: Parameters<TFn>) => Promise<void>;

package/dist/cjs/async-queuer.cjs

@@ -0,0 +1,293 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const defaultOptions = {
+  addItemsTo: "back",
+  concurrency: 1,
+  getItemsFrom: "front",
+  getPriority: (item) => item.priority ?? 0,
+  initialItems: [],
+  maxSize: Infinity,
+  onGetNextItem: () => {
+  },
+  onUpdate: () => {
+  },
+  started: false,
+  wait: 0
+};
+class AsyncQueuer {
+  constructor(initialOptions = defaultOptions) {
+    this.items = [];
+    this.activeItems = /* @__PURE__ */ new Set();
+    this.onSuccessCallbacks = [];
+    this.onErrorCallbacks = [];
+    this.onSettledCallbacks = [];
+    this.pendingTick = false;
+    this.executionCount = 0;
+    this.options = { ...defaultOptions, ...initialOptions };
+    this.running = this.options.started;
+    for (let i = 0; i < this.options.initialItems.length; i++) {
+      const item = this.options.initialItems[i];
+      const isLast = i === this.options.initialItems.length - 1;
+      this.addItem(item, this.options.addItemsTo, isLast);
+    }
+  }
+  /**
+   * Updates the queuer options
+   * Returns the new options state
+   */
+  setOptions(newOptions) {
+    this.options = { ...this.options, ...newOptions };
+    return this.options;
+  }
+  /**
+   * Processes items in the queuer
+   */
+  tick() {
+    if (!this.running) {
+      this.pendingTick = false;
+      return;
+    }
+    while (this.activeItems.size < this.options.concurrency && !this.isEmpty()) {
+      const nextFn = this.getNextItem();
+      if (!nextFn) {
+        break;
+      }
+      this.activeItems.add(nextFn);
+      (async () => {
+        let success = false;
+        let res;
+        let error;
+        try {
+          res = await nextFn();
+          success = true;
+        } catch (e) {
+          error = e;
+        } finally {
+          this.options.onUpdate(this);
+        }
+        this.activeItems.delete(nextFn);
+        if (success) {
+          this.onSuccessCallbacks.forEach((cb) => cb(res));
+        } else {
+          this.onErrorCallbacks.forEach((cb) => cb(error));
+        }
+        this.onSettledCallbacks.forEach((cb) => cb(success ? res : error));
+        if (this.options.wait > 0) {
+          setTimeout(() => this.tick(), this.options.wait);
+          return;
+        }
+        this.tick();
+      })();
+    }
+    this.pendingTick = false;
+  }
+  /**
+   * Adds a task to the queuer
+   */
+  addItem(fn, position = this.options.addItemsTo, runOnUpdate = true) {
+    if (this.isFull()) {
+      return Promise.reject(new Error("Queuer is full"));
+    }
+    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);
+        } else {
+          this.items.splice(insertIndex, 0, task);
+        }
+      } else {
+        if (position === "front") {
+          this.items.unshift(task);
+        } else {
+          this.items.push(task);
+        }
+      }
+      if (runOnUpdate) {
+        this.options.onUpdate(this);
+      }
+      if (this.running && !this.pendingTick) {
+        this.pendingTick = true;
+        this.tick();
+      }
+    });
+  }
+  /**
+   * Removes and returns an item from the queuer
+   */
+  getNextItem(position = this.options.getItemsFrom) {
+    let item;
+    if (position === "front") {
+      item = this.items.shift();
+    } else {
+      item = this.items.pop();
+    }
+    if (item !== void 0) {
+      this.executionCount++;
+      this.options.onUpdate(this);
+      this.options.onGetNextItem(item, this);
+    }
+    return item;
+  }
+  /**
+   * Returns an item without removing it
+   */
+  peek(position = "front") {
+    if (position === "front") {
+      return this.items[0];
+    }
+    return this.items[this.items.length - 1];
+  }
+  /**
+   * Returns true if the queuer is empty
+   */
+  isEmpty() {
+    return this.items.length === 0;
+  }
+  /**
+   * Returns true if the queuer is full
+   */
+  isFull() {
+    return this.items.length >= this.options.maxSize;
+  }
+  /**
+   * Returns the current size of the queuer
+   */
+  size() {
+    return this.items.length;
+  }
+  /**
+   * Removes all items from the queuer
+   */
+  clear() {
+    this.items = [];
+    this.options.onUpdate(this);
+  }
+  /**
+   * Resets the queuer to its initial state
+   */
+  reset(withInitialItems) {
+    this.clear();
+    this.executionCount = 0;
+    if (withInitialItems) {
+      this.items = [...this.options.initialItems];
+    }
+    this.running = this.options.started;
+  }
+  /**
+   * Returns a copy of all items in the queuer
+   */
+  getAllItems() {
+    return [...this.items];
+  }
+  /**
+   * Returns the number of items that have been removed from the queuer
+   */
+  getExecutionCount() {
+    return this.executionCount;
+  }
+  /**
+   * Returns the active items
+   */
+  getActiveItems() {
+    return Array.from(this.activeItems);
+  }
+  /**
+   * Returns the pending items
+   */
+  getPendingItems() {
+    return this.getAllItems();
+  }
+  /**
+   * 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);
+    };
+  }
+  /**
+   * Starts the queuer and processes items
+   */
+  start() {
+    this.running = true;
+    if (!this.pendingTick && !this.isEmpty()) {
+      this.pendingTick = true;
+      this.tick();
+    }
+    this.options.onUpdate(this);
+    return new Promise((resolve) => {
+      const checkIdle = () => {
+        if (this.isIdle()) {
+          resolve();
+        } else {
+          setTimeout(checkIdle, 100);
+        }
+      };
+      checkIdle();
+    });
+  }
+  /**
+   * Stops the queuer from processing items
+   */
+  stop() {
+    this.running = false;
+    this.pendingTick = false;
+    this.options.onUpdate(this);
+  }
+  /**
+   * Returns true if the queuer is running
+   */
+  isRunning() {
+    return this.running;
+  }
+  /**
+   * Returns true if the queuer is running but has no items to process
+   */
+  isIdle() {
+    return this.running && this.isEmpty() && this.activeItems.size === 0;
+  }
+}
+function asyncQueue(options = {}) {
+  const queuer = new AsyncQueuer({ ...options, started: true });
+  return queuer.addItem.bind(queuer);
+}
+exports.AsyncQueuer = AsyncQueuer;
+exports.asyncQueue = asyncQueue;
+//# sourceMappingURL=async-queuer.cjs.map

package/dist/cjs/async-queuer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-queuer.cjs","sources":["../../src/async-queuer.ts"],"sourcesContent":["import type { QueuePosition } from './queuer'\n\nexport interface AsyncQueuerOptions<TValue> {\n  /**\n   * Default position to add items to the queuer\n   * @default 'back'\n   */\n  addItemsTo?: QueuePosition\n  /**\n   * Maximum number of concurrent tasks to process\n   */\n  concurrency?: number\n  /**\n   * Default position to get items from during processing\n   * @default 'front'\n   */\n  getItemsFrom?: QueuePosition\n  /**\n   * Function to determine priority of items in the queuer\n   * Higher priority items will be processed first\n   * If not provided, will use static priority values attached to tasks\n   */\n  getPriority?: (item: () => Promise<TValue>) => number\n  /**\n   * Initial items to populate the queuer with\n   */\n  initialItems?: Array<(() => Promise<TValue>) & { priority?: number }>\n  /**\n   * Maximum number of items allowed in the queuer\n   */\n  maxSize?: number\n  /**\n   * Callback fired whenever an item is removed from the queuer\n   */\n  onGetNextItem?: (\n    item: () => Promise<TValue>,\n    queuer: AsyncQueuer<TValue>,\n  ) => void\n  /**\n   * Callback fired whenever an item is added or removed from the queuer\n   */\n  onUpdate?: (queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Whether the queuer should start processing tasks immediately\n   */\n  started?: boolean\n  /**\n   * Time in milliseconds to wait between processing items\n   */\n  wait?: number\n}\n\nconst defaultOptions: Required<AsyncQueuerOptions<any>> = {\n  addItemsTo: 'back',\n  concurrency: 1,\n  getItemsFrom: 'front',\n  getPriority: (item) => (item as any).priority ?? 0,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onUpdate: () => {},\n  started: false,\n  wait: 0,\n}\n\n/**\n * A flexible asynchronous queuer that processes tasks with configurable concurrency control.\n *\n * Features:\n * - Priority queuer 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) queuer behavior\n * - Pause/resume task processing\n * - Task cancellation\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 * @example\n * ```ts\n * const queuer = new AsyncQueuer<string>({ concurrency: 2 });\n *\n * queuer.addItem(async () => {\n *   return 'Hello';\n * });\n *\n * queuer.start();\n *\n * queuer.onSuccess((result) => {\n *   console.log(result); // 'Hello'\n * });\n * ```\n */\nexport class AsyncQueuer<TValue> {\n  protected options: Required<AsyncQueuerOptions<TValue>>\n  private items: Array<() => Promise<TValue>> = []\n  private activeItems: Set<() => Promise<TValue>> = new Set()\n  private onSuccessCallbacks: Array<(result: TValue) => void> = []\n  private onErrorCallbacks: Array<(error: Error) => void> = []\n  private onSettledCallbacks: Array<(result: TValue | Error) => void> = []\n  private running: boolean\n  private pendingTick = false\n  private executionCount = 0\n\n  constructor(initialOptions: AsyncQueuerOptions<TValue> = defaultOptions) {\n    this.options = { ...defaultOptions, ...initialOptions }\n    this.running = this.options.started\n\n    for (let i = 0; i < this.options.initialItems.length; i++) {\n      const item = this.options.initialItems[i]!\n      const isLast = i === this.options.initialItems.length - 1\n      this.addItem(item, this.options.addItemsTo, isLast)\n    }\n  }\n\n  /**\n   * Updates the queuer options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<AsyncQueuerOptions<TValue>>,\n  ): AsyncQueuerOptions<TValue> {\n    this.options = { ...this.options, ...newOptions }\n    return this.options\n  }\n\n  /**\n   * Processes items in the queuer\n   */\n  protected tick() {\n    if (!this.running) {\n      this.pendingTick = false\n      return\n    }\n\n    while (\n      this.activeItems.size < this.options.concurrency &&\n      !this.isEmpty()\n    ) {\n      const nextFn = this.getNextItem()\n      if (!nextFn) {\n        break\n      }\n\n      this.activeItems.add(nextFn)\n      ;(async () => {\n        let success = false\n        let res!: TValue\n        let error: Error | undefined\n\n        try {\n          res = await nextFn()\n          success = true\n        } catch (e) {\n          error = e as Error\n        } finally {\n          this.options.onUpdate(this)\n        }\n\n        this.activeItems.delete(nextFn)\n        if (success) {\n          this.onSuccessCallbacks.forEach((cb) => cb(res))\n        } else {\n          this.onErrorCallbacks.forEach((cb) => cb(error!))\n        }\n        this.onSettledCallbacks.forEach((cb) => cb(success ? res : error!))\n\n        if (this.options.wait > 0) {\n          setTimeout(() => this.tick(), this.options.wait)\n          return\n        }\n\n        this.tick()\n      })()\n    }\n\n    this.pendingTick = false\n  }\n\n  /**\n   * Adds a task to the queuer\n   */\n  addItem(\n    fn: (() => Promise<TValue>) & { priority?: number },\n    position: QueuePosition = this.options.addItemsTo,\n    runOnUpdate: boolean = true,\n  ): Promise<TValue> {\n    if (this.isFull()) {\n      return Promise.reject(new Error('Queuer is full'))\n    }\n\n    return new Promise<TValue>((resolve, reject) => {\n      const task = Object.assign(\n        async () => {\n          try {\n            const result = await fn()\n            resolve(result)\n            return result\n          } catch (error) {\n            reject(error)\n            throw error\n          }\n        },\n        { priority: fn.priority ?? undefined },\n      )\n\n      // Get priority either from the function or from getPriority option\n      const priority =\n        this.options.getPriority !== defaultOptions.getPriority\n          ? this.options.getPriority(task)\n          : task.priority\n\n      if (priority !== undefined) {\n        // Insert based on priority\n        const insertIndex = this.items.findIndex((existing) => {\n          const existingPriority =\n            this.options.getPriority !== defaultOptions.getPriority\n              ? this.options.getPriority(existing)\n              : (existing as any).priority\n          return existingPriority > priority\n        })\n\n        if (insertIndex === -1) {\n          this.items.push(task)\n        } else {\n          this.items.splice(insertIndex, 0, task)\n        }\n      } else {\n        // Default FIFO/LIFO behavior\n        if (position === 'front') {\n          this.items.unshift(task)\n        } else {\n          this.items.push(task)\n        }\n      }\n\n      if (runOnUpdate) {\n        this.options.onUpdate(this)\n      }\n\n      if (this.running && !this.pendingTick) {\n        this.pendingTick = true\n        this.tick()\n      }\n    })\n  }\n\n  /**\n   * Removes and returns an item from the queuer\n   */\n  getNextItem(\n    position: QueuePosition = this.options.getItemsFrom,\n  ): (() => Promise<TValue>) | undefined {\n    let item: (() => Promise<TValue>) | undefined\n\n    if (position === 'front') {\n      item = this.items.shift()\n    } else {\n      item = this.items.pop()\n    }\n\n    if (item !== undefined) {\n      this.executionCount++\n      this.options.onUpdate(this)\n      this.options.onGetNextItem(item, this)\n    }\n    return item\n  }\n\n  /**\n   * Returns an item without removing it\n   */\n  peek(position: QueuePosition = 'front'): (() => Promise<TValue>) | undefined {\n    if (position === 'front') {\n      return this.items[0]\n    }\n    return this.items[this.items.length - 1]\n  }\n\n  /**\n   * Returns true if the queuer is empty\n   */\n  isEmpty(): boolean {\n    return this.items.length === 0\n  }\n\n  /**\n   * Returns true if the queuer is full\n   */\n  isFull(): boolean {\n    return this.items.length >= this.options.maxSize\n  }\n\n  /**\n   * Returns the current size of the queuer\n   */\n  size(): number {\n    return this.items.length\n  }\n\n  /**\n   * Removes all items from the queuer\n   */\n  clear(): void {\n    this.items = []\n    this.options.onUpdate(this)\n  }\n\n  /**\n   * Resets the queuer to its initial state\n   */\n  reset(withInitialItems?: boolean): void {\n    this.clear()\n    this.executionCount = 0\n    if (withInitialItems) {\n      this.items = [...this.options.initialItems]\n    }\n    this.running = this.options.started\n  }\n\n  /**\n   * Returns a copy of all items in the queuer\n   */\n  getAllItems(): Array<() => Promise<TValue>> {\n    return [...this.items]\n  }\n\n  /**\n   * Returns the number of items that have been removed from the queuer\n   */\n  getExecutionCount(): number {\n    return this.executionCount\n  }\n\n  /**\n   * Returns the active items\n   */\n  getActiveItems(): Array<() => Promise<TValue>> {\n    return Array.from(this.activeItems)\n  }\n\n  /**\n   * Returns the pending items\n   */\n  getPendingItems(): Array<() => Promise<TValue>> {\n    return this.getAllItems()\n  }\n\n  /**\n   * Adds a callback to be called when a task succeeds\n   */\n  onSuccess(cb: (result: TValue) => void) {\n    this.onSuccessCallbacks.push(cb)\n    return () => {\n      this.onSuccessCallbacks = this.onSuccessCallbacks.filter((d) => d !== cb)\n    }\n  }\n\n  /**\n   * Adds a callback to be called when a task errors\n   */\n  onError(cb: (error: Error) => void) {\n    this.onErrorCallbacks.push(cb)\n    return () => {\n      this.onErrorCallbacks = this.onErrorCallbacks.filter((d) => d !== cb)\n    }\n  }\n\n  /**\n   * Adds a callback to be called when a task is settled\n   */\n  onSettled(cb: (result: TValue | Error) => void) {\n    this.onSettledCallbacks.push(cb)\n    return () => {\n      this.onSettledCallbacks = this.onSettledCallbacks.filter((d) => d !== cb)\n    }\n  }\n\n  /**\n   * Starts the queuer and processes items\n   */\n  start(): Promise<void> {\n    this.running = true\n    if (!this.pendingTick && !this.isEmpty()) {\n      this.pendingTick = true\n      this.tick()\n    }\n    this.options.onUpdate(this)\n\n    return new Promise<void>((resolve) => {\n      const checkIdle = () => {\n        if (this.isIdle()) {\n          resolve()\n        } else {\n          setTimeout(checkIdle, 100)\n        }\n      }\n      checkIdle()\n    })\n  }\n\n  /**\n   * Stops the queuer from processing items\n   */\n  stop(): void {\n    this.running = false\n    this.pendingTick = false\n    this.options.onUpdate(this)\n  }\n\n  /**\n   * Returns true if the queuer is running\n   */\n  isRunning(): boolean {\n    return this.running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  isIdle(): boolean {\n    return this.running && this.isEmpty() && this.activeItems.size === 0\n  }\n}\n\n/**\n * Creates a new AsyncQueuer instance with the given options and returns a bound addItem function.\n * The queuer is automatically started and ready to process items.\n *\n * @example\n * ```ts\n * const enqueue = asyncQueue<string>();\n *\n * // Add items to be processed\n * enqueue(async () => {\n *   return 'Hello';\n * });\n * ```\n *\n * @param options - Configuration options for the AsyncQueuer\n * @returns A bound addItem function that can be used to add tasks to the queuer\n */\nexport function asyncQueue<TValue>(options: AsyncQueuerOptions<TValue> = {}) {\n  const queuer = new AsyncQueuer<TValue>({ ...options, started: true })\n  return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":";;AAoDA,MAAM,iBAAoD;AAAA,EACxD,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,cAAc;AAAA,EACd,aAAa,CAAC,SAAU,KAAa,YAAY;AAAA,EACjD,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AA+BO,MAAM,YAAoB;AAAA,EAW/B,YAAY,iBAA6C,gBAAgB;AATzE,SAAQ,QAAsC,CAAC;AACvC,SAAA,kCAA8C,IAAI;AAC1D,SAAQ,qBAAsD,CAAC;AAC/D,SAAQ,mBAAkD,CAAC;AAC3D,SAAQ,qBAA8D,CAAC;AAEvE,SAAQ,cAAc;AACtB,SAAQ,iBAAiB;AAGvB,SAAK,UAAU,EAAE,GAAG,gBAAgB,GAAG,eAAe;AACjD,SAAA,UAAU,KAAK,QAAQ;AAE5B,aAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,aAAa,QAAQ,KAAK;AACzD,YAAM,OAAO,KAAK,QAAQ,aAAa,CAAC;AACxC,YAAM,SAAS,MAAM,KAAK,QAAQ,aAAa,SAAS;AACxD,WAAK,QAAQ,MAAM,KAAK,QAAQ,YAAY,MAAM;AAAA,IAAA;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YAC4B;AAC5B,SAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAW;AAChD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMJ,OAAO;AACX,QAAA,CAAC,KAAK,SAAS;AACjB,WAAK,cAAc;AACnB;AAAA,IAAA;AAIA,WAAA,KAAK,YAAY,OAAO,KAAK,QAAQ,eACrC,CAAC,KAAK,WACN;AACM,YAAA,SAAS,KAAK,YAAY;AAChC,UAAI,CAAC,QAAQ;AACX;AAAA,MAAA;AAGG,WAAA,YAAY,IAAI,MAAM;AAC1B,OAAC,YAAY;AACZ,YAAI,UAAU;AACV,YAAA;AACA,YAAA;AAEA,YAAA;AACF,gBAAM,MAAM,OAAO;AACT,oBAAA;AAAA,iBACH,GAAG;AACF,kBAAA;AAAA,QAAA,UACR;AACK,eAAA,QAAQ,SAAS,IAAI;AAAA,QAAA;AAGvB,aAAA,YAAY,OAAO,MAAM;AAC9B,YAAI,SAAS;AACX,eAAK,mBAAmB,QAAQ,CAAC,OAAO,GAAG,GAAG,CAAC;AAAA,QAAA,OAC1C;AACL,eAAK,iBAAiB,QAAQ,CAAC,OAAO,GAAG,KAAM,CAAC;AAAA,QAAA;AAE7C,aAAA,mBAAmB,QAAQ,CAAC,OAAO,GAAG,UAAU,MAAM,KAAM,CAAC;AAE9D,YAAA,KAAK,QAAQ,OAAO,GAAG;AACzB,qBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,QAAQ,IAAI;AAC/C;AAAA,QAAA;AAGF,aAAK,KAAK;AAAA,MAAA,GACT;AAAA,IAAA;AAGL,SAAK,cAAc;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,QACE,IACA,WAA0B,KAAK,QAAQ,YACvC,cAAuB,MACN;AACb,QAAA,KAAK,UAAU;AACjB,aAAO,QAAQ,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAAA,IAAA;AAGnD,WAAO,IAAI,QAAgB,CAAC,SAAS,WAAW;AAC9C,YAAM,OAAO,OAAO;AAAA,QAClB,YAAY;AACN,cAAA;AACI,kBAAA,SAAS,MAAM,GAAG;AACxB,oBAAQ,MAAM;AACP,mBAAA;AAAA,mBACA,OAAO;AACd,mBAAO,KAAK;AACN,kBAAA;AAAA,UAAA;AAAA,QAEV;AAAA,QACA,EAAE,UAAU,GAAG,YAAY,OAAU;AAAA,MACvC;AAGM,YAAA,WACJ,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAY,IAAI,IAC7B,KAAK;AAEX,UAAI,aAAa,QAAW;AAE1B,cAAM,cAAc,KAAK,MAAM,UAAU,CAAC,aAAa;AAC/C,gBAAA,mBACJ,KAAK,QAAQ,gBAAgB,eAAe,cACxC,KAAK,QAAQ,YAAY,QAAQ,IAChC,SAAiB;AACxB,iBAAO,mBAAmB;AAAA,QAAA,CAC3B;AAED,YAAI,gBAAgB,IAAI;AACjB,eAAA,MAAM,KAAK,IAAI;AAAA,QAAA,OACf;AACL,eAAK,MAAM,OAAO,aAAa,GAAG,IAAI;AAAA,QAAA;AAAA,MACxC,OACK;AAEL,YAAI,aAAa,SAAS;AACnB,eAAA,MAAM,QAAQ,IAAI;AAAA,QAAA,OAClB;AACA,eAAA,MAAM,KAAK,IAAI;AAAA,QAAA;AAAA,MACtB;AAGF,UAAI,aAAa;AACV,aAAA,QAAQ,SAAS,IAAI;AAAA,MAAA;AAG5B,UAAI,KAAK,WAAW,CAAC,KAAK,aAAa;AACrC,aAAK,cAAc;AACnB,aAAK,KAAK;AAAA,MAAA;AAAA,IACZ,CACD;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMH,YACE,WAA0B,KAAK,QAAQ,cACF;AACjC,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,MAAM;AAAA,IAAA,OACnB;AACE,aAAA,KAAK,MAAM,IAAI;AAAA,IAAA;AAGxB,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,QAAQ,SAAS,IAAI;AACrB,WAAA,QAAQ,cAAc,MAAM,IAAI;AAAA,IAAA;AAEhC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMT,KAAK,WAA0B,SAA8C;AAC3E,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,CAAC;AAAA,IAAA;AAErB,WAAO,KAAK,MAAM,KAAK,MAAM,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,UAAmB;AACV,WAAA,KAAK,MAAM,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,SAAkB;AAChB,WAAO,KAAK,MAAM,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,OAAe;AACb,WAAO,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpB,QAAc;AACZ,SAAK,QAAQ,CAAC;AACT,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,iBAAiB;AACtB,QAAI,kBAAkB;AACpB,WAAK,QAAQ,CAAC,GAAG,KAAK,QAAQ,YAAY;AAAA,IAAA;AAEvC,SAAA,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,cAA4C;AACnC,WAAA,CAAC,GAAG,KAAK,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAA+C;AACtC,WAAA,MAAM,KAAK,KAAK,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpC,kBAAgD;AAC9C,WAAO,KAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM1B,UAAU,IAA8B;AACjC,SAAA,mBAAmB,KAAK,EAAE;AAC/B,WAAO,MAAM;AACX,WAAK,qBAAqB,KAAK,mBAAmB,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IAC1E;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,QAAQ,IAA4B;AAC7B,SAAA,iBAAiB,KAAK,EAAE;AAC7B,WAAO,MAAM;AACX,WAAK,mBAAmB,KAAK,iBAAiB,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IACtE;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,UAAU,IAAsC;AACzC,SAAA,mBAAmB,KAAK,EAAE;AAC/B,WAAO,MAAM;AACX,WAAK,qBAAqB,KAAK,mBAAmB,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IAC1E;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,QAAuB;AACrB,SAAK,UAAU;AACf,QAAI,CAAC,KAAK,eAAe,CAAC,KAAK,WAAW;AACxC,WAAK,cAAc;AACnB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,QAAQ,SAAS,IAAI;AAEnB,WAAA,IAAI,QAAc,CAAC,YAAY;AACpC,YAAM,YAAY,MAAM;AAClB,YAAA,KAAK,UAAU;AACT,kBAAA;AAAA,QAAA,OACH;AACL,qBAAW,WAAW,GAAG;AAAA,QAAA;AAAA,MAE7B;AACU,gBAAA;AAAA,IAAA,CACX;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMH,OAAa;AACX,SAAK,UAAU;AACf,SAAK,cAAc;AACd,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,YAAqB;AACnB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAkB;AAChB,WAAO,KAAK,WAAW,KAAK,QAAa,KAAA,KAAK,YAAY,SAAS;AAAA,EAAA;AAEvE;AAmBgB,SAAA,WAAmB,UAAsC,IAAI;AACrE,QAAA,SAAS,IAAI,YAAoB,EAAE,GAAG,SAAS,SAAS,MAAM;AAC7D,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;;;"}