@tanstack/pacer 0.4.0 → 0.5.0

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

@@ -1 +1 @@
-{"version":3,"file":"async-queuer.js","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   * Maximum time in milliseconds that an item can stay in the queue\n   * If not provided, items will never expire\n   */\n  expirationDuration?: number\n  /**\n   * Function to determine if an item has expired\n   * If provided, this overrides the expirationDuration behavior\n   */\n  getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean\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 the queuer's running state changes\n   */\n  onIsRunningChange?: (queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is added or removed from the queuer\n   */\n  onItemsChange?: (queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is rejected from being added to the queuer\n   */\n  onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item expires in the queuer\n   */\n  onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Whether the queuer should start processing tasks immediately or not.\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  expirationDuration: Infinity,\n  getIsExpired: () => false,\n  getItemsFrom: 'front',\n  getPriority: (item) => (item as any)?.priority ?? 0,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onIsRunningChange: () => {},\n  onItemsChange: () => {},\n  onReject: () => {},\n  onExpire: () => {},\n  started: true,\n  wait: 0,\n}\n\n/**\n * A flexible asynchronous queue that processes tasks with configurable concurrency control.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * @example\n * ```ts\n * const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });\n *\n * asyncQueuer.addItem(async () => {\n *   return 'Hello';\n * });\n *\n * asyncQueuer.start();\n *\n * asyncQueuer.onSuccess((result) => {\n *   console.log(result); // 'Hello'\n * });\n * ```\n */\nexport class AsyncQueuer<TValue> {\n  private _options: Required<AsyncQueuerOptions<TValue>>\n  private _activeItems: Set<() => Promise<TValue>> = new Set()\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _expirationCount = 0\n  private _items: Array<() => Promise<TValue>> = []\n  private _itemTimestamps: Array<number> = []\n  private _onErrorCallbacks: Array<(error: Error) => void> = []\n  private _onSettledCallbacks: Array<(result: TValue | Error) => void> = []\n  private _onSuccessCallbacks: Array<(result: TValue) => void> = []\n  private _pendingTick = false\n  private _running: boolean\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(newOptions: Partial<AsyncQueuerOptions<TValue>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current queuer options\n   */\n  getOptions(): Required<AsyncQueuerOptions<TValue>> {\n    return this._options\n  }\n\n  /**\n   * Processes items in the queuer\n   */\n  private tick() {\n    if (!this._running) {\n      this._pendingTick = false\n      return\n    }\n\n    // Check for expired items\n    this.checkExpiredItems()\n\n    while (\n      this._activeItems.size < this._options.concurrency &&\n      !this.getIsEmpty()\n    ) {\n      const nextFn = this.getNextItem()\n      if (!nextFn) {\n        break\n      }\n      this._activeItems.add(nextFn)\n      this._options.onItemsChange(this)\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._activeItems.delete(nextFn)\n          this._options.onItemsChange(this)\n        }\n\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   * Checks for and removes expired items from the queuer\n   */\n  private checkExpiredItems() {\n    if (\n      this._options.expirationDuration === Infinity &&\n      this._options.getIsExpired === defaultOptions.getIsExpired\n    )\n      return\n\n    const now = Date.now()\n    const expiredIndices: Array<number> = []\n\n    // Find indices of expired items\n    for (let i = 0; i < this._items.length; i++) {\n      const timestamp = this._itemTimestamps[i]\n      if (timestamp === undefined) continue\n\n      const item = this._items[i]\n      if (item === undefined) continue\n\n      const isExpired =\n        this._options.getIsExpired !== defaultOptions.getIsExpired\n          ? this._options.getIsExpired(item, timestamp)\n          : now - timestamp > this._options.expirationDuration\n\n      if (isExpired) {\n        expiredIndices.push(i)\n      }\n    }\n\n    // Remove expired items from back to front to maintain indices\n    for (let i = expiredIndices.length - 1; i >= 0; i--) {\n      const index = expiredIndices[i]\n      if (index === undefined) continue\n\n      const expiredItem = this._items[index]\n      if (expiredItem === undefined) continue\n\n      this._items.splice(index, 1)\n      this._itemTimestamps.splice(index, 1)\n      this._expirationCount++\n      this._options.onExpire(expiredItem, this)\n    }\n\n    if (expiredIndices.length > 0) {\n      this._options.onItemsChange(this)\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.getIsEmpty()) {\n      this._pendingTick = true\n      this.tick()\n    }\n    this._options.onIsRunningChange(this)\n\n    return new Promise<void>((resolve) => {\n      const checkIdle = () => {\n        if (this.getIsIdle()) {\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.onIsRunningChange(this)\n  }\n\n  /**\n   * Removes all items from the queuer\n   */\n  clear(): void {\n    this._items = []\n    this._options.onItemsChange(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   * 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.getIsFull()) {\n      this._rejectionCount++\n      this._options.onReject(fn, this)\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          this._itemTimestamps.push(Date.now())\n        } else {\n          this._items.splice(insertIndex, 0, task)\n          this._itemTimestamps.splice(insertIndex, 0, Date.now())\n        }\n      } else {\n        // Default FIFO/LIFO behavior\n        if (position === 'front') {\n          this._items.unshift(task)\n          this._itemTimestamps.unshift(Date.now())\n        } else {\n          this._items.push(task)\n          this._itemTimestamps.push(Date.now())\n        }\n      }\n\n      if (runOnUpdate) {\n        this._options.onItemsChange(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      this._itemTimestamps.shift()\n    } else {\n      item = this._items.pop()\n      this._itemTimestamps.pop()\n    }\n\n    if (item !== undefined) {\n      this._executionCount++\n      this._options.onItemsChange(this)\n      this._options.onGetNextItem(item, this)\n    }\n    return item\n  }\n\n  /**\n   * Returns an item without removing it\n   */\n  getPeek(\n    position: QueuePosition = 'front',\n  ): (() => 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  getIsEmpty(): boolean {\n    return this._items.length === 0\n  }\n\n  /**\n   * Returns true if the queuer is full\n   */\n  getIsFull(): boolean {\n    return this._items.length >= this._options.maxSize\n  }\n\n  /**\n   * Returns the current size of the queuer\n   */\n  getSize(): number {\n    return this._items.length\n  }\n\n  /**\n   * Returns a copy of all items in the queuer\n   */\n  getAllItems(): Array<() => Promise<TValue>> {\n    return [...this.getActiveItems(), ...this.getPendingItems()]\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._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 number of items that have been rejected from the queuer\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns true if the queuer is running\n   */\n  getIsRunning(): boolean {\n    return this._running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  getIsIdle(): boolean {\n    return this._running && this.getIsEmpty() && this._activeItems.size === 0\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(\n        (d) => d !== cb,\n      )\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(\n        (d) => d !== cb,\n      )\n    }\n  }\n\n  /**\n   * Returns the number of items that have expired from the queuer\n   */\n  getExpirationCount(): number {\n    return this._expirationCount\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>(\n  options: Omit<AsyncQueuerOptions<TValue>, 'started'> = {},\n) {\n  const queuer = new AsyncQueuer<TValue>(options)\n  return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":"AA0EA,MAAM,iBAAoD;AAAA,EACxD,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,oBAAoB;AAAA,EACpB,cAAc,MAAM;AAAA,EACpB,cAAc;AAAA,EACd,aAAa,CAAC,UAAU,6BAAc,aAAY;AAAA,EAClD,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,mBAAmB,MAAM;AAAA,EAAC;AAAA,EAC1B,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AAgCO,MAAM,YAAoB;AAAA,EAc/B,YAAY,iBAA6C,gBAAgB;AAZjE,SAAA,mCAA+C,IAAI;AAC3D,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,mBAAmB;AAC3B,SAAQ,SAAuC,CAAC;AAChD,SAAQ,kBAAiC,CAAC;AAC1C,SAAQ,oBAAmD,CAAC;AAC5D,SAAQ,sBAA+D,CAAC;AACxE,SAAQ,sBAAuD,CAAC;AAChE,SAAQ,eAAe;AAIrB,SAAK,WAAW,EAAE,GAAG,gBAAgB,GAAG,eAAe;AAClD,SAAA,WAAW,KAAK,SAAS;AAE9B,aAAS,IAAI,GAAG,IAAI,KAAK,SAAS,aAAa,QAAQ,KAAK;AAC1D,YAAM,OAAO,KAAK,SAAS,aAAa,CAAC;AACzC,YAAM,SAAS,MAAM,KAAK,SAAS,aAAa,SAAS;AACzD,WAAK,QAAQ,MAAM,KAAK,SAAS,YAAY,MAAM;AAAA,IAAA;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAuD;AAChE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAmD;AACjD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMN,OAAO;AACT,QAAA,CAAC,KAAK,UAAU;AAClB,WAAK,eAAe;AACpB;AAAA,IAAA;AAIF,SAAK,kBAAkB;AAGrB,WAAA,KAAK,aAAa,OAAO,KAAK,SAAS,eACvC,CAAC,KAAK,cACN;AACM,YAAA,SAAS,KAAK,YAAY;AAChC,UAAI,CAAC,QAAQ;AACX;AAAA,MAAA;AAEG,WAAA,aAAa,IAAI,MAAM;AACvB,WAAA,SAAS,cAAc,IAAI;AAC/B,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,aAAa,OAAO,MAAM;AAC1B,eAAA,SAAS,cAAc,IAAI;AAAA,QAAA;AAGlC,YAAI,SAAS;AACX,eAAK,oBAAoB,QAAQ,CAAC,OAAO,GAAG,GAAG,CAAC;AAAA,QAAA,OAC3C;AACL,eAAK,kBAAkB,QAAQ,CAAC,OAAO,GAAG,KAAM,CAAC;AAAA,QAAA;AAE9C,aAAA,oBAAoB,QAAQ,CAAC,OAAO,GAAG,UAAU,MAAM,KAAM,CAAC;AAE/D,YAAA,KAAK,SAAS,OAAO,GAAG;AAC1B,qBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,SAAS,IAAI;AAChD;AAAA,QAAA;AAGF,aAAK,KAAK;AAAA,MAAA,GACT;AAAA,IAAA;AAGL,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAAoB;AAC1B,QACE,KAAK,SAAS,uBAAuB,YACrC,KAAK,SAAS,iBAAiB,eAAe;AAE9C;AAEI,UAAA,MAAM,KAAK,IAAI;AACrB,UAAM,iBAAgC,CAAC;AAGvC,aAAS,IAAI,GAAG,IAAI,KAAK,OAAO,QAAQ,KAAK;AACrC,YAAA,YAAY,KAAK,gBAAgB,CAAC;AACxC,UAAI,cAAc,OAAW;AAEvB,YAAA,OAAO,KAAK,OAAO,CAAC;AAC1B,UAAI,SAAS,OAAW;AAExB,YAAM,YACJ,KAAK,SAAS,iBAAiB,eAAe,eAC1C,KAAK,SAAS,aAAa,MAAM,SAAS,IAC1C,MAAM,YAAY,KAAK,SAAS;AAEtC,UAAI,WAAW;AACb,uBAAe,KAAK,CAAC;AAAA,MAAA;AAAA,IACvB;AAIF,aAAS,IAAI,eAAe,SAAS,GAAG,KAAK,GAAG,KAAK;AAC7C,YAAA,QAAQ,eAAe,CAAC;AAC9B,UAAI,UAAU,OAAW;AAEnB,YAAA,cAAc,KAAK,OAAO,KAAK;AACrC,UAAI,gBAAgB,OAAW;AAE1B,WAAA,OAAO,OAAO,OAAO,CAAC;AACtB,WAAA,gBAAgB,OAAO,OAAO,CAAC;AAC/B,WAAA;AACA,WAAA,SAAS,SAAS,aAAa,IAAI;AAAA,IAAA;AAGtC,QAAA,eAAe,SAAS,GAAG;AACxB,WAAA,SAAS,cAAc,IAAI;AAAA,IAAA;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAMF,QAAuB;AACrB,SAAK,WAAW;AAChB,QAAI,CAAC,KAAK,gBAAgB,CAAC,KAAK,cAAc;AAC5C,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,SAAS,kBAAkB,IAAI;AAE7B,WAAA,IAAI,QAAc,CAAC,YAAY;AACpC,YAAM,YAAY,MAAM;AAClB,YAAA,KAAK,aAAa;AACZ,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,WAAW;AAChB,SAAK,eAAe;AACf,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAc;AACZ,SAAK,SAAS,CAAC;AACV,SAAA,SAAS,cAAc,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMlC,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,kBAAkB;AACvB,QAAI,kBAAkB;AACpB,WAAK,SAAS,CAAC,GAAG,KAAK,SAAS,YAAY;AAAA,IAAA;AAEzC,SAAA,WAAW,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,QACE,IACA,WAA0B,KAAK,SAAS,YACxC,cAAuB,MACN;AACb,QAAA,KAAK,aAAa;AACf,WAAA;AACA,WAAA,SAAS,SAAS,IAAI,IAAI;AAC/B,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,SAAS,gBAAgB,eAAe,cACzC,KAAK,SAAS,YAAY,IAAI,IAC9B,KAAK;AAEX,UAAI,aAAa,QAAW;AAE1B,cAAM,cAAc,KAAK,OAAO,UAAU,CAAC,aAAa;AAChD,gBAAA,mBACJ,KAAK,SAAS,gBAAgB,eAAe,cACzC,KAAK,SAAS,YAAY,QAAQ,IACjC,SAAiB;AACxB,iBAAO,mBAAmB;AAAA,QAAA,CAC3B;AAED,YAAI,gBAAgB,IAAI;AACjB,eAAA,OAAO,KAAK,IAAI;AACrB,eAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,QAAA,OAC/B;AACL,eAAK,OAAO,OAAO,aAAa,GAAG,IAAI;AACvC,eAAK,gBAAgB,OAAO,aAAa,GAAG,KAAK,KAAK;AAAA,QAAA;AAAA,MACxD,OACK;AAEL,YAAI,aAAa,SAAS;AACnB,eAAA,OAAO,QAAQ,IAAI;AACxB,eAAK,gBAAgB,QAAQ,KAAK,IAAA,CAAK;AAAA,QAAA,OAClC;AACA,eAAA,OAAO,KAAK,IAAI;AACrB,eAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,QAAA;AAAA,MACtC;AAGF,UAAI,aAAa;AACV,aAAA,SAAS,cAAc,IAAI;AAAA,MAAA;AAGlC,UAAI,KAAK,YAAY,CAAC,KAAK,cAAc;AACvC,aAAK,eAAe;AACpB,aAAK,KAAK;AAAA,MAAA;AAAA,IACZ,CACD;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMH,YACE,WAA0B,KAAK,SAAS,cACH;AACjC,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,MAAM;AACzB,WAAK,gBAAgB,MAAM;AAAA,IAAA,OACtB;AACE,aAAA,KAAK,OAAO,IAAI;AACvB,WAAK,gBAAgB,IAAI;AAAA,IAAA;AAG3B,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,SAAS,cAAc,IAAI;AAC3B,WAAA,SAAS,cAAc,MAAM,IAAI;AAAA,IAAA;AAEjC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMT,QACE,WAA0B,SACW;AACrC,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,CAAC;AAAA,IAAA;AAEtB,WAAO,KAAK,OAAO,KAAK,OAAO,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,aAAsB;AACb,WAAA,KAAK,OAAO,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,YAAqB;AACnB,WAAO,KAAK,OAAO,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM7C,UAAkB;AAChB,WAAO,KAAK,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,cAA4C;AACnC,WAAA,CAAC,GAAG,KAAK,kBAAkB,GAAG,KAAK,iBAAiB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM7D,iBAA+C;AACtC,WAAA,MAAM,KAAK,KAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrC,kBAAgD;AACvC,WAAA,CAAC,GAAG,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,YAAqB;AACnB,WAAO,KAAK,YAAY,KAAK,WAAgB,KAAA,KAAK,aAAa,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM1E,UAAU,IAA8B;AACjC,SAAA,oBAAoB,KAAK,EAAE;AAChC,WAAO,MAAM;AACN,WAAA,sBAAsB,KAAK,oBAAoB;AAAA,QAClD,CAAC,MAAM,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,QAAQ,IAA4B;AAC7B,SAAA,kBAAkB,KAAK,EAAE;AAC9B,WAAO,MAAM;AACX,WAAK,oBAAoB,KAAK,kBAAkB,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IACxE;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,UAAU,IAAsC;AACzC,SAAA,oBAAoB,KAAK,EAAE;AAChC,WAAO,MAAM;AACN,WAAA,sBAAsB,KAAK,oBAAoB;AAAA,QAClD,CAAC,MAAM,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,qBAA6B;AAC3B,WAAO,KAAK;AAAA,EAAA;AAEhB;AAmBgB,SAAA,WACd,UAAuD,IACvD;AACM,QAAA,SAAS,IAAI,YAAoB,OAAO;AACvC,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;"}
+{"version":3,"file":"async-queuer.js","sources":["../../src/async-queuer.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyAsyncFunction } from './types'\nimport 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   * Can be a number or a function that returns a number.\n   * @default 1\n   */\n  concurrency?: number | ((queuer: AsyncQueuer<TValue>) => number)\n  /**\n   * Maximum time in milliseconds that an item can stay in the queue\n   * If not provided, items will never expire\n   */\n  expirationDuration?: number\n  /**\n   * Function to determine if an item has expired\n   * If provided, this overrides the expirationDuration behavior\n   */\n  getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean\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 the queuer's running state changes\n   */\n  onIsRunningChange?: (queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is added or removed from the queuer\n   */\n  onItemsChange?: (queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is rejected from being added to the queuer\n   */\n  onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Callback fired whenever an item expires in the queuer\n   */\n  onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void\n  /**\n   * Whether the queuer should start processing tasks immediately or not.\n   */\n  started?: boolean\n  /**\n   * Time in milliseconds to wait between processing items.\n   * Can be a number or a function that returns a number.\n   * @default 0\n   */\n  wait?: number | ((queuer: AsyncQueuer<TValue>) => number)\n}\n\nconst defaultOptions: Required<AsyncQueuerOptions<any>> = {\n  addItemsTo: 'back',\n  concurrency: 1,\n  expirationDuration: Infinity,\n  getIsExpired: () => false,\n  getItemsFrom: 'front',\n  getPriority: (item) => (item as any)?.priority ?? 0,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onIsRunningChange: () => {},\n  onItemsChange: () => {},\n  onReject: () => {},\n  onExpire: () => {},\n  started: true,\n  wait: 0,\n}\n\n/**\n * A flexible asynchronous queue that processes tasks with configurable concurrency control.\n *\n * Features:\n * - Priority queue support via getPriority option\n * - Configurable concurrency limit\n * - Task success/error/completion callbacks\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Pause/resume task processing\n * - Task cancellation\n * - Item expiration to clear stale items from the queue\n *\n * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,\n * the next pending task is processed if below the concurrency limit.\n *\n * @example\n * ```ts\n * const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });\n *\n * asyncQueuer.addItem(async () => {\n *   return 'Hello';\n * });\n *\n * asyncQueuer.start();\n *\n * asyncQueuer.onSuccess((result) => {\n *   console.log(result); // 'Hello'\n * });\n * ```\n */\nexport class AsyncQueuer<TValue> {\n  private _options: Required<AsyncQueuerOptions<TValue>>\n  private _activeItems: Set<() => Promise<TValue>> = new Set()\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _expirationCount = 0\n  private _items: Array<() => Promise<TValue>> = []\n  private _itemTimestamps: Array<number> = []\n  private _onErrorCallbacks: Array<(error: Error) => void> = []\n  private _onSettledCallbacks: Array<(result: TValue | Error) => void> = []\n  private _onSuccessCallbacks: Array<(result: TValue) => void> = []\n  private _pendingTick = false\n  private _running: boolean\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(newOptions: Partial<AsyncQueuerOptions<TValue>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current queuer options\n   */\n  getOptions(): Required<AsyncQueuerOptions<TValue>> {\n    return this._options\n  }\n\n  /**\n   * Returns the current wait time between processing items\n   */\n  getWait(): number {\n    return parseFunctionOrValue(this._options.wait, this)\n  }\n\n  /**\n   * Returns the current concurrency limit\n   */\n  getConcurrency(): number {\n    return parseFunctionOrValue(this._options.concurrency, this)\n  }\n\n  /**\n   * Processes items in the queuer\n   */\n  private tick() {\n    if (!this._running) {\n      this._pendingTick = false\n      return\n    }\n\n    // Check for expired items\n    this.checkExpiredItems()\n\n    while (\n      this._activeItems.size < this.getConcurrency() &&\n      !this.getIsEmpty()\n    ) {\n      const nextFn = this.getNextItem()\n      if (!nextFn) {\n        break\n      }\n      this._activeItems.add(nextFn)\n      this._options.onItemsChange(this)\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._activeItems.delete(nextFn)\n          this._options.onItemsChange(this)\n        }\n\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        const wait = this.getWait()\n        if (wait > 0) {\n          setTimeout(() => this.tick(), wait)\n          return\n        }\n\n        this.tick()\n      })()\n    }\n\n    this._pendingTick = false\n  }\n\n  /**\n   * Checks for and removes expired items from the queuer\n   */\n  private checkExpiredItems() {\n    if (\n      this._options.expirationDuration === Infinity &&\n      this._options.getIsExpired === defaultOptions.getIsExpired\n    )\n      return\n\n    const now = Date.now()\n    const expiredIndices: Array<number> = []\n\n    // Find indices of expired items\n    for (let i = 0; i < this._items.length; i++) {\n      const timestamp = this._itemTimestamps[i]\n      if (timestamp === undefined) continue\n\n      const item = this._items[i]\n      if (item === undefined) continue\n\n      const isExpired =\n        this._options.getIsExpired !== defaultOptions.getIsExpired\n          ? this._options.getIsExpired(item, timestamp)\n          : now - timestamp > this._options.expirationDuration\n\n      if (isExpired) {\n        expiredIndices.push(i)\n      }\n    }\n\n    // Remove expired items from back to front to maintain indices\n    for (let i = expiredIndices.length - 1; i >= 0; i--) {\n      const index = expiredIndices[i]\n      if (index === undefined) continue\n\n      const expiredItem = this._items[index]\n      if (expiredItem === undefined) continue\n\n      this._items.splice(index, 1)\n      this._itemTimestamps.splice(index, 1)\n      this._expirationCount++\n      this._options.onExpire(expiredItem, this)\n    }\n\n    if (expiredIndices.length > 0) {\n      this._options.onItemsChange(this)\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.getIsEmpty()) {\n      this._pendingTick = true\n      this.tick()\n    }\n    this._options.onIsRunningChange(this)\n\n    return new Promise<void>((resolve) => {\n      const checkIdle = () => {\n        if (this.getIsIdle()) {\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.onIsRunningChange(this)\n  }\n\n  /**\n   * Removes all items from the queuer\n   */\n  clear(): void {\n    this._items = []\n    this._options.onItemsChange(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   * Adds a task to the queuer\n   */\n  addItem(\n    fn: AnyAsyncFunction & { priority?: number },\n    position: QueuePosition = this._options.addItemsTo,\n    runOnItemsChange: boolean = true,\n  ): Promise<TValue> {\n    if (this.getIsFull()) {\n      this._rejectionCount++\n      this._options.onReject(fn, this)\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          this._itemTimestamps.push(Date.now())\n        } else {\n          this._items.splice(insertIndex, 0, task)\n          this._itemTimestamps.splice(insertIndex, 0, Date.now())\n        }\n      } else {\n        // Default FIFO/LIFO behavior\n        if (position === 'front') {\n          this._items.unshift(task)\n          this._itemTimestamps.unshift(Date.now())\n        } else {\n          this._items.push(task)\n          this._itemTimestamps.push(Date.now())\n        }\n      }\n\n      if (runOnItemsChange) {\n        this._options.onItemsChange(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      this._itemTimestamps.shift()\n    } else {\n      item = this._items.pop()\n      this._itemTimestamps.pop()\n    }\n\n    if (item !== undefined) {\n      this._executionCount++\n      this._options.onItemsChange(this)\n      this._options.onGetNextItem(item, this)\n    }\n    return item\n  }\n\n  /**\n   * Returns an item without removing it\n   */\n  getPeek(\n    position: QueuePosition = 'front',\n  ): (() => 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  getIsEmpty(): boolean {\n    return this._items.length === 0\n  }\n\n  /**\n   * Returns true if the queuer is full\n   */\n  getIsFull(): boolean {\n    return this._items.length >= this._options.maxSize\n  }\n\n  /**\n   * Returns the current size of the queuer\n   */\n  getSize(): number {\n    return this._items.length\n  }\n\n  /**\n   * Returns a copy of all items in the queuer\n   */\n  getAllItems(): Array<() => Promise<TValue>> {\n    return [...this.getActiveItems(), ...this.getPendingItems()]\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._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 number of items that have been rejected from the queuer\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns true if the queuer is running\n   */\n  getIsRunning(): boolean {\n    return this._running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  getIsIdle(): boolean {\n    return this._running && this.getIsEmpty() && this._activeItems.size === 0\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(\n        (d) => d !== cb,\n      )\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(\n        (d) => d !== cb,\n      )\n    }\n  }\n\n  /**\n   * Returns the number of items that have expired from the queuer\n   */\n  getExpirationCount(): number {\n    return this._expirationCount\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)\n  return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":";AAgFA,MAAM,iBAAoD;AAAA,EACxD,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,oBAAoB;AAAA,EACpB,cAAc,MAAM;AAAA,EACpB,cAAc;AAAA,EACd,aAAa,CAAC,UAAU,6BAAc,aAAY;AAAA,EAClD,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,mBAAmB,MAAM;AAAA,EAAC;AAAA,EAC1B,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AAgCO,MAAM,YAAoB;AAAA,EAc/B,YAAY,iBAA6C,gBAAgB;AAZjE,SAAA,mCAA+C,IAAI;AAC3D,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,mBAAmB;AAC3B,SAAQ,SAAuC,CAAC;AAChD,SAAQ,kBAAiC,CAAC;AAC1C,SAAQ,oBAAmD,CAAC;AAC5D,SAAQ,sBAA+D,CAAC;AACxE,SAAQ,sBAAuD,CAAC;AAChE,SAAQ,eAAe;AAIrB,SAAK,WAAW,EAAE,GAAG,gBAAgB,GAAG,eAAe;AAClD,SAAA,WAAW,KAAK,SAAS;AAE9B,aAAS,IAAI,GAAG,IAAI,KAAK,SAAS,aAAa,QAAQ,KAAK;AAC1D,YAAM,OAAO,KAAK,SAAS,aAAa,CAAC;AACzC,YAAM,SAAS,MAAM,KAAK,SAAS,aAAa,SAAS;AACzD,WAAK,QAAQ,MAAM,KAAK,SAAS,YAAY,MAAM;AAAA,IAAA;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAuD;AAChE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAmD;AACjD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,UAAkB;AAChB,WAAO,qBAAqB,KAAK,SAAS,MAAM,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtD,iBAAyB;AACvB,WAAO,qBAAqB,KAAK,SAAS,aAAa,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrD,OAAO;AACT,QAAA,CAAC,KAAK,UAAU;AAClB,WAAK,eAAe;AACpB;AAAA,IAAA;AAIF,SAAK,kBAAkB;AAGrB,WAAA,KAAK,aAAa,OAAO,KAAK,oBAC9B,CAAC,KAAK,cACN;AACM,YAAA,SAAS,KAAK,YAAY;AAChC,UAAI,CAAC,QAAQ;AACX;AAAA,MAAA;AAEG,WAAA,aAAa,IAAI,MAAM;AACvB,WAAA,SAAS,cAAc,IAAI;AAC/B,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,aAAa,OAAO,MAAM;AAC1B,eAAA,SAAS,cAAc,IAAI;AAAA,QAAA;AAGlC,YAAI,SAAS;AACX,eAAK,oBAAoB,QAAQ,CAAC,OAAO,GAAG,GAAG,CAAC;AAAA,QAAA,OAC3C;AACL,eAAK,kBAAkB,QAAQ,CAAC,OAAO,GAAG,KAAM,CAAC;AAAA,QAAA;AAE9C,aAAA,oBAAoB,QAAQ,CAAC,OAAO,GAAG,UAAU,MAAM,KAAM,CAAC;AAE7D,cAAA,OAAO,KAAK,QAAQ;AAC1B,YAAI,OAAO,GAAG;AACZ,qBAAW,MAAM,KAAK,KAAK,GAAG,IAAI;AAClC;AAAA,QAAA;AAGF,aAAK,KAAK;AAAA,MAAA,GACT;AAAA,IAAA;AAGL,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAAoB;AAC1B,QACE,KAAK,SAAS,uBAAuB,YACrC,KAAK,SAAS,iBAAiB,eAAe;AAE9C;AAEI,UAAA,MAAM,KAAK,IAAI;AACrB,UAAM,iBAAgC,CAAC;AAGvC,aAAS,IAAI,GAAG,IAAI,KAAK,OAAO,QAAQ,KAAK;AACrC,YAAA,YAAY,KAAK,gBAAgB,CAAC;AACxC,UAAI,cAAc,OAAW;AAEvB,YAAA,OAAO,KAAK,OAAO,CAAC;AAC1B,UAAI,SAAS,OAAW;AAExB,YAAM,YACJ,KAAK,SAAS,iBAAiB,eAAe,eAC1C,KAAK,SAAS,aAAa,MAAM,SAAS,IAC1C,MAAM,YAAY,KAAK,SAAS;AAEtC,UAAI,WAAW;AACb,uBAAe,KAAK,CAAC;AAAA,MAAA;AAAA,IACvB;AAIF,aAAS,IAAI,eAAe,SAAS,GAAG,KAAK,GAAG,KAAK;AAC7C,YAAA,QAAQ,eAAe,CAAC;AAC9B,UAAI,UAAU,OAAW;AAEnB,YAAA,cAAc,KAAK,OAAO,KAAK;AACrC,UAAI,gBAAgB,OAAW;AAE1B,WAAA,OAAO,OAAO,OAAO,CAAC;AACtB,WAAA,gBAAgB,OAAO,OAAO,CAAC;AAC/B,WAAA;AACA,WAAA,SAAS,SAAS,aAAa,IAAI;AAAA,IAAA;AAGtC,QAAA,eAAe,SAAS,GAAG;AACxB,WAAA,SAAS,cAAc,IAAI;AAAA,IAAA;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAMF,QAAuB;AACrB,SAAK,WAAW;AAChB,QAAI,CAAC,KAAK,gBAAgB,CAAC,KAAK,cAAc;AAC5C,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,SAAS,kBAAkB,IAAI;AAE7B,WAAA,IAAI,QAAc,CAAC,YAAY;AACpC,YAAM,YAAY,MAAM;AAClB,YAAA,KAAK,aAAa;AACZ,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,WAAW;AAChB,SAAK,eAAe;AACf,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAc;AACZ,SAAK,SAAS,CAAC;AACV,SAAA,SAAS,cAAc,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMlC,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,kBAAkB;AACvB,QAAI,kBAAkB;AACpB,WAAK,SAAS,CAAC,GAAG,KAAK,SAAS,YAAY;AAAA,IAAA;AAEzC,SAAA,WAAW,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,QACE,IACA,WAA0B,KAAK,SAAS,YACxC,mBAA4B,MACX;AACb,QAAA,KAAK,aAAa;AACf,WAAA;AACA,WAAA,SAAS,SAAS,IAAI,IAAI;AAC/B,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,SAAS,gBAAgB,eAAe,cACzC,KAAK,SAAS,YAAY,IAAI,IAC9B,KAAK;AAEX,UAAI,aAAa,QAAW;AAE1B,cAAM,cAAc,KAAK,OAAO,UAAU,CAAC,aAAa;AAChD,gBAAA,mBACJ,KAAK,SAAS,gBAAgB,eAAe,cACzC,KAAK,SAAS,YAAY,QAAQ,IACjC,SAAiB;AACxB,iBAAO,mBAAmB;AAAA,QAAA,CAC3B;AAED,YAAI,gBAAgB,IAAI;AACjB,eAAA,OAAO,KAAK,IAAI;AACrB,eAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,QAAA,OAC/B;AACL,eAAK,OAAO,OAAO,aAAa,GAAG,IAAI;AACvC,eAAK,gBAAgB,OAAO,aAAa,GAAG,KAAK,KAAK;AAAA,QAAA;AAAA,MACxD,OACK;AAEL,YAAI,aAAa,SAAS;AACnB,eAAA,OAAO,QAAQ,IAAI;AACxB,eAAK,gBAAgB,QAAQ,KAAK,IAAA,CAAK;AAAA,QAAA,OAClC;AACA,eAAA,OAAO,KAAK,IAAI;AACrB,eAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,QAAA;AAAA,MACtC;AAGF,UAAI,kBAAkB;AACf,aAAA,SAAS,cAAc,IAAI;AAAA,MAAA;AAGlC,UAAI,KAAK,YAAY,CAAC,KAAK,cAAc;AACvC,aAAK,eAAe;AACpB,aAAK,KAAK;AAAA,MAAA;AAAA,IACZ,CACD;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMH,YACE,WAA0B,KAAK,SAAS,cACH;AACjC,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,MAAM;AACzB,WAAK,gBAAgB,MAAM;AAAA,IAAA,OACtB;AACE,aAAA,KAAK,OAAO,IAAI;AACvB,WAAK,gBAAgB,IAAI;AAAA,IAAA;AAG3B,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,SAAS,cAAc,IAAI;AAC3B,WAAA,SAAS,cAAc,MAAM,IAAI;AAAA,IAAA;AAEjC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMT,QACE,WAA0B,SACW;AACrC,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,CAAC;AAAA,IAAA;AAEtB,WAAO,KAAK,OAAO,KAAK,OAAO,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,aAAsB;AACb,WAAA,KAAK,OAAO,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,YAAqB;AACnB,WAAO,KAAK,OAAO,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM7C,UAAkB;AAChB,WAAO,KAAK,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,cAA4C;AACnC,WAAA,CAAC,GAAG,KAAK,kBAAkB,GAAG,KAAK,iBAAiB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM7D,iBAA+C;AACtC,WAAA,MAAM,KAAK,KAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrC,kBAAgD;AACvC,WAAA,CAAC,GAAG,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,YAAqB;AACnB,WAAO,KAAK,YAAY,KAAK,WAAgB,KAAA,KAAK,aAAa,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM1E,UAAU,IAA8B;AACjC,SAAA,oBAAoB,KAAK,EAAE;AAChC,WAAO,MAAM;AACN,WAAA,sBAAsB,KAAK,oBAAoB;AAAA,QAClD,CAAC,MAAM,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,QAAQ,IAA4B;AAC7B,SAAA,kBAAkB,KAAK,EAAE;AAC9B,WAAO,MAAM;AACX,WAAK,oBAAoB,KAAK,kBAAkB,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IACxE;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,UAAU,IAAsC;AACzC,SAAA,oBAAoB,KAAK,EAAE;AAChC,WAAO,MAAM;AACN,WAAA,sBAAsB,KAAK,oBAAoB;AAAA,QAClD,CAAC,MAAM,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,qBAA6B;AAC3B,WAAO,KAAK;AAAA,EAAA;AAEhB;AAmBO,SAAS,WAAmB,SAAqC;AAChE,QAAA,SAAS,IAAI,YAAoB,OAAO;AACvC,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;"}

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

@@ -5,13 +5,15 @@ import { AnyAsyncFunction } from './types.js';
 export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Can be a boolean or a function that returns a boolean.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean);
     /**
-     * Maximum number of executions allowed within the time window
+     * Maximum number of executions allowed within the time window.
+     * Can be a number or a function that returns a number.
      */
