@tanstack/pacer 0.6.0 → 0.8.0

package/dist/esm/debouncer.js.map

@@ -1 +1 @@
-{"version":3,"file":"debouncer.js","sources":["../../src/debouncer.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\n/**\n * Options for configuring a debounced function\n */\nexport interface DebouncerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean)\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * The first call will execute immediately and the rest will wait the delay.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (debouncer: Debouncer<TFn>) => void\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 before executing the function.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((debouncer: Debouncer<TFn>) => number)\n}\n\nconst defaultOptions: Required<DebouncerOptions<any>> = {\n  enabled: true,\n  leading: false,\n  onExecute: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a debounced function.\n *\n * Debouncing ensures that a function is only executed after a certain amount of time has passed\n * since its last invocation. This is useful for handling frequent events like window resizing,\n * scroll events, or input changes where you want to limit the rate of execution.\n *\n * The debounced function can be configured to execute either at the start of the delay period\n * (leading edge) or at the end (trailing edge, default). Each new call during the wait period\n * will reset the timer.\n *\n * @example\n * ```ts\n * const debouncer = new Debouncer((value: string) => {\n *   saveToDatabase(value);\n * }, { wait: 500 });\n *\n * // Will only save after 500ms of no new input\n * inputElement.addEventListener('input', () => {\n *   debouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class Debouncer<TFn extends AnyFunction> {\n  private _canLeadingExecute = true\n  private _executionCount = 0\n  private _isPending = false\n  private _options: Required<DebouncerOptions<TFn>>\n  private _timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    private fn: TFn,\n    initialOptions: DebouncerOptions<TFn>,\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(newOptions: Partial<DebouncerOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n\n    // End the pending state if the debouncer is disabled\n    if (!this._options.enabled) {\n      this._isPending = false\n    }\n  }\n\n  /**\n   * Returns the current debouncer options\n   */\n  getOptions(): Required<DebouncerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Returns the current enabled state of the debouncer\n   */\n  getEnabled(): boolean {\n    return parseFunctionOrValue(this._options.enabled, this)\n  }\n\n  /**\n   * Returns the current wait time in milliseconds\n   */\n  getWait(): number {\n    return parseFunctionOrValue(this._options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  maybeExecute(...args: Parameters<TFn>): void {\n    let _didLeadingExecute = false\n\n    // Handle leading execution\n    if (this._options.leading && this._canLeadingExecute) {\n      this._canLeadingExecute = false\n      _didLeadingExecute = true\n      this.executeFunction(...args)\n    }\n\n    // Start pending state to indicate that the debouncer is waiting for the trailing edge\n    if (this._options.trailing) {\n      this._isPending = true\n    }\n\n    // Clear any existing timeout\n    if (this._timeoutId) clearTimeout(this._timeoutId)\n\n    // Set new timeout that will reset canLeadingExecute and execute trailing only if enabled and did not execute leading\n    this._timeoutId = setTimeout(() => {\n      this._canLeadingExecute = true\n      if (this._options.trailing && !_didLeadingExecute) {\n        this.executeFunction(...args)\n      }\n    }, this.getWait())\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this.getEnabled()) return undefined\n    this.fn(...args) // EXECUTE!\n    this._isPending = false\n    this._executionCount++\n    this._options.onExecute(this)\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this._timeoutId) {\n      clearTimeout(this._timeoutId)\n      this._canLeadingExecute = true\n      this._isPending = false\n    }\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   * Returns `true` if debouncing\n   */\n  getIsPending(): boolean {\n    return this.getEnabled() && this._isPending\n  }\n}\n\n/**\n * Creates a debounced function that delays invoking the provided function until after a specified wait time.\n * Multiple calls during the wait period will cancel previous pending invocations and reset the timer.\n *\n * This the the simple function wrapper implementation pulled from the Debouncer class. If you need\n * more control over the debouncing behavior, use the Debouncer class directly.\n *\n * If leading option is true, the function will execute immediately on the first call, then wait the delay\n * before allowing another execution.\n *\n * @example\n * ```ts\n * const debounced = debounce(() => {\n *   saveChanges();\n * }, { wait: 1000 });\n *\n * // Called repeatedly but executes at most once per second\n * inputElement.addEventListener('input', debounced);\n * ```\n */\nexport function debounce<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const debouncer = new Debouncer(fn, initialOptions)\n  return debouncer.maybeExecute.bind(debouncer)\n}\n"],"names":[],"mappings":";AAoCA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AAyBO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAQ,qBAAqB;AAC7B,SAAQ,kBAAkB;AAC1B,SAAQ,aAAa;AAQnB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAkD;AAC3D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,aAAa;AAAA,IAAA;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA,EAMF,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAO,qBAAqB,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,UAAkB;AAChB,WAAO,qBAAqB,KAAK,SAAS,MAAM,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOtD,gBAAgB,MAA6B;AAC3C,QAAI,qBAAqB;AAGzB,QAAI,KAAK,SAAS,WAAW,KAAK,oBAAoB;AACpD,WAAK,qBAAqB;AACL,2BAAA;AAChB,WAAA,gBAAgB,GAAG,IAAI;AAAA,IAAA;AAI1B,QAAA,KAAK,SAAS,UAAU;AAC1B,WAAK,aAAa;AAAA,IAAA;AAIpB,QAAI,KAAK,WAAyB,cAAA,KAAK,UAAU;AAG5C,SAAA,aAAa,WAAW,MAAM;AACjC,WAAK,qBAAqB;AAC1B,UAAI,KAAK,SAAS,YAAY,CAAC,oBAAoB;AAC5C,aAAA,gBAAgB,GAAG,IAAI;AAAA,MAAA;AAAA,IAC9B,GACC,KAAK,SAAS;AAAA,EAAA;AAAA,EAGX,mBAAmB,MAA6B;AACtD,QAAI,CAAC,KAAK,WAAW,EAAU,QAAA;AAC1B,SAAA,GAAG,GAAG,IAAI;AACf,SAAK,aAAa;AACb,SAAA;AACA,SAAA,SAAS,UAAU,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,qBAAqB;AAC1B,WAAK,aAAa;AAAA,IAAA;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA,EAMF,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACf,WAAA,KAAK,gBAAgB,KAAK;AAAA,EAAA;AAErC;AAsBgB,SAAA,SACd,IACA,gBACoC;AACpC,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAC3C,SAAA,UAAU,aAAa,KAAK,SAAS;AAC9C;"}
+{"version":3,"file":"debouncer.js","sources":["../../src/debouncer.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyFunction } from './types'\n\n/**\n * Options for configuring a debounced function\n */\nexport interface DebouncerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean)\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * The first call will execute immediately and the rest will wait the delay.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (debouncer: Debouncer<TFn>) => void\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 before executing the function.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((debouncer: Debouncer<TFn>) => number)\n}\n\nconst defaultOptions: Required<DebouncerOptions<any>> = {\n  enabled: true,\n  leading: false,\n  onExecute: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a debounced function.\n *\n * Debouncing ensures that a function is only executed after a certain amount of time has passed\n * since its last invocation. This is useful for handling frequent events like window resizing,\n * scroll events, or input changes where you want to limit the rate of execution.\n *\n * The debounced function can be configured to execute either at the start of the delay period\n * (leading edge) or at the end (trailing edge, default). Each new call during the wait period\n * will reset the timer.\n *\n * @example\n * ```ts\n * const debouncer = new Debouncer((value: string) => {\n *   saveToDatabase(value);\n * }, { wait: 500 });\n *\n * // Will only save after 500ms of no new input\n * inputElement.addEventListener('input', () => {\n *   debouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class Debouncer<TFn extends AnyFunction> {\n  private _canLeadingExecute = true\n  private _executionCount = 0\n  private _isPending = false\n  private _options: Required<DebouncerOptions<TFn>>\n  private _timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    private fn: TFn,\n    initialOptions: DebouncerOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the debouncer options\n   */\n  setOptions(newOptions: Partial<DebouncerOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n\n    // End the pending state if the debouncer is disabled\n    if (!this._options.enabled) {\n      this._isPending = false\n    }\n  }\n\n  /**\n   * Returns the current debouncer options\n   */\n  getOptions(): Required<DebouncerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Returns the current enabled state of the debouncer\n   */\n  getEnabled(): boolean {\n    return parseFunctionOrValue(this._options.enabled, this)\n  }\n\n  /**\n   * Returns the current wait time in milliseconds\n   */\n  getWait(): number {\n    return parseFunctionOrValue(this._options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  maybeExecute(...args: Parameters<TFn>): void {\n    let _didLeadingExecute = false\n\n    // Handle leading execution\n    if (this._options.leading && this._canLeadingExecute) {\n      this._canLeadingExecute = false\n      _didLeadingExecute = true\n      this.execute(...args)\n    }\n\n    // Start pending state to indicate that the debouncer is waiting for the trailing edge\n    if (this._options.trailing) {\n      this._isPending = true\n    }\n\n    // Clear any existing timeout\n    if (this._timeoutId) clearTimeout(this._timeoutId)\n\n    // Set new timeout that will reset canLeadingExecute and execute trailing only if enabled and did not execute leading\n    this._timeoutId = setTimeout(() => {\n      this._canLeadingExecute = true\n      if (this._options.trailing && !_didLeadingExecute) {\n        this.execute(...args)\n      }\n    }, this.getWait())\n  }\n\n  private execute(...args: Parameters<TFn>): void {\n    if (!this.getEnabled()) return undefined\n    this.fn(...args) // EXECUTE!\n    this._isPending = false\n    this._executionCount++\n    this._options.onExecute(this)\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel(): void {\n    if (this._timeoutId) {\n      clearTimeout(this._timeoutId)\n      this._canLeadingExecute = true\n      this._isPending = false\n    }\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   * Returns `true` if debouncing\n   */\n  getIsPending(): boolean {\n    return this.getEnabled() && this._isPending\n  }\n}\n\n/**\n * Creates a debounced function that delays invoking the provided function until after a specified wait time.\n * Multiple calls during the wait period will cancel previous pending invocations and reset the timer.\n *\n * This the the simple function wrapper implementation pulled from the Debouncer class. If you need\n * more control over the debouncing behavior, use the Debouncer class directly.\n *\n * If leading option is true, the function will execute immediately on the first call, then wait the delay\n * before allowing another execution.\n *\n * @example\n * ```ts\n * const debounced = debounce(() => {\n *   saveChanges();\n * }, { wait: 1000 });\n *\n * // Called repeatedly but executes at most once per second\n * inputElement.addEventListener('input', debounced);\n * ```\n */\nexport function debounce<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const debouncer = new Debouncer(fn, initialOptions)\n  return debouncer.maybeExecute.bind(debouncer)\n}\n"],"names":[],"mappings":";AAoCA,MAAM,iBAAkD;AAAA,EACtD,SAAS;AAAA,EACT,SAAS;AAAA,EACT,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AAyBO,MAAM,UAAmC;AAAA,EAO9C,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAQ,qBAAqB;AAC7B,SAAQ,kBAAkB;AAC1B,SAAQ,aAAa;AAQnB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,WAAW,YAAkD;AAC3D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,aAAa;AAAA,IAAA;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA,EAMF,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAO,qBAAqB,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,UAAkB;AAChB,WAAO,qBAAqB,KAAK,SAAS,MAAM,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOtD,gBAAgB,MAA6B;AAC3C,QAAI,qBAAqB;AAGzB,QAAI,KAAK,SAAS,WAAW,KAAK,oBAAoB;AACpD,WAAK,qBAAqB;AACL,2BAAA;AAChB,WAAA,QAAQ,GAAG,IAAI;AAAA,IAAA;AAIlB,QAAA,KAAK,SAAS,UAAU;AAC1B,WAAK,aAAa;AAAA,IAAA;AAIpB,QAAI,KAAK,WAAyB,cAAA,KAAK,UAAU;AAG5C,SAAA,aAAa,WAAW,MAAM;AACjC,WAAK,qBAAqB;AAC1B,UAAI,KAAK,SAAS,YAAY,CAAC,oBAAoB;AAC5C,aAAA,QAAQ,GAAG,IAAI;AAAA,MAAA;AAAA,IACtB,GACC,KAAK,SAAS;AAAA,EAAA;AAAA,EAGX,WAAW,MAA6B;AAC9C,QAAI,CAAC,KAAK,WAAW,EAAU,QAAA;AAC1B,SAAA,GAAG,GAAG,IAAI;AACf,SAAK,aAAa;AACb,SAAA;AACA,SAAA,SAAS,UAAU,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,qBAAqB;AAC1B,WAAK,aAAa;AAAA,IAAA;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA,EAMF,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACf,WAAA,KAAK,gBAAgB,KAAK;AAAA,EAAA;AAErC;AAsBgB,SAAA,SACd,IACA,gBACoC;AACpC,QAAM,YAAY,IAAI,UAAU,IAAI,cAAc;AAC3C,SAAA,UAAU,aAAa,KAAK,SAAS;AAC9C;"}

