@tanstack/pacer 0.1.0

package/dist/cjs/throttler.d.cts

@@ -0,0 +1,139 @@
+/**
+ * Options for configuring a throttled function
+ */
+export interface ThrottlerOptions {
+    /**
+     * Whether the throttler 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 true.
+     */
+    leading?: boolean;
+    /**
+     * Whether to execute on the trailing edge of the timeout.
+     * Defaults to true.
+     */
+    trailing?: boolean;
+    /**
+     * Time window in milliseconds during which the function can only be executed once
+     */
+    wait: number;
+}
+/**
+ * A class that creates a throttled function.
+ *
+ * Throttling ensures a function is called at most once within a specified time window.
+ * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent
+ * execution timing regardless of call frequency.
+ *
+ * Supports both leading and trailing edge execution:
+ * - Leading: Execute immediately on first call (default: true)
+ * - Trailing: Execute after wait period if called during throttle (default: true)
+ *
+ * For rate limiting or hard API limits, consider using RateLimiter instead.
+ * For collapsing rapid-fire events, consider using Debouncer.
+ *
+ * @example
+ * ```ts
+ * const throttler = new Throttler(
+ *   (id: string) => api.getData(id),
+ *   { wait: 1000 } // Execute at most once per second
+ * );
+ *
+ * // First call executes immediately
+ * throttler.maybeExecute('123');
+ *
+ * // Subsequent calls within 1000ms are throttled
+ * throttler.maybeExecute('123'); // Throttled
+ * ```
+ */
+export declare class Throttler<TFn extends (...args: Array<any>) => any, TArgs extends Parameters<TFn>> {
+    private fn;
+    private executionCount;
+    private lastArgs;
+    private lastExecutionTime;
+    private options;
+    private timeoutId;
+    constructor(fn: TFn, initialOptions: ThrottlerOptions);
+    /**
+     * Updates the throttler options
+     * Returns the new options state
+     */
+    setOptions(newOptions: Partial<ThrottlerOptions>): Required<ThrottlerOptions>;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns the last execution time
+     */
+    getLastExecutionTime(): number;
+    /**
+     * Returns the next execution time
+     */
+    getNextExecutionTime(): number;
+    /**
+     * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
+     *
+     * - If enough time has passed since the last execution (>= wait period):
+     *   - With leading=true: Executes immediately
+     *   - With leading=false: Waits for the next trailing execution
+     *
+     * - If within the wait period:
+     *   - With trailing=true: Schedules execution for end of wait period
+     *   - With trailing=false: Drops the execution
+     *
+     * @example
+     * ```ts
+     * const throttled = new Throttler(fn, { wait: 1000 });
+     *
+     * // First call executes immediately
+     * throttled.maybeExecute('a', 'b');
+     *
+     * // Call during wait period - gets throttled
+     * throttled.maybeExecute('c', 'd');
+     * ```
+     */
+    maybeExecute(...args: TArgs): void;
+    private executeFunction;
+    /**
+     * Cancels any pending trailing execution and clears internal state.
+     *
+     * If a trailing execution is scheduled (due to throttling with trailing=true),
+     * this will prevent that execution from occurring. The internal timeout and
+     * stored arguments will be cleared.
+     *
+     * Has no effect if there is no pending execution.
+     */
+    cancel(): void;
+}
+/**
+ * Creates a throttled function that limits how often the provided function can execute.
+ *
+ * Throttling ensures a function executes at most once within a specified time window,
+ * regardless of how many times it is called. This is useful for rate-limiting
+ * expensive operations or UI updates.
+ *
+ * The throttled function can be configured to execute on the leading and/or trailing
+ * edge of the throttle window via options.
+ *
+ * For handling bursts of events, consider using debounce() instead. For hard execution
+ * limits, consider using rateLimit().
+ *
+ * @example
+ * ```ts
+ * // Basic throttling - max once per second
+ * const throttled = throttle(updateUI, { wait: 1000 });
+ *
+ * // Configure leading/trailing execution
+ * const throttled = throttle(saveData, {
+ *   wait: 2000,
+ *   leading: true,  // Execute immediately on first call
+ *   trailing: true  // Execute again after delay if called during wait
+ * });
+ * ```
+ */
+export declare function throttle<TFn extends (...args: Array<any>) => any>(fn: TFn, initialOptions: Omit<ThrottlerOptions, 'enabled'>): (...args: Parameters<TFn>) => void;

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

@@ -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/esm/async-debouncer.js

@@ -0,0 +1,109 @@
+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);
+}
+export {
+  AsyncDebouncer,
+  asyncDebounce
+};
+//# sourceMappingURL=async-debouncer.js.map

package/dist/esm/async-debouncer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-debouncer.js","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/esm/async-queuer.d.ts

