@tanstack/pacer 0.2.0 → 0.4.0

package/dist/esm/queuer.d.ts

@@ -7,6 +7,16 @@ export interface QueuerOptions<TValue> {
      * @default 'back'
      */
     addItemsTo?: QueuePosition;
+    /**
+     * Maximum time in milliseconds that an item can stay in the queue
+     * If not provided, items will never expire
+     */
+    expirationDuration?: number;
+    /**
+     * Function to determine if an item has expired
+     * If provided, this overrides the expirationDuration behavior
+     */
+    getIsExpired?: (item: TValue, addedAt: number) => boolean;
     /**
      * Default position to get items from during processing
      * @default 'front'
@@ -25,6 +35,10 @@ export interface QueuerOptions<TValue> {
      * Maximum number of items allowed in the queuer
      */
     maxSize?: number;
+    /**
+     * Callback fired whenever an item expires in the queuer
+     */
+    onExpire?: (item: TValue, queuer: Queuer<TValue>) => void;
     /**
      * Callback fired whenever an item is removed from the queuer
      */
@@ -83,6 +97,11 @@ export type QueuePosition = 'front' | 'back';
  * - wait: configurable delay between processing items
  * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state
  *
+ * Supports item expiration to clear stale items from the queuer
+ * - expirationDuration: maximum time in milliseconds that an item can stay in the queue
+ * - getIsExpired: function to override default expiration behavior
+ * - onExpire: callback for when an item expires
+ *
  * @example
  * ```ts
  * // FIFO queuer
@@ -106,8 +125,10 @@ export type QueuePosition = 'front' | 'back';
 export declare class Queuer<TValue> {
     private _options;
     private _items;
+    private _itemTimestamps;
     private _executionCount;
     private _rejectionCount;
+    private _expirationCount;
     private _onItemsChanges;
     private _running;
     private _pendingTick;
@@ -116,7 +137,7 @@ export declare class Queuer<TValue> {
      * Updates the queuer options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<QueuerOptions<TValue>>): QueuerOptions<TValue>;
+    setOptions(newOptions: Partial<QueuerOptions<TValue>>): void;
     /**
      * Returns the current queuer options
      */
@@ -125,6 +146,10 @@ export declare class Queuer<TValue> {
      * Processes items in the queuer
      */
     private tick;
+    /**
+     * Checks for and removes expired items from the queuer
+     */
+    private checkExpiredItems;
     /**
      * Stops the queuer from processing items
      */
@@ -194,6 +219,10 @@ export declare class Queuer<TValue> {
      * Returns the number of items that have been rejected from the queuer
      */
     getRejectionCount(): number;
+    /**
+     * Returns the number of items that have expired from the queuer
+     */
+    getExpirationCount(): number;
     /**
      * Returns true if the queuer is running
      */

package/dist/esm/queuer.js

@@ -2,6 +2,8 @@ const defaultOptions = {
   addItemsTo: "back",
   getItemsFrom: "front",
   getPriority: (item) => (item == null ? void 0 : item.priority) ?? 0,
+  getIsExpired: () => false,
+  expirationDuration: Infinity,
   initialItems: [],
   maxSize: Infinity,
   onGetNextItem: () => {
@@ -12,14 +14,18 @@ const defaultOptions = {
   },
   onReject: () => {
   },
+  onExpire: () => {
+  },
   started: false,
   wait: 0
 };
 class Queuer {
   constructor(initialOptions = defaultOptions) {
     this._items = [];
+    this._itemTimestamps = [];
     this._executionCount = 0;
     this._rejectionCount = 0;
+    this._expirationCount = 0;
     this._onItemsChanges = [];
     this._pendingTick = false;
     this._options = { ...defaultOptions, ...initialOptions };
@@ -36,7 +42,6 @@ class Queuer {
    */
   setOptions(newOptions) {
     this._options = { ...this._options, ...newOptions };
-    return this._options;
   }
   /**
    * Returns the current queuer options
@@ -52,6 +57,7 @@ class Queuer {
       this._pendingTick = false;
       return;
     }
+    this.checkExpiredItems();
     while (!this.getIsEmpty()) {
       const nextItem = this.getNextItem(this._options.getItemsFrom);
       if (nextItem === void 0) {
@@ -66,6 +72,38 @@ class Queuer {
     }
     this._pendingTick = false;
   }
+  /**
+   * Checks for and removes expired items from the queuer
+   */
+  checkExpiredItems() {
+    if (this._options.expirationDuration === Infinity && this._options.getIsExpired === defaultOptions.getIsExpired)
+      return;
+    const now = Date.now();
+    const expiredIndices = [];
+    for (let i = 0; i < this._items.length; i++) {
+      const timestamp = this._itemTimestamps[i];
+      if (timestamp === void 0) continue;
+      const item = this._items[i];
+      if (item === void 0) continue;
+      const isExpired = this._options.getIsExpired !== defaultOptions.getIsExpired ? this._options.getIsExpired(item, timestamp) : now - timestamp > this._options.expirationDuration;
+      if (isExpired) {
+        expiredIndices.push(i);
+      }
+    }
+    for (let i = expiredIndices.length - 1; i >= 0; i--) {
+      const index = expiredIndices[i];
+      if (index === void 0) continue;
+      const expiredItem = this._items[index];
+      if (expiredItem === void 0) continue;
+      this._items.splice(index, 1);
+      this._itemTimestamps.splice(index, 1);
+      this._expirationCount++;
+      this._options.onExpire(expiredItem, this);
+    }
+    if (expiredIndices.length > 0) {
+      this._options.onItemsChange(this);
+    }
+  }
   /**
    * Stops the queuer from processing items
    */
@@ -120,14 +158,18 @@ class Queuer {
       );
       if (insertIndex === -1) {
         this._items.push(item);
+        this._itemTimestamps.push(Date.now());
       } else {
         this._items.splice(insertIndex, 0, item);
+        this._itemTimestamps.splice(insertIndex, 0, Date.now());
       }
     } else {
       if (position === "front") {
         this._items.unshift(item);
+        this._itemTimestamps.unshift(Date.now());
       } else {
         this._items.push(item);
+        this._itemTimestamps.push(Date.now());
       }
     }
     if (this._running && !this._pendingTick) {
@@ -154,8 +196,10 @@ class Queuer {
     let item;
     if (position === "front") {
       item = this._items.shift();
+      this._itemTimestamps.shift();
     } else {
       item = this._items.pop();
+      this._itemTimestamps.pop();
     }
     if (item !== void 0) {
       this._executionCount++;
@@ -217,6 +261,12 @@ class Queuer {
   getRejectionCount() {
     return this._rejectionCount;
   }
+  /**
+   * Returns the number of items that have expired from the queuer
+   */
+  getExpirationCount() {
+    return this._expirationCount;
+  }
   /**
    * Returns true if the queuer is running
    */

package/dist/esm/queuer.js.map

@@ -1 +1 @@
-{"version":3,"file":"queuer.js","sources":["../../src/queuer.ts"],"sourcesContent":["/**\n * Options for configuring a Queuer instance\n */\nexport interface QueuerOptions<TValue> {\n  /**\n   * Default position to add items to the queuer\n   * @default 'back'\n   */\n  addItemsTo?: QueuePosition\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   */\n  getPriority?: (item: TValue) => number\n  /**\n   * Initial items to populate the queuer with\n   */\n  initialItems?: Array<TValue>\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?: (item: TValue, queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever the queuer's running state changes\n   */\n  onIsRunningChange?: (queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is added or removed from the queuer\n   */\n  onItemsChange?: (queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is rejected from being added to the queuer\n   */\n  onReject?: (item: TValue, queuer: Queuer<TValue>) => void\n  /**\n   * Whether the queuer should start processing tasks immediately\n   */\n  started?: boolean\n  /**\n   * Time in milliseconds to wait between processing items\n   */\n  wait?: number\n}\n\nconst defaultOptions: Required<QueuerOptions<any>> = {\n  addItemsTo: 'back',\n  getItemsFrom: 'front',\n  getPriority: (item) => item?.priority ?? 0,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onIsRunningChange: () => {},\n  onItemsChange: () => {},\n  onReject: () => {},\n  started: false,\n  wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue data structure that defaults to FIFO (First In First Out) behavior\n * with optional position overrides for stack-like or double-ended operations.\n *\n * The queuer can automatically process items as they are added, with configurable\n * wait times between processing each item. Processing can be started/stopped\n * and the queuer will maintain its state.\n *\n * Supports priority-based ordering when a getPriority function is provided.\n * Items with higher priority values will be processed first.\n *\n * Default queue behavior:\n * - addItem(item): adds to back of queuer\n * - getNextItem(): removes and returns from front of queuer\n *\n * Stack (LIFO) behavior:\n * - addItem(item, 'back'): adds to back\n * - getNextItem('back'): removes and returns from back\n *\n * Double-ended queuer behavior:\n * - addItem(item, position): adds to specified position ('front' or 'back')\n * - getNextItem(position): removes and returns from specified position\n *\n * Processing behavior:\n * - start(): begins processing items in the queuer\n * - stop(): pauses processing\n * - wait: configurable delay between processing items\n * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state\n *\n * @example\n * ```ts\n * // FIFO queuer\n * const queuer = new Queuer<number>();\n * queuer.addItem(1); // [1]\n * queuer.addItem(2); // [1, 2]\n * queuer.getNextItem(); // returns 1, queuer is [2]\n *\n * // Priority queuer with processing\n * const priorityQueue = new Queuer<number>({\n *   getPriority: (n) => n, // Higher numbers have priority\n *   started: true, // Begin processing immediately\n *   wait: 1000, // Wait 1s between items\n *   onGetNextItem: (item, queuer) => console.log(item)\n * });\n * priorityQueue.addItem(1); // [1]\n * priorityQueue.addItem(3); // [3, 1] - 3 processed first\n * priorityQueue.addItem(2); // [3, 2, 1]\n * ```\n */\nexport class Queuer<TValue> {\n  private _options: Required<QueuerOptions<TValue>>\n  private _items: Array<TValue> = []\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _onItemsChanges: Array<(item: TValue) => void> = []\n  private _running: boolean\n  private _pendingTick = false\n\n  constructor(initialOptions: QueuerOptions<TValue> = defaultOptions) {\n    this._options = { ...defaultOptions, ...initialOptions }\n    this._running = this._options.started\n\n    for (let i = 0; i < this._options.initialItems.length; i++) {\n      const item = this._options.initialItems[i]!\n      const isLast = i === this._options.initialItems.length - 1\n      this.addItem(item, this._options.addItemsTo, isLast)\n    }\n  }\n\n  /**\n   * Updates the queuer options\n   * Returns the new options state\n   */\n  setOptions(\n    newOptions: Partial<QueuerOptions<TValue>>,\n  ): QueuerOptions<TValue> {\n    this._options = { ...this._options, ...newOptions }\n    return this._options\n  }\n\n  /**\n   * Returns the current queuer options\n   */\n  getOptions(): Required<QueuerOptions<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    while (!this.getIsEmpty()) {\n      const nextItem = this.getNextItem(this._options.getItemsFrom)\n      if (nextItem === undefined) {\n        break\n      }\n      this._onItemsChanges.forEach((cb) => cb(nextItem))\n\n      if (this._options.wait > 0) {\n        // Use setTimeout to wait before processing next item\n        setTimeout(() => this.tick(), this._options.wait)\n        return\n      }\n\n      this.tick()\n    }\n    this._pendingTick = false\n  }\n\n  /**\n   * Stops the queuer from processing items\n   */\n  stop() {\n    this._running = false\n    this._pendingTick = false\n    this._options.onIsRunningChange(this)\n  }\n\n  /**\n   * Starts the queuer and processes items\n   */\n  start() {\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\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 an item to the queuer and starts processing if not already running\n   * @returns true if item was added, false if queuer is full\n   */\n  addItem(\n    item: TValue,\n    position: QueuePosition = this._options.addItemsTo,\n    runOnUpdate: boolean = true,\n  ): boolean {\n    if (this.getIsFull()) {\n      this._rejectionCount++\n      this._options.onReject(item, this)\n      return false\n    }\n\n    if (this._options.getPriority !== defaultOptions.getPriority) {\n      // If custom priority function is provided, insert based on priority\n      const priority = this._options.getPriority(item)\n      const insertIndex = this._items.findIndex(\n        (existing) => this._options.getPriority(existing) > priority,\n      )\n\n      if (insertIndex === -1) {\n        this._items.push(item)\n      } else {\n        this._items.splice(insertIndex, 0, item)\n      }\n    } else {\n      // Default FIFO/LIFO behavior\n      if (position === 'front') {\n        this._items.unshift(item)\n      } else {\n        this._items.push(item)\n      }\n    }\n\n    if (this._running && !this._pendingTick) {\n      this._pendingTick = true\n      this.tick()\n    }\n    if (runOnUpdate) {\n      this._options.onItemsChange(this)\n    }\n    return true\n  }\n\n  /**\n   * Removes and returns an item from the queuer using shift (default) or pop\n   *\n   * @example\n   * ```ts\n   * // Standard FIFO queuer\n   * queuer.getNextItem()\n   * // Stack-like behavior (LIFO)\n   * queuer.getNextItem('back')\n   * ```\n   */\n  getNextItem(\n    position: QueuePosition = this._options.getItemsFrom,\n  ): TValue | undefined {\n    let item: TValue | undefined\n\n    if (position === 'front') {\n      item = this._items.shift()\n    } else {\n      item = this._items.pop()\n    }\n\n    if (item !== undefined) {\n      this._executionCount++\n      this._options.onItemsChange(this)\n      this._options.onGetNextItem(item, this)\n    }\n    return item\n  }\n\n  /**\n   * Returns an item without removing it\n   *\n   * @example\n   * ```ts\n   * // Look at next item to getNextItem\n   * queuer.getPeek()\n   * // Look at last item (like stack top)\n   * queuer.getPeek('back')\n   * ```\n   */\n  getPeek(\n    position: QueuePosition = this._options.getItemsFrom,\n  ): 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<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() {\n    return this._running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  getIsIdle() {\n    return this._running && this.getIsEmpty()\n  }\n}\n\n/**\n * Creates a queue that processes items in a queuer immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This is a simplified wrapper around the Queuer class that only exposes the\n * `addItem` method. This queue is always running and will process items as they are added.\n * For more control over queuer processing, use the Queuer class\n * directly which provides methods like `start`, `stop`, `reset`, and more.\n *\n * @example\n * ```ts\n * // Basic sequential processing\n * const processItems = queuer<number>({\n *   wait: 1000,\n *   onItemsChange: (queuer) => console.log(queuer.getAllItems())\n * })\n * processItems(1) // Logs: 1\n * processItems(2) // Logs: 2 after 1 completes\n *\n * // Priority queuer\n * const processPriority = queuer<number>({\n *   process: async (n) => console.log(n),\n *   getPriority: n => n // Higher numbers processed first\n * })\n * processPriority(1)\n * processPriority(3) // Processed before 1\n * ```\n */\nexport function queue<TValue>(options: QueuerOptions<TValue> = {}) {\n  const queuer = new Queuer<TValue>({ ...options, started: true })\n  return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":"AAqDA,MAAM,iBAA+C;AAAA,EACnD,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,aAAa,CAAC,UAAS,6BAAM,aAAY;AAAA,EACzC,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,SAAS;AAAA,EACT,MAAM;AACR;AAwDO,MAAM,OAAe;AAAA,EAS1B,YAAY,iBAAwC,gBAAgB;AAPpE,SAAQ,SAAwB,CAAC;AACjC,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiD,CAAC;AAE1D,SAAQ,eAAe;AAGrB,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,WACE,YACuB;AACvB,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAClD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMN,OAAO;AACT,QAAA,CAAC,KAAK,UAAU;AAClB,WAAK,eAAe;AACpB;AAAA,IAAA;AAEK,WAAA,CAAC,KAAK,cAAc;AACzB,YAAM,WAAW,KAAK,YAAY,KAAK,SAAS,YAAY;AAC5D,UAAI,aAAa,QAAW;AAC1B;AAAA,MAAA;AAEF,WAAK,gBAAgB,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;AAE7C,UAAA,KAAK,SAAS,OAAO,GAAG;AAE1B,mBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,SAAS,IAAI;AAChD;AAAA,MAAA;AAGF,WAAK,KAAK;AAAA,IAAA;AAEZ,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtB,OAAO;AACL,SAAK,WAAW;AAChB,SAAK,eAAe;AACf,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAQ;AACN,SAAK,WAAW;AAChB,QAAI,CAAC,KAAK,gBAAgB,CAAC,KAAK,cAAc;AAC5C,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEP,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;AAAA,EAOhC,QACE,MACA,WAA0B,KAAK,SAAS,YACxC,cAAuB,MACd;AACL,QAAA,KAAK,aAAa;AACf,WAAA;AACA,WAAA,SAAS,SAAS,MAAM,IAAI;AAC1B,aAAA;AAAA,IAAA;AAGT,QAAI,KAAK,SAAS,gBAAgB,eAAe,aAAa;AAE5D,YAAM,WAAW,KAAK,SAAS,YAAY,IAAI;AACzC,YAAA,cAAc,KAAK,OAAO;AAAA,QAC9B,CAAC,aAAa,KAAK,SAAS,YAAY,QAAQ,IAAI;AAAA,MACtD;AAEA,UAAI,gBAAgB,IAAI;AACjB,aAAA,OAAO,KAAK,IAAI;AAAA,MAAA,OAChB;AACL,aAAK,OAAO,OAAO,aAAa,GAAG,IAAI;AAAA,MAAA;AAAA,IACzC,OACK;AAEL,UAAI,aAAa,SAAS;AACnB,aAAA,OAAO,QAAQ,IAAI;AAAA,MAAA,OACnB;AACA,aAAA,OAAO,KAAK,IAAI;AAAA,MAAA;AAAA,IACvB;AAGF,QAAI,KAAK,YAAY,CAAC,KAAK,cAAc;AACvC,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEZ,QAAI,aAAa;AACV,WAAA,SAAS,cAAc,IAAI;AAAA,IAAA;AAE3B,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,YACE,WAA0B,KAAK,SAAS,cACpB;AAChB,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,OAAO,MAAM;AAAA,IAAA,OACpB;AACE,aAAA,KAAK,OAAO,IAAI;AAAA,IAAA;AAGzB,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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,QACE,WAA0B,KAAK,SAAS,cACpB;AACpB,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,cAA6B;AACpB,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,eAAe;AACb,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,YAAY;AACH,WAAA,KAAK,YAAY,KAAK,WAAW;AAAA,EAAA;AAE5C;AA8BgB,SAAA,MAAc,UAAiC,IAAI;AAC3D,QAAA,SAAS,IAAI,OAAe,EAAE,GAAG,SAAS,SAAS,MAAM;AACxD,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;"}
+{"version":3,"file":"queuer.js","sources":["../../src/queuer.ts"],"sourcesContent":["/**\n * Options for configuring a Queuer instance\n */\nexport interface QueuerOptions<TValue> {\n  /**\n   * Default position to add items to the queuer\n   * @default 'back'\n   */\n  addItemsTo?: QueuePosition\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: 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   */\n  getPriority?: (item: TValue) => number\n  /**\n   * Initial items to populate the queuer with\n   */\n  initialItems?: Array<TValue>\n  /**\n   * Maximum number of items allowed in the queuer\n   */\n  maxSize?: number\n  /**\n   * Callback fired whenever an item expires in the queuer\n   */\n  onExpire?: (item: TValue, queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is removed from the queuer\n   */\n  onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever the queuer's running state changes\n   */\n  onIsRunningChange?: (queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is added or removed from the queuer\n   */\n  onItemsChange?: (queuer: Queuer<TValue>) => void\n  /**\n   * Callback fired whenever an item is rejected from being added to the queuer\n   */\n  onReject?: (item: TValue, queuer: Queuer<TValue>) => void\n  /**\n   * Whether the queuer should start processing tasks immediately\n   */\n  started?: boolean\n  /**\n   * Time in milliseconds to wait between processing items\n   */\n  wait?: number\n}\n\nconst defaultOptions: Required<QueuerOptions<any>> = {\n  addItemsTo: 'back',\n  getItemsFrom: 'front',\n  getPriority: (item) => item?.priority ?? 0,\n  getIsExpired: () => false,\n  expirationDuration: Infinity,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onIsRunningChange: () => {},\n  onItemsChange: () => {},\n  onReject: () => {},\n  onExpire: () => {},\n  started: false,\n  wait: 0,\n}\n\n/**\n * Position type for addItem and getNextItem operations\n */\nexport type QueuePosition = 'front' | 'back'\n\n/**\n * A flexible queue data structure that defaults to FIFO (First In First Out) behavior\n * with optional position overrides for stack-like or double-ended operations.\n *\n * The queuer can automatically process items as they are added, with configurable\n * wait times between processing each item. Processing can be started/stopped\n * and the queuer will maintain its state.\n *\n * Supports priority-based ordering when a getPriority function is provided.\n * Items with higher priority values will be processed first.\n *\n * Default queue behavior:\n * - addItem(item): adds to back of queuer\n * - getNextItem(): removes and returns from front of queuer\n *\n * Stack (LIFO) behavior:\n * - addItem(item, 'back'): adds to back\n * - getNextItem('back'): removes and returns from back\n *\n * Double-ended queuer behavior:\n * - addItem(item, position): adds to specified position ('front' or 'back')\n * - getNextItem(position): removes and returns from specified position\n *\n * Processing behavior:\n * - start(): begins processing items in the queuer\n * - stop(): pauses processing\n * - wait: configurable delay between processing items\n * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state\n *\n * Supports item expiration to clear stale items from the queuer\n * - expirationDuration: maximum time in milliseconds that an item can stay in the queue\n * - getIsExpired: function to override default expiration behavior\n * - onExpire: callback for when an item expires\n *\n * @example\n * ```ts\n * // FIFO queuer\n * const queuer = new Queuer<number>();\n * queuer.addItem(1); // [1]\n * queuer.addItem(2); // [1, 2]\n * queuer.getNextItem(); // returns 1, queuer is [2]\n *\n * // Priority queuer with processing\n * const priorityQueue = new Queuer<number>({\n *   getPriority: (n) => n, // Higher numbers have priority\n *   started: true, // Begin processing immediately\n *   wait: 1000, // Wait 1s between items\n *   onGetNextItem: (item, queuer) => console.log(item)\n * });\n * priorityQueue.addItem(1); // [1]\n * priorityQueue.addItem(3); // [3, 1] - 3 processed first\n * priorityQueue.addItem(2); // [3, 2, 1]\n * ```\n */\nexport class Queuer<TValue> {\n  private _options: Required<QueuerOptions<TValue>>\n  private _items: Array<TValue> = []\n  private _itemTimestamps: Array<number> = []\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _expirationCount = 0\n  private _onItemsChanges: Array<(item: TValue) => void> = []\n  private _running: boolean\n  private _pendingTick = false\n\n  constructor(initialOptions: QueuerOptions<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<QueuerOptions<TValue>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current queuer options\n   */\n  getOptions(): Required<QueuerOptions<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 (!this.getIsEmpty()) {\n      const nextItem = this.getNextItem(this._options.getItemsFrom)\n      if (nextItem === undefined) {\n        break\n      }\n      this._onItemsChanges.forEach((cb) => cb(nextItem))\n\n      if (this._options.wait > 0) {\n        // Use setTimeout to wait before processing next item\n        setTimeout(() => this.tick(), this._options.wait)\n        return\n      }\n\n      this.tick()\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   * Stops the queuer from processing items\n   */\n  stop() {\n    this._running = false\n    this._pendingTick = false\n    this._options.onIsRunningChange(this)\n  }\n\n  /**\n   * Starts the queuer and processes items\n   */\n  start() {\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\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 an item to the queuer and starts processing if not already running\n   * @returns true if item was added, false if queuer is full\n   */\n  addItem(\n    item: TValue,\n    position: QueuePosition = this._options.addItemsTo,\n    runOnUpdate: boolean = true,\n  ): boolean {\n    if (this.getIsFull()) {\n      this._rejectionCount++\n      this._options.onReject(item, this)\n      return false\n    }\n\n    if (this._options.getPriority !== defaultOptions.getPriority) {\n      // If custom priority function is provided, insert based on priority\n      const priority = this._options.getPriority(item)\n      const insertIndex = this._items.findIndex(\n        (existing) => this._options.getPriority(existing) > priority,\n      )\n\n      if (insertIndex === -1) {\n        this._items.push(item)\n        this._itemTimestamps.push(Date.now())\n      } else {\n        this._items.splice(insertIndex, 0, item)\n        this._itemTimestamps.splice(insertIndex, 0, Date.now())\n      }\n    } else {\n      // Default FIFO/LIFO behavior\n      if (position === 'front') {\n        this._items.unshift(item)\n        this._itemTimestamps.unshift(Date.now())\n      } else {\n        this._items.push(item)\n        this._itemTimestamps.push(Date.now())\n      }\n    }\n\n    if (this._running && !this._pendingTick) {\n      this._pendingTick = true\n      this.tick()\n    }\n    if (runOnUpdate) {\n      this._options.onItemsChange(this)\n    }\n    return true\n  }\n\n  /**\n   * Removes and returns an item from the queuer using shift (default) or pop\n   *\n   * @example\n   * ```ts\n   * // Standard FIFO queuer\n   * queuer.getNextItem()\n   * // Stack-like behavior (LIFO)\n   * queuer.getNextItem('back')\n   * ```\n   */\n  getNextItem(\n    position: QueuePosition = this._options.getItemsFrom,\n  ): TValue | undefined {\n    let item: 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   * @example\n   * ```ts\n   * // Look at next item to getNextItem\n   * queuer.getPeek()\n   * // Look at last item (like stack top)\n   * queuer.getPeek('back')\n   * ```\n   */\n  getPeek(\n    position: QueuePosition = this._options.getItemsFrom,\n  ): 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<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 the number of items that have expired from the queuer\n   */\n  getExpirationCount(): number {\n    return this._expirationCount\n  }\n\n  /**\n   * Returns true if the queuer is running\n   */\n  getIsRunning() {\n    return this._running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  getIsIdle() {\n    return this._running && this.getIsEmpty()\n  }\n}\n\n/**\n * Creates a queue that processes items in a queuer immediately upon addition.\n * Items are processed sequentially in FIFO order by default.\n *\n * This is a simplified wrapper around the Queuer class that only exposes the\n * `addItem` method. This queue is always running and will process items as they are added.\n * For more control over queuer processing, use the Queuer class\n * directly which provides methods like `start`, `stop`, `reset`, and more.\n *\n * @example\n * ```ts\n * // Basic sequential processing\n * const processItems = queuer<number>({\n *   wait: 1000,\n *   onItemsChange: (queuer) => console.log(queuer.getAllItems())\n * })\n * processItems(1) // Logs: 1\n * processItems(2) // Logs: 2 after 1 completes\n *\n * // Priority queuer\n * const processPriority = queuer<number>({\n *   process: async (n) => console.log(n),\n *   getPriority: n => n // Higher numbers processed first\n * })\n * processPriority(1)\n * processPriority(3) // Processed before 1\n * ```\n */\nexport function queue<TValue>(options: QueuerOptions<TValue> = {}) {\n  const queuer = new Queuer<TValue>({ ...options, started: true })\n  return queuer.addItem.bind(queuer)\n}\n"],"names":[],"mappings":"AAmEA,MAAM,iBAA+C;AAAA,EACnD,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,aAAa,CAAC,UAAS,6BAAM,aAAY;AAAA,EACzC,cAAc,MAAM;AAAA,EACpB,oBAAoB;AAAA,EACpB,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;AA6DO,MAAM,OAAe;AAAA,EAW1B,YAAY,iBAAwC,gBAAgB;AATpE,SAAQ,SAAwB,CAAC;AACjC,SAAQ,kBAAiC,CAAC;AAC1C,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,mBAAmB;AAC3B,SAAQ,kBAAiD,CAAC;AAE1D,SAAQ,eAAe;AAGrB,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,YAAkD;AAC3D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAA8C;AAC5C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMN,OAAO;AACT,QAAA,CAAC,KAAK,UAAU;AAClB,WAAK,eAAe;AACpB;AAAA,IAAA;AAIF,SAAK,kBAAkB;AAEhB,WAAA,CAAC,KAAK,cAAc;AACzB,YAAM,WAAW,KAAK,YAAY,KAAK,SAAS,YAAY;AAC5D,UAAI,aAAa,QAAW;AAC1B;AAAA,MAAA;AAEF,WAAK,gBAAgB,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;AAE7C,UAAA,KAAK,SAAS,OAAO,GAAG;AAE1B,mBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,SAAS,IAAI;AAChD;AAAA,MAAA;AAGF,WAAK,KAAK;AAAA,IAAA;AAEZ,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,OAAO;AACL,SAAK,WAAW;AAChB,SAAK,eAAe;AACf,SAAA,SAAS,kBAAkB,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,QAAQ;AACN,SAAK,WAAW;AAChB,QAAI,CAAC,KAAK,gBAAgB,CAAC,KAAK,cAAc;AAC5C,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEP,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;AAAA,EAOhC,QACE,MACA,WAA0B,KAAK,SAAS,YACxC,cAAuB,MACd;AACL,QAAA,KAAK,aAAa;AACf,WAAA;AACA,WAAA,SAAS,SAAS,MAAM,IAAI;AAC1B,aAAA;AAAA,IAAA;AAGT,QAAI,KAAK,SAAS,gBAAgB,eAAe,aAAa;AAE5D,YAAM,WAAW,KAAK,SAAS,YAAY,IAAI;AACzC,YAAA,cAAc,KAAK,OAAO;AAAA,QAC9B,CAAC,aAAa,KAAK,SAAS,YAAY,QAAQ,IAAI;AAAA,MACtD;AAEA,UAAI,gBAAgB,IAAI;AACjB,aAAA,OAAO,KAAK,IAAI;AACrB,aAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,MAAA,OAC/B;AACL,aAAK,OAAO,OAAO,aAAa,GAAG,IAAI;AACvC,aAAK,gBAAgB,OAAO,aAAa,GAAG,KAAK,KAAK;AAAA,MAAA;AAAA,IACxD,OACK;AAEL,UAAI,aAAa,SAAS;AACnB,aAAA,OAAO,QAAQ,IAAI;AACxB,aAAK,gBAAgB,QAAQ,KAAK,IAAA,CAAK;AAAA,MAAA,OAClC;AACA,aAAA,OAAO,KAAK,IAAI;AACrB,aAAK,gBAAgB,KAAK,KAAK,IAAA,CAAK;AAAA,MAAA;AAAA,IACtC;AAGF,QAAI,KAAK,YAAY,CAAC,KAAK,cAAc;AACvC,WAAK,eAAe;AACpB,WAAK,KAAK;AAAA,IAAA;AAEZ,QAAI,aAAa;AACV,WAAA,SAAS,cAAc,IAAI;AAAA,IAAA;AAE3B,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,YACE,WAA0B,KAAK,SAAS,cACpB;AAChB,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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,QACE,WAA0B,KAAK,SAAS,cACpB;AACpB,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,cAA6B;AACpB,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,qBAA6B;AAC3B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,eAAe;AACb,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,YAAY;AACH,WAAA,KAAK,YAAY,KAAK,WAAW;AAAA,EAAA;AAE5C;AA8BgB,SAAA,MAAc,UAAiC,IAAI;AAC3D,QAAA,SAAS,IAAI,OAAe,EAAE,GAAG,SAAS,SAAS,MAAM;AACxD,SAAA,OAAO,QAAQ,KAAK,MAAM;AACnC;"}

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

@@ -2,7 +2,7 @@ import { AnyFunction } from './types.js';
 /**
  * Options for configuring a rate-limited function
  */
-export interface RateLimiterOptions<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
+export interface RateLimiterOptions<TFn extends AnyFunction> {
     /**
      * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -15,15 +15,22 @@ export interface RateLimiterOptions<TFn extends AnyFunction, TArgs extends Param
     /**
      * Callback function that is called after the function is executed
      */
-    onExecute?: (rateLimiter: RateLimiter<TFn, TArgs>) => void;
+    onExecute?: (rateLimiter: RateLimiter<TFn>) => void;
     /**
      * Optional callback function that is called when an execution is rejected due to rate limiting
      */
-    onReject?: (rateLimiter: RateLimiter<TFn, TArgs>) => void;
+    onReject?: (rateLimiter: RateLimiter<TFn>) => void;
     /**
      * Time window in milliseconds within which the limit applies
      */
     window: number;
+    /**
+     * Type of window to use for rate limiting
+     * - 'fixed': Uses a fixed window that resets after the window period
+     * - 'sliding': Uses a sliding window that allows executions as old ones expire
+     * Defaults to 'fixed'
+     */
+    windowType?: 'fixed' | 'sliding';
 }
 /**
  * A class that creates a rate-limited function.
@@ -32,6 +39,12 @@ export interface RateLimiterOptions<TFn extends AnyFunction, TArgs extends Param
  * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
  * all executions happen immediately, followed by a complete block.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+ *   consistent rate of execution over time.
+ *
  * For smoother execution patterns, consider using:
  * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
  * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
@@ -43,29 +56,29 @@ export interface RateLimiterOptions<TFn extends AnyFunction, TArgs extends Param
  * ```ts
  * const rateLimiter = new RateLimiter(
  *   (id: string) => api.getData(id),
- *   { limit: 5, window: 1000 } // 5 calls per second
+ *   { limit: 5, window: 1000, windowType: 'sliding' } // 5 calls per second with sliding window
  * );
  *
  * // Will execute immediately until limit reached, then block
  * rateLimiter.maybeExecute('123');
  * ```
  */
-export declare class RateLimiter<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
+export declare class RateLimiter<TFn extends AnyFunction> {
     private fn;
     private _executionCount;
     private _rejectionCount;
     private _executionTimes;
     private _options;
-    constructor(fn: TFn, initialOptions: RateLimiterOptions<TFn, TArgs>);
+    constructor(fn: TFn, initialOptions: RateLimiterOptions<TFn>);
     /**
      * Updates the rate limiter options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<RateLimiterOptions<TFn, TArgs>>): RateLimiterOptions<TFn, TArgs>;
+    setOptions(newOptions: Partial<RateLimiterOptions<TFn>>): void;
     /**
      * Returns the current rate limiter options
      */
-    getOptions(): Required<RateLimiterOptions<TFn, TArgs>>;
+    getOptions(): Required<RateLimiterOptions<TFn>>;
     /**
      * 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.
@@ -81,7 +94,7 @@ export declare class RateLimiter<TFn extends AnyFunction, TArgs extends Paramete
      * rateLimiter.maybeExecute('arg1', 'arg2'); // false
      * ```
      */
-    maybeExecute(...args: TArgs): boolean;
+    maybeExecute(...args: Parameters<TFn>): boolean;
     private executeFunction;
     private rejectFunction;
     private cleanupOldExecutions;
@@ -114,15 +127,22 @@ export declare class RateLimiter<TFn extends AnyFunction, TArgs extends Paramete
  * - A throttler ensures even spacing between executions, which can be better for consistent performance
  * - A debouncer collapses multiple calls into one, which is better for handling bursts of events
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All executions within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+ *   consistent rate of execution over time.
+ *
  * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically
  * need to enforce a hard limit on the number of executions within a time period.
  *
  * @example
  * ```ts
- * // Rate limit to 5 calls per minute
+ * // Rate limit to 5 calls per minute with a sliding window
  * const rateLimited = rateLimit(makeApiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding',
  *   onReject: (rateLimiter) => {
  *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }
@@ -136,4 +156,4 @@ export declare class RateLimiter<TFn extends AnyFunction, TArgs extends Paramete
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<RateLimiterOptions<TFn, Parameters<TFn>>, 'enabled'>): (...args: Parameters<TFn>) => boolean;
+export declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<RateLimiterOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => boolean;

package/dist/esm/rate-limiter.js

@@ -5,7 +5,8 @@ const defaultOptions = {
   },
   onReject: () => {
   },
-  window: 0
+  window: 0,
+  windowType: "fixed"
 };
 class RateLimiter {
   constructor(fn, initialOptions) {
@@ -23,11 +24,7 @@ class RateLimiter {
    * Returns the new options state
    */
   setOptions(newOptions) {
-    this._options = {
-      ...this._options,
-      ...newOptions
-    };
-    return this._options;
+    this._options = { ...this._options, ...newOptions };
   }
   /**
    * Returns the current rate limiter options
@@ -52,9 +49,19 @@ class RateLimiter {
    */
   maybeExecute(...args) {
     this.cleanupOldExecutions();
-    if (this._executionTimes.length < this._options.limit) {
-      this.executeFunction(...args);
-      return true;
+    if (this._options.windowType === "sliding") {
+      if (this._executionTimes.length < this._options.limit) {
+        this.executeFunction(...args);
+        return true;
+      }
+    } 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) {
+        this.executeFunction(...args);
+        return true;
+      }
     }
     this.rejectFunction();
     return false;
@@ -104,6 +111,9 @@ class RateLimiter {
    * Returns the number of milliseconds until the next execution will be possible
    */
   getMsUntilNextWindow() {
+    if (this.getRemainingInWindow() > 0) {
+      return 0;
+    }
     const oldestExecution = Math.min(...this._executionTimes);
     return oldestExecution + this._options.window - Date.now();
   }

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

@@ -1 +1 @@
-{"version":3,"file":"rate-limiter.js","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import type { AnyFunction } from './types'\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n> {\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   * Callback function that is called after the function is executed\n   */\n  onExecute?: (rateLimiter: RateLimiter<TFn, TArgs>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn, TArgs>) => void\n  /**\n   * Time window in milliseconds within which the limit applies\n   */\n  window: number\n}\n\nconst defaultOptions: Required<RateLimiterOptions<any, any>> = {\n  enabled: true,\n  limit: 1,\n  onExecute: () => {},\n  onReject: () => {},\n  window: 0,\n}\n\n/**\n * A class that creates a 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 * 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 RateLimiter(\n *   (id: string) => api.getData(id),\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<\n  TFn extends AnyFunction,\n  TArgs extends Parameters<TFn>,\n> {\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _executionTimes: Array<number> = []\n  private _options: RateLimiterOptions<TFn, TArgs>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<TFn, TArgs>,\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(\n    newOptions: Partial<RateLimiterOptions<TFn, TArgs>>,\n  ): RateLimiterOptions<TFn, TArgs> {\n    this._options = {\n      ...this._options,\n      ...newOptions,\n    }\n    return this._options\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<RateLimiterOptions<TFn, TArgs>> {\n    return this._options as Required<RateLimiterOptions<TFn, TArgs>>\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   *\n   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute(...args: TArgs): boolean {\n    this.cleanupOldExecutions()\n\n    if (this._executionTimes.length < this._options.limit) {\n      this.executeFunction(...args)\n      return true\n    }\n\n    this.rejectFunction()\n\n    return false\n  }\n\n  private executeFunction(...args: TArgs): void {\n    if (!this._options.enabled) return\n    const now = Date.now()\n    this._executionCount++\n    this._executionTimes.push(now)\n    this.fn(...args) // execute the function\n    this._options.onExecute?.(this)\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 times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this._executionCount\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 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   */\n  getMsUntilNextWindow(): number {\n    const oldestExecution = Math.min(...this._executionTimes)\n    return oldestExecution + this._options.window - Date.now()\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._executionCount = 0\n    this._rejectionCount = 0\n  }\n}\n\n/**\n * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.\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\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\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 * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: Omit<RateLimiterOptions<TFn, Parameters<TFn>>, 'enabled'>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":"AAgCA,MAAM,iBAAyD;AAAA,EAC7D,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,QAAQ;AACV;AA2BO,MAAM,YAGX;AAAA,EAMA,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiC,CAAC;AAOxC,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WACE,YACgC;AAChC,SAAK,WAAW;AAAA,MACd,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,aAAuD;AACrD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBd,gBAAgB,MAAsB;AACpC,SAAK,qBAAqB;AAE1B,QAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAChD,WAAA,gBAAgB,GAAG,IAAI;AACrB,aAAA;AAAA,IAAA;AAGT,SAAK,eAAe;AAEb,WAAA;AAAA,EAAA;AAAA,EAGD,mBAAmB,MAAmB;AArGhD;AAsGQ,QAAA,CAAC,KAAK,SAAS,QAAS;AACtB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,gBAAgB,KAAK,GAAG;AACxB,SAAA,GAAG,GAAG,IAAI;AACV,qBAAA,UAAS,cAAT,4BAAqB;AAAA,EAAI;AAAA,EAGxB,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,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,SAAS,QAAQ,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtE,uBAA+B;AAC7B,UAAM,kBAAkB,KAAK,IAAI,GAAG,KAAK,eAAe;AACxD,WAAO,kBAAkB,KAAK,SAAS,SAAS,KAAK,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,kBAAkB;AACvB,SAAK,kBAAkB;AAAA,EAAA;AAE3B;AAgCgB,SAAA,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AAC/C,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}
+{"version":3,"file":"rate-limiter.js","sources":["../../src/rate-limiter.ts"],"sourcesContent":["import type { AnyFunction } from './types'\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\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   * Callback function that is called after the function is executed\n   */\n  onExecute?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => 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<RateLimiterOptions<any>> = {\n  enabled: true,\n  limit: 1,\n  onExecute: () => {},\n  onReject: () => {},\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a 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 * 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 RateLimiter(\n *   (id: string) => 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 * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  private _executionCount = 0\n  private _rejectionCount = 0\n  private _executionTimes: Array<number> = []\n  private _options: RateLimiterOptions<TFn>\n\n  constructor(\n    private fn: TFn,\n    initialOptions: RateLimiterOptions<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<RateLimiterOptions<TFn>>): void {\n    this._options = { ...this._options, ...newOptions }\n  }\n\n  /**\n   * Returns the current rate limiter options\n   */\n  getOptions(): Required<RateLimiterOptions<TFn>> {\n    return this._options as Required<RateLimiterOptions<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   *\n   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute(...args: Parameters<TFn>): boolean {\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        this.executeFunction(...args)\n        return true\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        this.executeFunction(...args)\n        return true\n      }\n    }\n\n    this.rejectFunction()\n    return false\n  }\n\n  private executeFunction(...args: Parameters<TFn>): void {\n    if (!this._options.enabled) return\n    const now = Date.now()\n    this._executionCount++\n    this._executionTimes.push(now)\n    this.fn(...args) // execute the function\n    this._options.onExecute?.(this)\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 times the function has been executed\n   */\n  getExecutionCount(): number {\n    return this._executionCount\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 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   */\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   * Resets the rate limiter state\n   */\n  reset(): void {\n    this._executionTimes = []\n    this._executionCount = 0\n    this._rejectionCount = 0\n  }\n}\n\n/**\n * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.\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 * 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 * 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 = rateLimit(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 * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: Omit<RateLimiterOptions<TFn>, 'enabled'>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute.bind(rateLimiter)\n}\n"],"names":[],"mappings":"AAoCA,MAAM,iBAAoD;AAAA,EACxD,SAAS;AAAA,EACT,OAAO;AAAA,EACP,WAAW,MAAM;AAAA,EAAC;AAAA,EAClB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,QAAQ;AAAA,EACR,YAAY;AACd;AAiCO,MAAM,YAAqC;AAAA,EAMhD,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AANV,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAkB;AAC1B,SAAQ,kBAAiC,CAAC;AAOxC,SAAK,WAAW;AAAA,MACd,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,WAAW,YAAoD;AAC7D,SAAK,WAAW,EAAE,GAAG,KAAK,UAAU,GAAG,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpD,aAAgD;AAC9C,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBd,gBAAgB,MAAgC;AAC9C,SAAK,qBAAqB;AAEtB,QAAA,KAAK,SAAS,eAAe,WAAW;AAE1C,UAAI,KAAK,gBAAgB,SAAS,KAAK,SAAS,OAAO;AAChD,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT,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;AAC/D,aAAA,gBAAgB,GAAG,IAAI;AACrB,eAAA;AAAA,MAAA;AAAA,IACT;AAGF,SAAK,eAAe;AACb,WAAA;AAAA,EAAA;AAAA,EAGD,mBAAmB,MAA6B;AA/G1D;AAgHQ,QAAA,CAAC,KAAK,SAAS,QAAS;AACtB,UAAA,MAAM,KAAK,IAAI;AAChB,SAAA;AACA,SAAA,gBAAgB,KAAK,GAAG;AACxB,SAAA,GAAG,GAAG,IAAI;AACV,qBAAA,UAAS,cAAT,4BAAqB;AAAA,EAAI;AAAA,EAGxB,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,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,uBAA+B;AAC7B,SAAK,qBAAqB;AACnB,WAAA,KAAK,IAAI,GAAG,KAAK,SAAS,QAAQ,KAAK,gBAAgB,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtE,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,QAAc;AACZ,SAAK,kBAAkB,CAAC;AACxB,SAAK,kBAAkB;AACvB,SAAK,kBAAkB;AAAA,EAAA;AAE3B;AAuCgB,SAAA,UACd,IACA,gBACA;AACA,QAAM,cAAc,IAAI,YAAY,IAAI,cAAc;AAC/C,SAAA,YAAY,aAAa,KAAK,WAAW;AAClD;"}

package/dist/esm/throttler.d.ts

@@ -2,7 +2,7 @@ import { AnyFunction } from './types.js';
 /**
  * Options for configuring a throttled function
  */
-export interface ThrottlerOptions<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
+export interface ThrottlerOptions<TFn extends AnyFunction> {
     /**
      * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
      * Defaults to true.
@@ -16,7 +16,7 @@ export interface ThrottlerOptions<TFn extends AnyFunction, TArgs extends Paramet
     /**
      * Callback function that is called after the function is executed
      */
-    onExecute?: (throttler: Throttler<TFn, TArgs>) => void;
+    onExecute?: (throttler: Throttler<TFn>) => void;
     /**
      * Whether to execute on the trailing edge of the timeout.
      * Defaults to true.
@@ -54,24 +54,23 @@ export interface ThrottlerOptions<TFn extends AnyFunction, TArgs extends Paramet
  * throttler.maybeExecute('123'); // Throttled
  * ```
  */
-export declare class Throttler<TFn extends AnyFunction, TArgs extends Parameters<TFn>> {
+export declare class Throttler<TFn extends AnyFunction> {
     private fn;
     private _executionCount;
     private _lastArgs;
     private _lastExecutionTime;
     private _options;
     private _timeoutId;
-    private _isPending;
-    constructor(fn: TFn, initialOptions: ThrottlerOptions<TFn, TArgs>);
+    constructor(fn: TFn, initialOptions: ThrottlerOptions<TFn>);
     /**
      * Updates the throttler options
      * Returns the new options state
      */
-    setOptions(newOptions: Partial<ThrottlerOptions<TFn, TArgs>>): Required<ThrottlerOptions<TFn, TArgs>>;
+    setOptions(newOptions: Partial<ThrottlerOptions<TFn>>): void;
     /**
      * Returns the current throttler options
      */
-    getOptions(): Required<ThrottlerOptions<TFn, TArgs>>;
+    getOptions(): Required<ThrottlerOptions<TFn>>;
     /**
      * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
      *
@@ -94,7 +93,7 @@ export declare class Throttler<TFn extends AnyFunction, TArgs extends Parameters
      * throttled.maybeExecute('c', 'd');
      * ```
      */
-    maybeExecute(...args: TArgs): void;
+    maybeExecute(...args: Parameters<TFn>): void;
     private executeFunction;
     /**
      * Cancels any pending trailing execution and clears internal state.
@@ -106,14 +105,6 @@ export declare class Throttler<TFn extends AnyFunction, TArgs extends Parameters
      * Has no effect if there is no pending execution.
      */
     cancel(): void;
-    /**
-     * Returns the number of times the function has been executed
-     */
-    getExecutionCount(): number;
-    /**
-     * Returns `true` if there is a pending execution
-     */
-    getIsPending(): boolean;
     /**
      * Returns the last execution time
      */
@@ -122,6 +113,14 @@ export declare class Throttler<TFn extends AnyFunction, TArgs extends Parameters
      * Returns the next execution time
      */
     getNextExecutionTime(): number;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns `true` if there is a pending execution
+     */
+    getIsPending(): boolean;
 }
 /**
  * Creates a throttled function that limits how often the provided function can execute.
@@ -149,4 +148,4 @@ export declare class Throttler<TFn extends AnyFunction, TArgs extends Parameters
  * });
  * ```
  */
-export declare function throttle<TFn extends AnyFunction, TArgs extends Parameters<TFn>>(fn: TFn, initialOptions: Omit<ThrottlerOptions<TFn, TArgs>, 'enabled'>): (...args: TArgs) => void;
+export declare function throttle<TFn extends AnyFunction>(fn: TFn, initialOptions: Omit<ThrottlerOptions<TFn>, 'enabled'>): (...args: Parameters<TFn>) => void;