package/dist/esm/index.d.ts

@@ -2,6 +2,7 @@ export * from './async-debouncer.js';
 export * from './async-queuer.js';
 export * from './async-rate-limiter.js';
 export * from './async-throttler.js';
+export * from './batcher.js';
 export * from './compare.js';
 export * from './debouncer.js';
 export * from './queuer.js';

package/dist/esm/index.js

@@ -2,6 +2,7 @@ import { AsyncDebouncer, asyncDebounce } from "./async-debouncer.js";
 import { AsyncQueuer, asyncQueue } from "./async-queuer.js";
 import { AsyncRateLimiter, asyncRateLimit } from "./async-rate-limiter.js";
 import { AsyncThrottler, asyncThrottle } from "./async-throttler.js";
+import { Batcher, batch } from "./batcher.js";
 import { isPlainArray, isPlainObject, replaceEqualDeep, shallowEqualObjects } from "./compare.js";
 import { Debouncer, debounce } from "./debouncer.js";
 import { Queuer, queue } from "./queuer.js";
@@ -13,6 +14,7 @@ export {
   AsyncQueuer,
   AsyncRateLimiter,
   AsyncThrottler,
+  Batcher,
   Debouncer,
   Queuer,
   RateLimiter,
@@ -21,6 +23,7 @@ export {
   asyncQueue,
   asyncRateLimit,
   asyncThrottle,
+  batch,
   bindInstanceMethods,
   debounce,
   isFunction,

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;"}

package/dist/esm/queuer.d.ts

@@ -1,5 +1,7 @@
 /**
- * Options for configuring a Queuer instance
+ * Options for configuring a Queuer instance.
+ *
+ * These options control queue behavior, item expiration, callbacks, and more.
  */
 export interface QueuerOptions<TValue> {
     /**
@@ -42,7 +44,7 @@ export interface QueuerOptions<TValue> {
     /**
      * Callback fired whenever an item is removed from the queuer
      */
-    onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void;
+    onExecute?: (item: TValue, queuer: Queuer<TValue>) => void;
     /**
      * Callback fired whenever the queuer's running state changes
      */
@@ -67,64 +69,75 @@ export interface QueuerOptions<TValue> {
     wait?: number | ((queuer: Queuer<TValue>) => number);
 }
 /**
- * Position type for addItem and getNextItem operations
+ * Position type for addItem and getNextItem operations.
+ *
+ * - 'front': Operate on the front of the queue (FIFO)
+ * - 'back': Operate on the back of the queue (LIFO)
  */
 export type QueuePosition = 'front' | 'back';
 /**
- * A flexible queue data structure that defaults to FIFO (First In First Out) behavior
- * with optional position overrides for stack-like or double-ended operations.
+ * A flexible queue that processes items with configurable wait times, expiration, and priority.
  *
- * The queuer can automatically process items as they are added, with configurable
- * wait times between processing each item. Processing can be started/stopped
- * and the queuer will maintain its state.
+ * Features:
+ * - Automatic or manual processing of items
+ * - FIFO (First In First Out), LIFO (Last In First Out), or double-ended queue behavior
+ * - Priority-based ordering when getPriority is provided
+ * - Item expiration and removal of stale items
+ * - Callbacks for queue state changes, execution, rejection, and expiration
  *
- * Supports priority-based ordering when a getPriority function is provided.
- * Items with higher priority values will be processed first.
+ * Running behavior:
+ * - `start()`: Begins automatically processing items in the queue (defaults to running)
+ * - `stop()`: Pauses processing but maintains queue state
+ * - `wait`: Configurable delay between processing items
+ * - `onItemsChange`/`onExecute`: Callbacks for monitoring queue state
  *
- * Default queue behavior:
- * - addItem(item): adds to back of queuer
- * - getNextItem(): removes and returns from front of queuer
+ * Manual processing is also supported when automatic processing is disabled:
+ * - `execute()`: Processes the next item using the provided function
+ * - `getNextItem()`: Removes and returns the next item without processing
  *
- * Stack (LIFO) behavior:
- * - addItem(item, 'back'): adds to back
- * - getNextItem('back'): removes and returns from back
+ * Queue behavior defaults to FIFO:
+ * - `addItem(item)`: Adds to the back of the queue
+ * - Items processed from the front of the queue
  *
- * Double-ended queuer behavior:
- * - addItem(item, position): adds to specified position ('front' or 'back')
- * - getNextItem(position): removes and returns from specified position
+ * Priority queue:
+ * - Provide a `getPriority` function; higher values are processed first
  *
- * Processing behavior:
- * - start(): begins processing items in the queuer
- * - stop(): pauses processing
- * - wait: configurable delay between processing items
- * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state
+ * Stack (LIFO):
+ * - `addItem(item, 'back')`: Adds to the back
+ * - `getNextItem('back')`: Removes from the back
  *
- * Supports item expiration to clear stale items from the queuer
- * - expirationDuration: maximum time in milliseconds that an item can stay in the queue
- * - getIsExpired: function to override default expiration behavior
- * - onExpire: callback for when an item expires
+ * Double-ended queue:
+ * - `addItem(item, position)`: Adds to specified position ('front'/'back')
+ * - `getNextItem(position)`: Removes from specified position
  *
- * @example
- * ```ts
- * // FIFO queuer
- * const queuer = new Queuer<number>();
- * queuer.addItem(1); // [1]
- * queuer.addItem(2); // [1, 2]
- * queuer.getNextItem(); // returns 1, queuer is [2]
+ * Item expiration:
+ * - `expirationDuration`: Maximum time items can stay in the queue
+ * - `getIsExpired`: Function to override default expiration
+ * - `onExpire`: Callback for expired items
  *
- * // Priority queuer with processing
- * const priorityQueue = new Queuer<number>({
- *   getPriority: (n) => n, // Higher numbers have priority
+ * Example usage:
+ * ```ts
+ * // Auto-processing queue with wait time
+ * const autoQueue = new Queuer<number>((n) => console.log(n), {
  *   started: true, // Begin processing immediately
  *   wait: 1000, // Wait 1s between items
- *   onGetNextItem: (item, queuer) => console.log(item)
+ *   onExecute: (item) => console.log(`Processed ${item}`)
  * });
- * priorityQueue.addItem(1); // [1]
- * priorityQueue.addItem(3); // [3, 1] - 3 processed first
- * priorityQueue.addItem(2); // [3, 2, 1]
+ * autoQueue.addItem(1); // Will process after 1s
+ * autoQueue.addItem(2); // Will process 1s after first item
+ *
+ * // Manual processing queue
+ * const manualQueue = new Queuer<number>((n) => console.log(n), {
+ *   started: false
+ * });
+ * manualQueue.addItem(1); // [1]
+ * manualQueue.addItem(2); // [1, 2]
+ * manualQueue.execute(); // logs 1, queue is [2]
+ * manualQueue.getNextItem(); // returns 2, queue is empty
  * ```
  */
 export declare class Queuer<TValue> {
+    private fn;
     private _options;
     private _items;
     private _itemTimestamps;
@@ -134,136 +147,154 @@ export declare class Queuer<TValue> {
     private _onItemsChanges;
     private _running;
     private _pendingTick;
-    constructor(initialOptions?: QueuerOptions<TValue>);
+    constructor(fn: (item: TValue) => void, initialOptions?: QueuerOptions<TValue>);
     /**
-     * Updates the queuer options
-     * Returns the new options state
+     * Updates the queuer options. New options are merged with existing options.
      */
     setOptions(newOptions: Partial<QueuerOptions<TValue>>): void;
     /**
-     * Returns the current queuer options
+     * Returns the current queuer options, including defaults and any overrides.
      */
     getOptions(): Required<QueuerOptions<TValue>>;
     /**
-     * Returns the current wait time in milliseconds
+     * Returns the current wait time (in milliseconds) between processing items.
+     * If a function is provided, it is called with the queuer instance.
      */
     getWait(): number;
     /**
-     * Processes items in the queuer
+     * Processes items in the queue up to the wait interval. Internal use only.
      */
     private tick;
     /**
-     * Checks for and removes expired items from the queuer
+     * Checks for expired items in the queue and removes them. Calls onExpire for each expired item.
+     * Internal use only.
      */
     private checkExpiredItems;
     /**
-     * Stops the queuer from processing items
+     * Stops processing items in the queue. Does not clear the queue.
      */
     stop(): void;
     /**
-     * Starts the queuer and processes items
+     * Starts processing items in the queue. If already running, does nothing.
      */
     start(): void;
     /**
-     * Removes all items from the queuer
+     * Removes all pending items from the queue. Does not affect items being processed.
      */
     clear(): void;
     /**
-     * Resets the queuer to its initial state
+     * Resets the queuer to its initial state. Optionally repopulates with initial items.
+     * Does not affect callbacks or options.
      */
     reset(withInitialItems?: boolean): void;
     /**
-     * Adds an item to the queuer and starts processing if not already running
-     * @returns true if item was added, false if queuer is full
+     * Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.
+     * Items can be inserted based on priority or at the front/back depending on configuration.
+     *
+     * Returns true if the item was added, false if the queue is full.
+     *
+     * Example usage:
+     * ```ts
+     * queuer.addItem('task');
+     * queuer.addItem('task2', 'front');
+     * ```
      */
     addItem(item: TValue, position?: QueuePosition, runOnUpdate?: boolean): boolean;
     /**
-     * Removes and returns an item from the queuer using shift (default) or pop
+     * Removes and returns the next item from the queue without executing the function.
+     * Use for manual queue management. Normally, use execute() to process items.
      *
-     * @example
+     * Example usage:
      * ```ts
-     * // Standard FIFO queuer
-     * queuer.getNextItem()
-     * // Stack-like behavior (LIFO)
-     * queuer.getNextItem('back')
+     * // FIFO
+     * queuer.getNextItem();
+     * // LIFO
+     * queuer.getNextItem('back');
      * ```
      */
     getNextItem(position?: QueuePosition): TValue | undefined;
     /**
-     * Returns an item without removing it
+     * Removes and returns the next item from the queue and processes it using the provided function.
+     *
+     * Example usage:
+     * ```ts
+     * queuer.execute();
+     * // LIFO
+     * queuer.execute('back');
+     * ```
+     */
+    execute(position?: QueuePosition): TValue | undefined;
+    /**
+     * Returns the next item in the queue without removing it.
      *
-     * @example
+     * Example usage:
      * ```ts
-     * // Look at next item to getNextItem
-     * queuer.getPeek()
-     * // Look at last item (like stack top)
-     * queuer.getPeek('back')
+     * queuer.peekNextItem(); // front
+     * queuer.peekNextItem('back'); // back
      * ```
      */
-    getPeek(position?: QueuePosition): TValue | undefined;
+    peekNextItem(position?: QueuePosition): TValue | undefined;
     /**
-     * Returns true if the queuer is empty
+     * Returns true if the queue is empty (no pending items).
      */
     getIsEmpty(): boolean;
     /**
-     * Returns true if the queuer is full
+     * Returns true if the queue is full (reached maxSize).
      */
     getIsFull(): boolean;
     /**
-     * Returns the current size of the queuer
+     * Returns the number of pending items in the queue.
      */
     getSize(): number;
     /**
-     * Returns a copy of all items in the queuer
+     * Returns a copy of all items in the queue.
      */
-    getAllItems(): Array<TValue>;
+    peekAllItems(): Array<TValue>;
     /**
-     * Returns the number of items that have been removed from the queuer
+     * Returns the number of items that have been processed and removed from the queue.
      */
     getExecutionCount(): number;
     /**
-     * Returns the number of items that have been rejected from the queuer
+     * Returns the number of items that have been rejected from being added to the queue.
      */
     getRejectionCount(): number;
     /**
-     * Returns the number of items that have expired from the queuer
+     * Returns the number of items that have expired and been removed from the queue.
      */
     getExpirationCount(): number;
     /**
-     * Returns true if the queuer is running
+     * Returns true if the queuer is currently running (processing items).
      */
     getIsRunning(): boolean;
     /**
-     * Returns true if the queuer is running but has no items to process
+     * Returns true if the queuer is running but has no items to process.
      */
     getIsIdle(): boolean;
 }
 /**
- * Creates a queue that processes items in a queuer immediately upon addition.
+ * Creates a queue that processes items immediately upon addition.
  * Items are processed sequentially in FIFO order by default.
  *
  * This is a simplified wrapper around the Queuer class that only exposes the
- * `addItem` method. This queue is always running and will process items as they are added.
- * For more control over queuer processing, use the Queuer class
- * directly which provides methods like `start`, `stop`, `reset`, and more.
+ * `addItem` method. The queue is always running and will process items as they are added.
+ * For more control over queue processing, use the Queuer class directly.
  *
- * @example
+ * Example usage:
  * ```ts
  * // Basic sequential processing
- * const processItems = queuer<number>({
+ * const processItems = queue<number>((n) => console.log(n), {
  *   wait: 1000,
- *   onItemsChange: (queuer) => console.log(queuer.getAllItems())
- * })
- * processItems(1) // Logs: 1
- * processItems(2) // Logs: 2 after 1 completes
+ *   onItemsChange: (queuer) => console.log(queuer.peekAllItems())
+ * });
+ * processItems(1); // Logs: 1
+ * processItems(2); // Logs: 2 after 1 completes
  *
- * // Priority queuer
- * const processPriority = queuer<number>({
- *   process: async (n) => console.log(n),
+ * // Priority queue
+ * const processPriority = queue<number>((n) => console.log(n), {
  *   getPriority: n => n // Higher numbers processed first
- * })
- * processPriority(1)
- * processPriority(3) // Processed before 1
+ * });
+ * processPriority(1);
+ * processPriority(3); // Processed before 1
  * ```
  */
-export declare function queue<TValue>(options: QueuerOptions<TValue>): (item: TValue, position?: QueuePosition, runOnUpdate?: boolean) => boolean;
+export declare function queue<TValue>(fn: (item: TValue) => void, options: QueuerOptions<TValue>): (item: TValue, position?: QueuePosition, runOnUpdate?: boolean) => boolean;