@@ -0,0 +1,197 @@
+import { QueuePosition } from './queuer.js';
+export interface AsyncQueuerOptions<TValue> {
+    /**
+     * Default position to add items to the queuer
+     * @default 'back'
+     */
+    addItemsTo?: QueuePosition;
+    /**
+     * Maximum number of concurrent tasks to process
+     */
+    concurrency?: number;
+    /**
+     * Default position to get items from during processing
+     * @default 'front'
+     */
+    getItemsFrom?: QueuePosition;
+    /**
+     * Function to determine priority of items in the queuer
+     * Higher priority items will be processed first
+     * If not provided, will use static priority values attached to tasks
+     */
+    getPriority?: (item: () => Promise<TValue>) => number;
+    /**
+     * Initial items to populate the queuer with
+     */
+    initialItems?: Array<(() => Promise<TValue>) & {
+        priority?: number;
+    }>;
+    /**
+     * Maximum number of items allowed in the queuer
+     */
+    maxSize?: number;
+    /**
+     * Callback fired whenever an item is removed from the queuer
+     */
+    onGetNextItem?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Callback fired whenever an item is added or removed from the queuer
+     */
+    onUpdate?: (queuer: AsyncQueuer<TValue>) => void;
+    /**
+     * Whether the queuer should start processing tasks immediately
+     */
+    started?: boolean;
+    /**
+     * Time in milliseconds to wait between processing items
+     */
+    wait?: number;
+}
+/**
+ * A flexible asynchronous queuer that processes tasks with configurable concurrency control.
+ *
+ * Features:
+ * - Priority queuer support via getPriority option
+ * - Configurable concurrency limit
+ * - Task success/error/completion callbacks
+ * - FIFO (First In First Out) or LIFO (Last In First Out) queuer behavior
+ * - Pause/resume task processing
+ * - Task cancellation
+ *
+ * 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.
+ *
+ * @example
+ * ```ts
+ * const queuer = new AsyncQueuer<string>({ concurrency: 2 });
+ *
+ * queuer.addItem(async () => {
+ *   return 'Hello';
+ * });
+ *
+ * queuer.start();
+ *
+ * queuer.onSuccess((result) => {
+ *   console.log(result); // 'Hello'
+ * });
+ * ```
+ */
+export declare class AsyncQueuer<TValue> {
+    protected options: Required<AsyncQueuerOptions<TValue>>;
+    private items;
+    private activeItems;
+    private onSuccessCallbacks;
+    private onErrorCallbacks;
+    private onSettledCallbacks;
+    private running;
+    private pendingTick;
+    private executionCount;
+    constructor(initialOptions?: AsyncQueuerOptions<TValue>);
+    /**
+     * Updates the queuer options
+     * Returns the new options state
+     */
+    setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): AsyncQueuerOptions<TValue>;
+    /**
+     * Processes items in the queuer
+     */
+    protected tick(): void;
+    /**
+     * Adds a task to the queuer
+     */
+    addItem(fn: (() => Promise<TValue>) & {
+        priority?: number;
+    }, position?: QueuePosition, runOnUpdate?: boolean): Promise<TValue>;
+    /**
+     * Removes and returns an item from the queuer
+     */
+    getNextItem(position?: QueuePosition): (() => Promise<TValue>) | undefined;
+    /**
+     * Returns an item without removing it
+     */
+    peek(position?: QueuePosition): (() => Promise<TValue>) | undefined;
+    /**
+     * Returns true if the queuer is empty
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns true if the queuer is full
+     */
+    isFull(): boolean;
+    /**
+     * Returns the current size of the queuer
+     */
+    size(): number;
+    /**
+     * Removes all items from the queuer
+     */
+    clear(): void;
+    /**
+     * Resets the queuer to its initial state
+     */
+    reset(withInitialItems?: boolean): void;
+    /**
+     * Returns a copy of all items in the queuer
+     */
+    getAllItems(): Array<() => Promise<TValue>>;
+    /**
+     * Returns the number of items that have been removed from the queuer
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns the active items
+     */
+    getActiveItems(): Array<() => Promise<TValue>>;
+    /**
+     * Returns the pending items
+     */
+    getPendingItems(): Array<() => Promise<TValue>>;
+    /**
+     * 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;
+    /**
+     * Starts the queuer and processes items
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the queuer from processing items
+     */
+    stop(): void;
+    /**
+     * Returns true if the queuer is running
+     */
+    isRunning(): boolean;
+    /**
+     * Returns true if the queuer is running but has no items to process
+     */
+    isIdle(): boolean;
+}
+/**
+ * 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.
+ *
+ * @example
+ * ```ts
+ * const enqueue = asyncQueue<string>();
+ *
+ * // Add items to be processed
+ * enqueue(async () => {
+ *   return 'Hello';
+ * });
+ * ```
+ *
+ * @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: (() => Promise<TValue>) & {
+    priority?: number;
+}, position?: QueuePosition, runOnUpdate?: boolean) => Promise<TValue>;