-    limit: number;
+    limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number);
     /**
      * Optional error handler for when the rate-limited function throws
      */
@@ -29,9 +31,10 @@ export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
      */
     onSuccess?: (result: ReturnType<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
     /**
-     * Time window in milliseconds within which the limit applies
+     * Time window in milliseconds within which the limit applies.
+     * Can be a number or a function that returns a number.
      */
-    window: number;
+    window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number);
     /**
      * Type of window to use for rate limiting
      * - 'fixed': Uses a fixed window that resets after the window period
@@ -96,6 +99,18 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
      * Returns the current rate limiter options
      */
     getOptions(): Required<AsyncRateLimiterOptions<TFn>>;
+    /**
+     * Returns the current enabled state of the rate limiter
+     */
+    getEnabled(): boolean;
+    /**
+     * Returns the current limit of executions allowed within the time window
+     */
+    getLimit(): number;
+    /**
+     * Returns the current time window in milliseconds
+     */
+    getWindow(): number;
     /**
      * Attempts to execute the rate-limited function if within the configured limits.
      * Will reject execution if the number of calls in the current window exceeds the limit.
@@ -193,4 +208,4 @@ export declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function asyncRateLimit<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
+export declare function asyncRateLimit<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;

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

@@ -1,3 +1,4 @@
+import { parseFunctionOrValue } from "./utils.js";
 const defaultOptions = {
   enabled: true,
   onError: () => {
@@ -37,6 +38,24 @@ class AsyncRateLimiter {
   getOptions() {
     return this._options;
   }
+  /**
+   * Returns the current enabled state of the rate limiter
+   */
+  getEnabled() {
+    return !!parseFunctionOrValue(this._options.enabled, this);
+  }
+  /**
+   * Returns the current limit of executions allowed within the time window
+   */
+  getLimit() {
+    return parseFunctionOrValue(this._options.limit, this);
+  }
+  /**
+   * Returns the current time window in milliseconds
+   */
+  getWindow() {
+    return parseFunctionOrValue(this._options.window, this);
+  }
   /**
    * Attempts to execute the rate-limited function if within the configured limits.
    * Will reject execution if the number of calls in the current window exceeds the limit.
@@ -55,16 +74,18 @@ class AsyncRateLimiter {
    */
   async maybeExecute(...args) {
     this.cleanupOldExecutions();
+    const limit = this.getLimit();
+    const window = this.getWindow();
     if (this._options.windowType === "sliding") {
-      if (this._executionTimes.length < this._options.limit) {
+      if (this._executionTimes.length < limit) {
         await this.executeFunction(...args);
         return this._lastResult;
       }
     } else {
       const now = Date.now();
       const oldestExecution = Math.min(...this._executionTimes);
-      const isNewWindow = oldestExecution + this._options.window <= now;
-      if (isNewWindow || this._executionTimes.length < this._options.limit) {
+      const isNewWindow = oldestExecution + window <= now;
+      if (isNewWindow || this._executionTimes.length < limit) {
         await this.executeFunction(...args);
         return this._lastResult;
       }
@@ -74,7 +95,7 @@ class AsyncRateLimiter {
   }
   async executeFunction(...args) {
     var _a, _b, _c, _d, _e, _f;
-    if (!this._options.enabled) return;
+    if (!this.getEnabled()) return;
     this._isExecuting = true;
     const now = Date.now();
     this._executionTimes.push(now);
@@ -100,7 +121,7 @@ class AsyncRateLimiter {
   }
   cleanupOldExecutions() {
     const now = Date.now();
-    const windowStart = now - this._options.window;
+    const windowStart = now - this.getWindow();
     this._executionTimes = this._executionTimes.filter(
       (time) => time > windowStart
     );
@@ -110,7 +131,7 @@ class AsyncRateLimiter {
    */
   getRemainingInWindow() {
     this.cleanupOldExecutions();
-    return Math.max(0, this._options.limit - this._executionTimes.length);
+    return Math.max(0, this.getLimit() - this._executionTimes.length);
   }
   /**
    * Returns the number of milliseconds until the next execution will be possible
@@ -122,7 +143,7 @@ class AsyncRateLimiter {
       return 0;
     }
     const oldestExecution = Math.min(...this._executionTimes);
-    return oldestExecution + this._options.window - Date.now();
+    return oldestExecution + this.getWindow() - Date.now();
   }
   /**
    * Returns the number of times the function has been executed

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

@@ -1 +1 @@
-{"version":3,"file":"async-rate-limiter.js","sources":["../../src/async-rate-limiter.ts"],"sourcesContent":["import type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async rate-limited function\n */\nexport interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Maximum number of executions allowed within the time window\n   */\n  limit: number\n  /**\n   * Optional error handler for when the rate-limited function throws\n   */\n  onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\nconst defaultOptions: Required<\n  Omit<AsyncRateLimiterOptions<any>, 'limit' | 'window'>\n> = {\n  enabled: true,\n  onError: () => {},\n  onReject: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates an async rate-limited function.\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window\n * );\n *\n * // Will execute immediately until limit reached, then block\n * // Returns the API response directly\n * const data = await rateLimiter.maybeExecute('123');\n * ```\n */\nexport class AsyncRateLimiter<TFn extends AnyAsyncFunction> {\n  private _options: AsyncRateLimiterOptions<TFn>\n  private _errorCount = 0\n  private _executionTimes: Array<number> = []\n  private _lastResult: ReturnType<TFn> | undefined\n  private _rejectionCount = 0\n  private _settleCount = 0\n  private _successCount = 0\n  private _isExecuting = false\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<AsyncRateLimiterOptions<TFn>> {\n    return this._options as Required<AsyncRateLimiterOptions<TFn>>\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   * If execution is allowed, waits for any previous execution to complete before proceeding.\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will execute\n   * await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will be rejected\n   * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected\n   * ```\n   */\n  async maybeExecute(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    this.cleanupOldExecutions()\n\n    if (this._options.windowType === 'sliding') {\n      // For sliding window, we can execute if we have capacity in the current window\n      if (this._executionTimes.length < this._options.limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\n    } else {\n      // For fixed window, we need to check if we're in a new window\n      const now = Date.now()\n      const oldestExecution = Math.min(...this._executionTimes)\n      const isNewWindow = oldestExecution + this._options.window <= now\n\n      if (isNewWindow || this._executionTimes.length < this._options.limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\n    }\n\n    this.rejectFunction()\n    return undefined\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this._options.enabled) return\n    this._isExecuting = true\n    const now = Date.now()\n    this._executionTimes.push(now)\n\n    try {\n      this._lastResult = await this.fn(...args)\n      this._successCount++\n      this._options.onSuccess?.(this._lastResult!, this)\n    } catch (error) {\n      this._errorCount++\n      this._options.onError?.(error, this)\n    } finally {\n      this._isExecuting = false\n      this._settleCount++\n      this._options.onSettled?.(this)\n    }\n\n    return this._lastResult\n  }\n\n  private rejectFunction(): void {\n    this._rejectionCount++\n    if (this._options.onReject) {\n      this._options.onReject(this)\n    }\n  }\n\n  private cleanupOldExecutions(): void {\n    const now = Date.now()\n    const windowStart = now - this._options.window\n    this._executionTimes = this._executionTimes.filter(\n      (time) => time > windowStart,\n    )\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow(): number {\n    this.cleanupOldExecutions()\n    return Math.max(0, this._options.limit - this._executionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   * For fixed windows, this is the time until the current window resets\n   * For sliding windows, this is the time until the oldest execution expires\n   */\n  getMsUntilNextWindow(): number {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = Math.min(...this._executionTimes)\n    return oldestExecution + this._options.window - Date.now()\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has been settled\n   */\n  getSettleCount(): number {\n    return this._settleCount\n  }\n\n  /**\n   * Returns the number of times the function has errored\n   */\n  getErrorCount(): number {\n    return this._errorCount\n  }\n\n  /**\n   * Returns the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns whether the function is currently executing\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._successCount = 0\n    this._errorCount = 0\n    this._rejectionCount = 0\n    this._settleCount = 0\n  }\n}\n\n/**\n * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * Unlike the non-async rate limiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * // Returns the API response directly\n * const result = await rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function asyncRateLimit<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":"AA+CA,MAAM,iBAEF;AAAA,EACF,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,YAAY;AACd;AAsCO,MAAM,iBAA+C;AAAA,EAU1D,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,cAAc;AACtB,SAAQ,kBAAiC,CAAC;AAE1C,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,eAAe;AAMrB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAyD;AAClE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAqD;AACnD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBd,MAAM,gBACD,MACmC;AACtC,SAAK,qBAAqB;AAEtB,QAAA,KAAK,SAAS,eAAe,WAAW;AAE1C,UAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC/C,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,YAAM,cAAc,kBAAkB,KAAK,SAAS,UAAU;AAE9D,UAAI,eAAe,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAC9D,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBACT,MACmC;AA/H1C;AAgIQ,QAAA,CAAC,KAAK,SAAS,QAAS;AAC5B,SAAK,eAAe;AACd,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA,gBAAgB,KAAK,GAAG;AAEzB,QAAA;AACF,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,uBAAK,UAAS,cAAd,4BAA0B,KAAK,aAAc;AAAA,aACtC,OAAO;AACT,WAAA;AACA,uBAAA,UAAS,YAAT,4BAAmB,OAAO;AAAA,IAAI,UACnC;AACA,WAAK,eAAe;AACf,WAAA;AACA,uBAAA,UAAS,cAAT,4BAAqB;AAAA,IAAI;AAGhC,WAAO,KAAK;AAAA,EAAA;AAAA,EAGN,iBAAuB;AACxB,SAAA;AACD,QAAA,KAAK,SAAS,UAAU;AACrB,WAAA,SAAS,SAAS,IAAI;AAAA,IAAA;AAAA,EAC7B;AAAA,EAGM,uBAA6B;AAC7B,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,cAAc,MAAM,KAAK,SAAS;AACnC,SAAA,kBAAkB,KAAK,gBAAgB;AAAA,MAC1C,CAAC,SAAS,OAAO;AAAA,IACnB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,SAAS,QAAQ,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQtE,uBAA+B;AACzB,QAAA,KAAK,qBAAqB,IAAI,GAAG;AAC5B,aAAA;AAAA,IAAA;AAET,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,SAAS,SAAS,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,kBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAAyB;AACvB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,gBAAgB;AACrB,SAAK,cAAc;AACnB,SAAK,kBAAkB;AACvB,SAAK,eAAe;AAAA,EAAA;AAExB;AA4CgB,SAAA,eACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AACpD,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}
+{"version":3,"file":"async-rate-limiter.js","sources":["../../src/async-rate-limiter.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async rate-limited function\n */\nexport interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Whether the rate limiter 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 | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean)\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a function that returns a number.\n   */\n  limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Optional error handler for when the rate-limited function throws\n   */\n  onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a function that returns a number.\n   */\n  window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\nconst defaultOptions: Required<\n  Omit<AsyncRateLimiterOptions<any>, 'limit' | 'window'>\n> = {\n  enabled: true,\n  onError: () => {},\n  onReject: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates an async rate-limited function.\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window\n * );\n *\n * // Will execute immediately until limit reached, then block\n * // Returns the API response directly\n * const data = await rateLimiter.maybeExecute('123');\n * ```\n */\nexport class AsyncRateLimiter<TFn extends AnyAsyncFunction> {\n  private _options: AsyncRateLimiterOptions<TFn>\n  private _errorCount = 0\n  private _executionTimes: Array<number> = []\n  private _lastResult: ReturnType<TFn> | undefined\n  private _rejectionCount = 0\n  private _settleCount = 0\n  private _successCount = 0\n  private _isExecuting = false\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<AsyncRateLimiterOptions<TFn>> {\n    return this._options as Required<AsyncRateLimiterOptions<TFn>>\n  }\n\n  /**\n   * Returns the current enabled state of the rate limiter\n   */\n  getEnabled(): boolean {\n    return !!parseFunctionOrValue(this._options.enabled, this)\n  }\n\n  /**\n   * Returns the current limit of executions allowed within the time window\n   */\n  getLimit(): number {\n    return parseFunctionOrValue(this._options.limit, this)\n  }\n\n  /**\n   * Returns the current time window in milliseconds\n   */\n  getWindow(): number {\n    return parseFunctionOrValue(this._options.window, this)\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   * If execution is allowed, waits for any previous execution to complete before proceeding.\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will execute\n   * await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will be rejected\n   * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected\n   * ```\n   */\n  async maybeExecute(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    this.cleanupOldExecutions()\n\n    const limit = this.getLimit()\n    const window = this.getWindow()\n\n    if (this._options.windowType === 'sliding') {\n      // For sliding window, we can execute if we have capacity in the current window\n      if (this._executionTimes.length < limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\n    } else {\n      // For fixed window, we need to check if we're in a new window\n      const now = Date.now()\n      const oldestExecution = Math.min(...this._executionTimes)\n      const isNewWindow = oldestExecution + window <= now\n\n      if (isNewWindow || this._executionTimes.length < limit) {\n        await this.executeFunction(...args)\n        return this._lastResult\n      }\n    }\n\n    this.rejectFunction()\n    return undefined\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this.getEnabled()) return\n    this._isExecuting = true\n    const now = Date.now()\n    this._executionTimes.push(now)\n\n    try {\n      this._lastResult = await this.fn(...args)\n      this._successCount++\n      this._options.onSuccess?.(this._lastResult!, this)\n    } catch (error) {\n      this._errorCount++\n      this._options.onError?.(error, this)\n    } finally {\n      this._isExecuting = false\n      this._settleCount++\n      this._options.onSettled?.(this)\n    }\n\n    return this._lastResult\n  }\n\n  private rejectFunction(): void {\n    this._rejectionCount++\n    if (this._options.onReject) {\n      this._options.onReject(this)\n    }\n  }\n\n  private cleanupOldExecutions(): void {\n    const now = Date.now()\n    const windowStart = now - this.getWindow()\n    this._executionTimes = this._executionTimes.filter(\n      (time) => time > windowStart,\n    )\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow(): number {\n    this.cleanupOldExecutions()\n    return Math.max(0, this.getLimit() - this._executionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   * For fixed windows, this is the time until the current window resets\n   * For sliding windows, this is the time until the oldest execution expires\n   */\n  getMsUntilNextWindow(): number {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = Math.min(...this._executionTimes)\n    return oldestExecution + this.getWindow() - Date.now()\n  }\n\n  /**\n   * Returns the number of times the function has been executed\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has been settled\n   */\n  getSettleCount(): number {\n    return this._settleCount\n  }\n\n  /**\n   * Returns the number of times the function has errored\n   */\n  getErrorCount(): number {\n    return this._errorCount\n  }\n\n  /**\n   * Returns the number of times the function has been rejected\n   */\n  getRejectionCount(): number {\n    return this._rejectionCount\n  }\n\n  /**\n   * Returns whether the function is currently executing\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._successCount = 0\n    this._errorCount = 0\n    this._rejectionCount = 0\n    this._settleCount = 0\n  }\n}\n\n/**\n * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * Unlike the non-async rate limiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * // Returns the API response directly\n * const result = await rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function asyncRateLimit<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":";AAmDA,MAAM,iBAEF;AAAA,EACF,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,YAAY;AACd;AAsCO,MAAM,iBAA+C;AAAA,EAU1D,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AATV,SAAQ,cAAc;AACtB,SAAQ,kBAAiC,CAAC;AAE1C,SAAQ,kBAAkB;AAC1B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,eAAe;AAMrB,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAyD;AAClE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAqD;AACnD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAsB;AACpB,WAAO,CAAC,CAAC,qBAAqB,KAAK,SAAS,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,WAAmB;AACjB,WAAO,qBAAqB,KAAK,SAAS,OAAO,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvD,YAAoB;AAClB,WAAO,qBAAqB,KAAK,SAAS,QAAQ,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBxD,MAAM,gBACD,MACmC;AACtC,SAAK,qBAAqB;AAEpB,UAAA,QAAQ,KAAK,SAAS;AACtB,UAAA,SAAS,KAAK,UAAU;AAE1B,QAAA,KAAK,SAAS,eAAe,WAAW;AAEtC,UAAA,KAAK,gBAAgB,SAAS,OAAO;AACjC,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd,OACK;AAEC,YAAA,MAAM,KAAK,IAAI;AACrB,YAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AAClD,YAAA,cAAc,kBAAkB,UAAU;AAEhD,UAAI,eAAe,KAAK,gBAAgB,SAAS,OAAO;AAChD,cAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,eAAO,KAAK;AAAA,MAAA;AAAA,IACd;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGT,MAAc,mBACT,MACmC;;AAClC,QAAA,CAAC,KAAK,aAAc;AACxB,SAAK,eAAe;AACd,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA,gBAAgB,KAAK,GAAG;AAEzB,QAAA;AACF,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,uBAAK,UAAS,cAAd,4BAA0B,KAAK,aAAc;AAAA,aACtC,OAAO;AACT,WAAA;AACA,uBAAA,UAAS,YAAT,4BAAmB,OAAO;AAAA,IAAI,UACnC;AACA,WAAK,eAAe;AACf,WAAA;AACA,uBAAA,UAAS,cAAT,4BAAqB;AAAA,IAAI;AAGhC,WAAO,KAAK;AAAA,EAAA;AAAA,EAGN,iBAAuB;AACxB,SAAA;AACD,QAAA,KAAK,SAAS,UAAU;AACrB,WAAA,SAAS,SAAS,IAAI;AAAA,IAAA;AAAA,EAC7B;AAAA,EAGM,uBAA6B;AAC7B,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,cAAc,MAAM,KAAK,UAAU;AACpC,SAAA,kBAAkB,KAAK,gBAAgB;AAAA,MAC1C,CAAC,SAAS,OAAO;AAAA,IACnB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,aAAa,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlE,uBAA+B;AACzB,QAAA,KAAK,qBAAqB,IAAI,GAAG;AAC5B,aAAA;AAAA,IAAA;AAET,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,UAAU,IAAI,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvD,kBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAAyB;AACvB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,gBAAgB;AACrB,SAAK,cAAc;AACnB,SAAK,kBAAkB;AACvB,SAAK,eAAe;AAAA,EAAA;AAExB;AA4CgB,SAAA,eACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,iBAAiB,IAAI,cAAc;AACpD,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}

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

@@ -5,9 +5,10 @@ import { AnyAsyncFunction } from './types.js';
 export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
     /**
      * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Can be a boolean or a function that returns a boolean.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((throttler: AsyncThrottler<TFn>) => boolean);
     /**
      * Whether to execute the function immediately when called
      * Defaults to true
@@ -31,10 +32,11 @@ export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
      */
     trailing?: boolean;
     /**
-     * Time window in milliseconds during which the function can only be executed once
+     * Time window in milliseconds during which the function can only be executed once.
+     * Can be a number or a function that returns a number.
      * Defaults to 0ms
      */
-    wait: number;
+    wait: number | ((throttler: AsyncThrottler<TFn>) => number);
 }
 /**
  * A class that creates an async throttled function.
@@ -85,6 +87,14 @@ export declare class AsyncThrottler<TFn extends AnyAsyncFunction> {
      * Returns the current options
      */
     getOptions(): Required<AsyncThrottlerOptions<TFn>>;
+    /**
+     * Returns the current enabled state of the throttler
+     */
+    getEnabled(): boolean;
+    /**
+     * Returns the current wait time in milliseconds
+     */
+    getWait(): number;
     /**
      * Attempts to execute the throttled function
      * If a call is already in progress, it may be blocked or queued depending on the `wait` option
@@ -149,4 +159,4 @@ export declare class AsyncThrottler<TFn extends AnyAsyncFunction> {
  * const result = await throttled(inputElement.value);
  * ```
  */
-export declare function asyncThrottle<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
+export declare function asyncThrottle<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;

package/dist/esm/async-throttler.js

@@ -1,3 +1,4 @@
+import { parseFunctionOrValue } from "./utils.js";
 const defaultOptions = {
   enabled: true,
   leading: true,
@@ -42,6 +43,18 @@ class AsyncThrottler {
   getOptions() {
     return this._options;
   }
+  /**
+   * Returns the current enabled state of the throttler
+   */
+  getEnabled() {
+    return parseFunctionOrValue(this._options.enabled, this);
+  }
+  /**
+   * Returns the current wait time in milliseconds
+   */
+  getWait() {
+    return parseFunctionOrValue(this._options.wait, this);
+  }
   /**
    * Attempts to execute the throttled function
    * If a call is already in progress, it may be blocked or queued depending on the `wait` option
@@ -49,7 +62,8 @@ class AsyncThrottler {
   async maybeExecute(...args) {
     const now = Date.now();
     const timeSinceLastExecution = now - this._lastExecutionTime;
-    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {
+    const wait = this.getWait();
+    if (this._options.leading && timeSinceLastExecution >= wait) {
       await this.executeFunction(...args);
       return this._lastResult;
     } else {
@@ -60,7 +74,7 @@ class AsyncThrottler {
         }
         if (this._options.trailing) {
           const _timeSinceLastExecution = this._lastExecutionTime ? now - this._lastExecutionTime : 0;
-          const timeoutDuration = this._options.wait - _timeSinceLastExecution;
+          const timeoutDuration = wait - _timeSinceLastExecution;
           this._timeoutId = setTimeout(async () => {
             if (this._lastArgs !== void 0) {
               await this.executeFunction(...this._lastArgs);
@@ -72,7 +86,7 @@ class AsyncThrottler {
     }
   }
   async executeFunction(...args) {
-    if (!this._options.enabled || this._isExecuting) return void 0;
+    if (!this.getEnabled() || this._isExecuting) return void 0;
     this._abortController = new AbortController();
     try {
       this._isExecuting = true;
@@ -87,7 +101,7 @@ class AsyncThrottler {
       this._settleCount++;
       this._abortController = null;
       this._lastExecutionTime = Date.now();
-      this._nextExecutionTime = this._lastExecutionTime + this._options.wait;
+      this._nextExecutionTime = this._lastExecutionTime + this.getWait();
       this._options.onSettled(this);
     }
     return this._lastResult;
@@ -146,7 +160,7 @@ class AsyncThrottler {
    * Returns the current pending state
    */
   getIsPending() {
-    return this._options.enabled && !!this._timeoutId;
+    return this.getEnabled() && !!this._timeoutId;
   }
   /**
    * Returns the current executing state

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

@@ -1 +1 @@
-{"version":3,"file":"async-throttler.js","sources":["../../src/async-throttler.ts"],"sourcesContent":["import type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Whether to execute the function immediately when called\n   * Defaults to true\n   */\n  leading?: boolean\n  /**\n   * Optional error handler for when the throttled function throws\n   */\n  onError?: (error: unknown, asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSettled?: (asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\n  /**\n   * Whether to execute the function on the trailing edge of the wait period\n   * Defaults to true\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once\n   * Defaults to 0ms\n   */\n  wait: number\n}\n\nconst defaultOptions: Required<AsyncThrottlerOptions<any>> = {\n  enabled: true,\n  leading: true,\n  onError: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, { wait: 1000 });\n *\n * // Will only execute once per second no matter how often called\n * // Returns the API response directly\n * const result = await throttler.maybeExecute(inputElement.value);\n * ```\n */\nexport class AsyncThrottler<TFn extends AnyAsyncFunction> {\n  private _options: Required<AsyncThrottlerOptions<TFn>>\n  private _abortController: AbortController | null = null\n  private _errorCount = 0\n  private _isExecuting = false\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastExecutionTime = 0\n  private _lastResult: ReturnType<TFn> | undefined\n  private _nextExecutionTime = 0\n  private _settleCount = 0\n  private _successCount = 0\n  private _timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncThrottlerOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<AsyncThrottlerOptions<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.cancel()\n    }\n  }\n\n  /**\n   * Returns the current options\n   */\n  getOptions(): Required<AsyncThrottlerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Attempts to execute the throttled function\n   * If a call is already in progress, it may be blocked or queued depending on the `wait` option\n   */\n  async maybeExecute(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    const now = Date.now()\n    const timeSinceLastExecution = now - this._lastExecutionTime\n\n    // Handle leading execution\n    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {\n      await this.executeFunction(...args)\n      return this._lastResult\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this._lastArgs = args\n\n      return new Promise((resolve) => {\n        // Clear any existing timeout to ensure we use the latest arguments\n        if (this._timeoutId) {\n          clearTimeout(this._timeoutId)\n        }\n\n        // Set up trailing execution if enabled\n        if (this._options.trailing) {\n          const _timeSinceLastExecution = this._lastExecutionTime\n            ? now - this._lastExecutionTime\n            : 0\n          const timeoutDuration = this._options.wait - _timeSinceLastExecution\n          this._timeoutId = setTimeout(async () => {\n            if (this._lastArgs !== undefined) {\n              await this.executeFunction(...this._lastArgs)\n            }\n            resolve(this._lastResult)\n          }, timeoutDuration)\n        }\n      })\n    }\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this._options.enabled || this._isExecuting) return undefined\n    this._abortController = new AbortController()\n    try {\n      this._isExecuting = true\n      this._lastResult = await this.fn(...args) // EXECUTE!\n      this._successCount++\n      this._options.onSuccess(this._lastResult!, this)\n    } catch (error) {\n      this._errorCount++\n      this._options.onError(error, this)\n    } finally {\n      this._isExecuting = false\n      this._settleCount++\n      this._abortController = null\n      this._lastExecutionTime = Date.now()\n      this._nextExecutionTime = this._lastExecutionTime + this._options.wait\n      this._options.onSettled(this)\n    }\n    return this._lastResult\n  }\n\n  /**\n   * Cancels any pending execution or aborts any execution in progress\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  }\n\n  /**\n   * Returns the last execution time\n   */\n  getLastExecutionTime(): number {\n    return this._lastExecutionTime\n  }\n\n  /**\n   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this._nextExecutionTime\n  }\n\n  /**\n   * Returns the last result of the debounced function\n   */\n  getLastResult(): ReturnType<TFn> | undefined {\n    return this._lastResult\n  }\n\n  /**\n   * Returns the number of times the function has been executed successfully\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has settled (completed or errored)\n   */\n  getSettleCount(): number {\n    return this._settleCount\n  }\n\n  /**\n   * Returns the number of times the function has errored\n   */\n  getErrorCount(): number {\n    return this._errorCount\n  }\n\n  /**\n   * Returns the current pending state\n   */\n  getIsPending(): boolean {\n    return this._options.enabled && !!this._timeoutId\n  }\n\n  /**\n   * Returns the current executing state\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\n  }\n}\n\n/**\n * Creates an async throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * @example\n * ```ts\n * const throttled = asyncThrottle(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, { wait: 1000 });\n *\n * // This will execute at most once per second\n * // Returns the API response directly\n * const result = await throttled(inputElement.value);\n * ```\n */\nexport function asyncThrottle<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: Omit<AsyncThrottlerOptions<TFn>, 'enabled'>,\n) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute.bind(asyncThrottler)\n}\n"],"names":[],"mappings":"AA2CA,MAAM,iBAAuD;AAAA,EAC3D,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AA4BO,MAAM,eAA6C;AAAA,EAaxD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAZV,SAAQ,mBAA2C;AACnD,SAAQ,cAAc;AACtB,SAAQ,eAAe;AAEvB,SAAQ,qBAAqB;AAE7B,SAAQ,qBAAqB;AAC7B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,aAAoC;AAM1C,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAuD;AAChE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,OAAO;AAAA,IAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAMF,aAAmD;AACjD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,MAAM,gBACD,MACmC;AAChC,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,yBAAyB,MAAM,KAAK;AAG1C,QAAI,KAAK,SAAS,WAAW,0BAA0B,KAAK,SAAS,MAAM;AACnE,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,aAAO,KAAK;AAAA,IAAA,OACP;AAEL,WAAK,YAAY;AAEV,aAAA,IAAI,QAAQ,CAAC,YAAY;AAE9B,YAAI,KAAK,YAAY;AACnB,uBAAa,KAAK,UAAU;AAAA,QAAA;AAI1B,YAAA,KAAK,SAAS,UAAU;AAC1B,gBAAM,0BAA0B,KAAK,qBACjC,MAAM,KAAK,qBACX;AACE,gBAAA,kBAAkB,KAAK,SAAS,OAAO;AACxC,eAAA,aAAa,WAAW,YAAY;AACnC,gBAAA,KAAK,cAAc,QAAW;AAChC,oBAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,YAAA;AAE9C,oBAAQ,KAAK,WAAW;AAAA,aACvB,eAAe;AAAA,QAAA;AAAA,MACpB,CACD;AAAA,IAAA;AAAA,EACH;AAAA,EAGF,MAAc,mBACT,MACmC;AACtC,QAAI,CAAC,KAAK,SAAS,WAAW,KAAK,aAAqB,QAAA;AACnD,SAAA,mBAAmB,IAAI,gBAAgB;AACxC,QAAA;AACF,WAAK,eAAe;AACpB,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,WAAK,SAAS,UAAU,KAAK,aAAc,IAAI;AAAA,aACxC,OAAO;AACT,WAAA;AACA,WAAA,SAAS,QAAQ,OAAO,IAAI;AAAA,IAAA,UACjC;AACA,WAAK,eAAe;AACf,WAAA;AACL,WAAK,mBAAmB;AACnB,WAAA,qBAAqB,KAAK,IAAI;AACnC,WAAK,qBAAqB,KAAK,qBAAqB,KAAK,SAAS;AAC7D,WAAA,SAAS,UAAU,IAAI;AAAA,IAAA;AAE9B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,aAAa;AAAA,IAAA;AAEpB,QAAI,KAAK,kBAAkB;AACzB,WAAK,iBAAiB,MAAM;AAC5B,WAAK,mBAAmB;AAAA,IAAA;AAE1B,SAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMnB,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAA6C;AAC3C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,kBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAAyB;AACvB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK,SAAS,WAAW,CAAC,CAAC,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAEhB;AAuBgB,SAAA,cACd,IACA,gBACA;AACA,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;"}
+{"version":3,"file":"async-throttler.js","sources":["../../src/async-throttler.ts"],"sourcesContent":["import { parseFunctionOrValue } from './utils'\nimport type { AnyAsyncFunction } from './types'\n\n/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Whether the throttler 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 | ((throttler: AsyncThrottler<TFn>) => boolean)\n  /**\n   * Whether to execute the function immediately when called\n   * Defaults to true\n   */\n  leading?: boolean\n  /**\n   * Optional error handler for when the throttled function throws\n   */\n  onError?: (error: unknown, asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSettled?: (asyncThrottler: AsyncThrottler<TFn>) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\n  /**\n   * Whether to execute the function on the trailing edge of the wait period\n   * Defaults to true\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((throttler: AsyncThrottler<TFn>) => number)\n}\n\nconst defaultOptions: Required<AsyncThrottlerOptions<any>> = {\n  enabled: true,\n  leading: true,\n  onError: () => {},\n  onSettled: () => {},\n  onSuccess: () => {},\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, { wait: 1000 });\n *\n * // Will only execute once per second no matter how often called\n * // Returns the API response directly\n * const result = await throttler.maybeExecute(inputElement.value);\n * ```\n */\nexport class AsyncThrottler<TFn extends AnyAsyncFunction> {\n  private _options: Required<AsyncThrottlerOptions<TFn>>\n  private _abortController: AbortController | null = null\n  private _errorCount = 0\n  private _isExecuting = false\n  private _lastArgs: Parameters<TFn> | undefined\n  private _lastExecutionTime = 0\n  private _lastResult: ReturnType<TFn> | undefined\n  private _nextExecutionTime = 0\n  private _settleCount = 0\n  private _successCount = 0\n  private _timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    private fn: TFn,\n    initialOptions: AsyncThrottlerOptions<TFn>,\n  ) {\n    this._options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   * Returns the new options state\n   */\n  setOptions(newOptions: Partial<AsyncThrottlerOptions<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.cancel()\n    }\n  }\n\n  /**\n   * Returns the current options\n   */\n  getOptions(): Required<AsyncThrottlerOptions<TFn>> {\n    return this._options\n  }\n\n  /**\n   * Returns the current enabled state of the throttler\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 throttled function\n   * If a call is already in progress, it may be blocked or queued depending on the `wait` option\n   */\n  async maybeExecute(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    const now = Date.now()\n    const timeSinceLastExecution = now - this._lastExecutionTime\n    const wait = this.getWait()\n\n    // Handle leading execution\n    if (this._options.leading && timeSinceLastExecution >= wait) {\n      await this.executeFunction(...args)\n      return this._lastResult\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this._lastArgs = args\n\n      return new Promise((resolve) => {\n        // Clear any existing timeout to ensure we use the latest arguments\n        if (this._timeoutId) {\n          clearTimeout(this._timeoutId)\n        }\n\n        // Set up trailing execution if enabled\n        if (this._options.trailing) {\n          const _timeSinceLastExecution = this._lastExecutionTime\n            ? now - this._lastExecutionTime\n            : 0\n          const timeoutDuration = wait - _timeSinceLastExecution\n          this._timeoutId = setTimeout(async () => {\n            if (this._lastArgs !== undefined) {\n              await this.executeFunction(...this._lastArgs)\n            }\n            resolve(this._lastResult)\n          }, timeoutDuration)\n        }\n      })\n    }\n  }\n\n  private async executeFunction(\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> {\n    if (!this.getEnabled() || this._isExecuting) return undefined\n    this._abortController = new AbortController()\n    try {\n      this._isExecuting = true\n      this._lastResult = await this.fn(...args) // EXECUTE!\n      this._successCount++\n      this._options.onSuccess(this._lastResult!, this)\n    } catch (error) {\n      this._errorCount++\n      this._options.onError(error, this)\n    } finally {\n      this._isExecuting = false\n      this._settleCount++\n      this._abortController = null\n      this._lastExecutionTime = Date.now()\n      this._nextExecutionTime = this._lastExecutionTime + this.getWait()\n      this._options.onSettled(this)\n    }\n    return this._lastResult\n  }\n\n  /**\n   * Cancels any pending execution or aborts any execution in progress\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  }\n\n  /**\n   * Returns the last execution time\n   */\n  getLastExecutionTime(): number {\n    return this._lastExecutionTime\n  }\n\n  /**\n   * Returns the next execution time\n   */\n  getNextExecutionTime(): number {\n    return this._nextExecutionTime\n  }\n\n  /**\n   * Returns the last result of the debounced function\n   */\n  getLastResult(): ReturnType<TFn> | undefined {\n    return this._lastResult\n  }\n\n  /**\n   * Returns the number of times the function has been executed successfully\n   */\n  getSuccessCount(): number {\n    return this._successCount\n  }\n\n  /**\n   * Returns the number of times the function has settled (completed or errored)\n   */\n  getSettleCount(): number {\n    return this._settleCount\n  }\n\n  /**\n   * Returns the number of times the function has errored\n   */\n  getErrorCount(): number {\n    return this._errorCount\n  }\n\n  /**\n   * Returns the current pending state\n   */\n  getIsPending(): boolean {\n    return this.getEnabled() && !!this._timeoutId\n  }\n\n  /**\n   * Returns the current executing state\n   */\n  getIsExecuting(): boolean {\n    return this._isExecuting\n  }\n}\n\n/**\n * Creates an async throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * Unlike the non-async Throttler, this async version supports returning values from the throttled function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the throttled function.\n *\n * @example\n * ```ts\n * const throttled = asyncThrottle(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, { wait: 1000 });\n *\n * // This will execute at most once per second\n * // Returns the API response directly\n * const result = await throttled(inputElement.value);\n * ```\n */\nexport function asyncThrottle<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncThrottlerOptions<TFn>,\n) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute.bind(asyncThrottler)\n}\n"],"names":[],"mappings":";AA8CA,MAAM,iBAAuD;AAAA,EAC3D,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS,MAAM;AAAA,EAAC;AAAA,EAChB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU;AAAA,EACV,MAAM;AACR;AA4BO,MAAM,eAA6C;AAAA,EAaxD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAZV,SAAQ,mBAA2C;AACnD,SAAQ,cAAc;AACtB,SAAQ,eAAe;AAEvB,SAAQ,qBAAqB;AAE7B,SAAQ,qBAAqB;AAC7B,SAAQ,eAAe;AACvB,SAAQ,gBAAgB;AACxB,SAAQ,aAAoC;AAM1C,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAuD;AAChE,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAG9C,QAAA,CAAC,KAAK,SAAS,SAAS;AAC1B,WAAK,OAAO;AAAA,IAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAMF,aAAmD;AACjD,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,MAAM,gBACD,MACmC;AAChC,UAAA,MAAM,KAAK,IAAI;AACf,UAAA,yBAAyB,MAAM,KAAK;AACpC,UAAA,OAAO,KAAK,QAAQ;AAG1B,QAAI,KAAK,SAAS,WAAW,0BAA0B,MAAM;AACrD,YAAA,KAAK,gBAAgB,GAAG,IAAI;AAClC,aAAO,KAAK;AAAA,IAAA,OACP;AAEL,WAAK,YAAY;AAEV,aAAA,IAAI,QAAQ,CAAC,YAAY;AAE9B,YAAI,KAAK,YAAY;AACnB,uBAAa,KAAK,UAAU;AAAA,QAAA;AAI1B,YAAA,KAAK,SAAS,UAAU;AAC1B,gBAAM,0BAA0B,KAAK,qBACjC,MAAM,KAAK,qBACX;AACJ,gBAAM,kBAAkB,OAAO;AAC1B,eAAA,aAAa,WAAW,YAAY;AACnC,gBAAA,KAAK,cAAc,QAAW;AAChC,oBAAM,KAAK,gBAAgB,GAAG,KAAK,SAAS;AAAA,YAAA;AAE9C,oBAAQ,KAAK,WAAW;AAAA,aACvB,eAAe;AAAA,QAAA;AAAA,MACpB,CACD;AAAA,IAAA;AAAA,EACH;AAAA,EAGF,MAAc,mBACT,MACmC;AACtC,QAAI,CAAC,KAAK,WAAA,KAAgB,KAAK,aAAqB,QAAA;AAC/C,SAAA,mBAAmB,IAAI,gBAAgB;AACxC,QAAA;AACF,WAAK,eAAe;AACpB,WAAK,cAAc,MAAM,KAAK,GAAG,GAAG,IAAI;AACnC,WAAA;AACL,WAAK,SAAS,UAAU,KAAK,aAAc,IAAI;AAAA,aACxC,OAAO;AACT,WAAA;AACA,WAAA,SAAS,QAAQ,OAAO,IAAI;AAAA,IAAA,UACjC;AACA,WAAK,eAAe;AACf,WAAA;AACL,WAAK,mBAAmB;AACnB,WAAA,qBAAqB,KAAK,IAAI;AACnC,WAAK,qBAAqB,KAAK,qBAAqB,KAAK,QAAQ;AAC5D,WAAA,SAAS,UAAU,IAAI;AAAA,IAAA;AAE9B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAe;AACb,QAAI,KAAK,YAAY;AACnB,mBAAa,KAAK,UAAU;AAC5B,WAAK,aAAa;AAAA,IAAA;AAEpB,QAAI,KAAK,kBAAkB;AACzB,WAAK,iBAAiB,MAAM;AAC5B,WAAK,mBAAmB;AAAA,IAAA;AAE1B,SAAK,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMnB,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAA6C;AAC3C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,kBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,iBAAyB;AACvB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,gBAAwB;AACtB,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAwB;AACtB,WAAO,KAAK,WAAA,KAAgB,CAAC,CAAC,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrC,iBAA0B;AACxB,WAAO,KAAK;AAAA,EAAA;AAEhB;AAuBgB,SAAA,cACd,IACA,gBACA;AACA,QAAM,iBAAiB,IAAI,eAAe,IAAI,cAAc;AACrD,SAAA,eAAe,aAAa,KAAK,cAAc;AACxD;"}

package/dist/esm/debouncer.d.ts

@@ -5,9 +5,10 @@ import { AnyFunction } from './types.js';
 export interface DebouncerOptions<TFn extends AnyFunction> {
     /**
      * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Can be a boolean or a function that returns a boolean.
      * Defaults to true.
      */
-    enabled?: boolean;
+    enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean);
     /**
      * Whether to execute on the leading edge of the timeout.
      * The first call will execute immediately and the rest will wait the delay.
@@ -24,10 +25,11 @@ export interface DebouncerOptions<TFn extends AnyFunction> {
      */
     trailing?: boolean;
     /**
-     * Delay in milliseconds before executing the function
+     * Delay in milliseconds before executing the function.
+     * Can be a number or a function that returns a number.
      * Defaults to 0ms
      */
-    wait: number;
+    wait: number | ((debouncer: Debouncer<TFn>) => number);
 }
 /**
  * A class that creates a debounced function.
@@ -69,6 +71,14 @@ export declare class Debouncer<TFn extends AnyFunction> {
      * Returns the current debouncer options
      */
     getOptions(): Required<DebouncerOptions<TFn>>;
+    /**
+     * Returns the current enabled state of the debouncer
+     */
+    getEnabled(): boolean;
+    /**
+     * Returns the current wait time in milliseconds
+     */
+    getWait(): number;
     /**
      * Attempts to execute the debounced function
      * If a call is already in progress, it will be queued
@@ -108,4 +118,4 @@ export declare class Debouncer<TFn extends AnyFunction> {
  * inputElement.addEventListener('input', debounced);
  * ```
  */
-export declare function debounce<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<DebouncerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => void;
+export declare function debounce<TFn extends AnyFunction>(fn: TFn, initialOptions: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;

package/dist/esm/debouncer.js

@@ -1,3 +1,4 @@
+import { parseFunctionOrValue } from "./utils.js";
 const defaultOptions = {
   enabled: true,
   leading: false,
@@ -33,6 +34,18 @@ class Debouncer {
   getOptions() {
     return this._options;
   }
+  /**
+   * Returns the current enabled state of the debouncer
+   */
+  getEnabled() {
+    return parseFunctionOrValue(this._options.enabled, this);
+  }
+  /**
+   * Returns the current wait time in milliseconds
+   */
+  getWait() {
+    return parseFunctionOrValue(this._options.wait, this);
+  }
   /**
    * Attempts to execute the debounced function
    * If a call is already in progress, it will be queued
@@ -53,10 +66,10 @@ class Debouncer {
       if (this._options.trailing && !_didLeadingExecute) {
         this.executeFunction(...args);
       }
-    }, this._options.wait);
+    }, this.getWait());
   }
   executeFunction(...args) {
-    if (!this._options.enabled) return void 0;
+    if (!this.getEnabled()) return void 0;
     this.fn(...args);
     this._isPending = false;
     this._executionCount++;
@@ -82,7 +95,7 @@ class Debouncer {
    * Returns `true` if debouncing
    */
   getIsPending() {
-    return this._options.enabled && this._isPending;
+    return this.getEnabled() && this._isPending;
   }
 }
 function debounce(fn, initialOptions) {