@tanstack/pacer 0.1.0

package/dist/esm/queuer.d.ts

@@ -0,0 +1,221 @@
+/**
+ * Options for configuring a Queuer instance
+ */
+export interface QueuerOptions<TValue> {
+    /**
+     * Default position to add items to the queuer
+     * @default 'back'
+     */
+    addItemsTo?: QueuePosition;
+    /**
+     * Default position to get items from during processing
+     * @default 'front'
+     */
+    getItemsFrom?: QueuePosition;
+    /**
+     * Function to determine priority of items in the queuer
+     * Higher priority items will be processed first
+     */
+    getPriority?: (item: TValue) => number;
+    /**
+     * Initial items to populate the queuer with
+     */
+    initialItems?: Array<TValue>;
+    /**
+     * Maximum number of items allowed in the queuer
+     */
+    maxSize?: number;
+    /**
+     * Callback fired whenever an item is removed from the queuer
+     */
+    onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void;
+    /**
+     * Callback fired whenever an item is added or removed from the queuer
+     */
+    onUpdate?: (queuer: Queuer<TValue>) => void;
+    /**
+     * Whether the queuer should start processing tasks immediately
+     */
+    started?: boolean;
+    /**
+     * Time in milliseconds to wait between processing items
+     */
+    wait?: number;
+}
+/**
+ * Position type for addItem and getNextItem operations
+ */
+export type QueuePosition = 'front' | 'back';
+/**
+ * A flexible queue data structure that defaults to FIFO (First In First Out) behavior
+ * with optional position overrides for stack-like or double-ended operations.
+ *
+ * The queuer can automatically process items as they are added, with configurable
+ * wait times between processing each item. Processing can be started/stopped
+ * and the queuer will maintain its state.
+ *
+ * Supports priority-based ordering when a getPriority function is provided.
+ * Items with higher priority values will be processed first.
+ *
+ * Default queue behavior:
+ * - addItem(item): adds to back of queuer
+ * - getNextItem(): removes and returns from front of queuer
+ *
+ * Stack (LIFO) behavior:
+ * - addItem(item, 'back'): adds to back
+ * - getNextItem('back'): removes and returns from back
+ *
+ * Double-ended queuer behavior:
+ * - addItem(item, position): adds to specified position ('front' or 'back')
+ * - getNextItem(position): removes and returns from specified position
+ *
+ * Processing behavior:
+ * - start(): begins processing items in the queuer
+ * - stop(): pauses processing
+ * - wait: configurable delay between processing items
+ * - onUpdate/onGetNextItem: callbacks for monitoring queuer state
+ *
+ * @example
+ * ```ts
+ * // FIFO queuer
+ * const queuer = new Queuer<number>();
+ * queuer.addItem(1); // [1]
+ * queuer.addItem(2); // [1, 2]
+ * queuer.getNextItem(); // returns 1, queuer is [2]
+ *
+ * // Priority queuer with processing
+ * const priorityQueue = new Queuer<number>({
+ *   getPriority: (n) => n, // Higher numbers have priority
+ *   started: true, // Begin processing immediately
+ *   wait: 1000, // Wait 1s between items
+ *   onGetNextItem: (item) => console.log(item)
+ * });
+ * priorityQueue.addItem(1); // [1]
+ * priorityQueue.addItem(3); // [3, 1] - 3 processed first
+ * priorityQueue.addItem(2); // [3, 2, 1]
+ * ```
+ */
+export declare class Queuer<TValue> {
+    protected options: Required<QueuerOptions<TValue>>;
+    private items;
+    private executionCount;
+    private onUpdates;
+    private running;
+    private pendingTick;
+    constructor(initialOptions?: QueuerOptions<TValue>);
+    /**
+     * Processes items in the queuer
+     */
+    protected tick(): void;
+    /**
+     * Updates the queuer options
+     * Returns the new options state
+     */
+    setOptions(newOptions: Partial<QueuerOptions<TValue>>): QueuerOptions<TValue>;
+    /**
+     * Adds an item to the queuer and starts processing if not already running
+     * @returns true if item was added, false if queuer is full
+     */
+    addItem(item: TValue, position?: QueuePosition, runOnUpdate?: boolean): boolean;
+    /**
+     * Removes and returns an item from the queuer using shift (default) or pop
+     *
+     * @example
+     * ```ts
+     * // Standard FIFO queuer
+     * queuer.getNextItem()
+     * // Stack-like behavior (LIFO)
+     * queuer.getNextItem('back')
+     * ```
+     */
+    getNextItem(position?: QueuePosition): TValue | undefined;
+    /**
+     * Returns an item without removing it
+     *
+     * @example
+     * ```ts
+     * // Look at next item to getNextItem
+     * queuer.peek()
+     * // Look at last item (like stack top)
+     * queuer.peek('back')
+     * ```
+     */
+    peek(position?: QueuePosition): TValue | undefined;
+    /**
+     * Returns true if the queuer is empty
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns true if the queuer is full
+     */
+    isFull(): boolean;
+    /**
+     * Returns the current size of the queuer
+     */
+    size(): number;
+    /**
+     * Removes all items from the queuer
+     */
+    clear(): void;
+    /**
+     * Resets the queuer to its initial state
+     */
+    reset(withInitialItems?: boolean): void;
+    /**
+     * Returns a copy of all items in the queuer
+     */
+    getAllItems(): Array<TValue>;
+    /**
+     * Returns the number of items that have been removed from the queuer
+     */
+    getExecutionCount(): number;
+    /**
+     * Adds a callback to be called when an item is processed
+     */
+    onUpdate(cb: (item: TValue) => void): () => void;
+    /**
+     * Stops the queuer from processing items
+     */
+    stop(): void;
+    /**
+     * Starts the queuer and processes items
+     */
+    start(): void;
+    /**
+     * Returns true if the queuer is running
+     */
+    isRunning(): boolean;
+    /**
+     * Returns true if the queuer is running but has no items to process
+     */
+    isIdle(): boolean;
+}
+/**
+ * Creates a queue that processes items in a queuer immediately upon addition.
+ * Items are processed sequentially in FIFO order by default.
+ *
+ * This is a simplified wrapper around the Queuer class that only exposes the
+ * `addItem` method. This queue is always running and will process items as they are added.
+ * For more control over queuer processing, use the Queuer class
+ * directly which provides methods like `start`, `stop`, `reset`, and more.
+ *
+ * @example
+ * ```ts
+ * // Basic sequential processing
+ * const processItems = queuer<number>({
+ *   wait: 1000,
+ *   onUpdate: (queuer) => console.log(queuer.getAllItems())
+ * })
+ * processItems(1) // Logs: 1
+ * processItems(2) // Logs: 2 after 1 completes
+ *
+ * // Priority queuer
+ * const processPriority = queuer<number>({
+ *   process: async (n) => console.log(n),
+ *   getPriority: n => n // Higher numbers processed first
+ * })
+ * processPriority(1)
+ * processPriority(3) // Processed before 1
+ * ```
+ */
+export declare function queue<TValue>(options?: QueuerOptions<TValue>): (item: TValue, position?: QueuePosition, runOnUpdate?: boolean) => boolean;

package/dist/esm/queuer.js

@@ -0,0 +1,231 @@
+const defaultOptions = {
+  addItemsTo: "back",
+  getItemsFrom: "front",
+  getPriority: () => 0,
+  initialItems: [],
+  maxSize: Infinity,
+  onGetNextItem: () => {
+  },
+  onUpdate: () => {
+  },
+  started: false,
+  wait: 0
+};
+class Queuer {
+  constructor(initialOptions = defaultOptions) {
+    this.items = [];
+    this.executionCount = 0;
+    this.onUpdates = [];
+    this.pendingTick = false;
+    this.options = { ...defaultOptions, ...initialOptions };
+    this.running = this.options.started;
+    for (let i = 0; i < this.options.initialItems.length; i++) {
+      const item = this.options.initialItems[i];
+      const isLast = i === this.options.initialItems.length - 1;
+      this.addItem(item, this.options.addItemsTo, isLast);
+    }
+  }
+  /**
+   * Processes items in the queuer
+   */
+  tick() {
+    if (!this.running) {
+      this.pendingTick = false;
+      return;
+    }
+    while (!this.isEmpty()) {
+      const nextItem = this.getNextItem(this.options.getItemsFrom);
+      if (nextItem === void 0) {
+        break;
+      }
+      this.onUpdates.forEach((cb) => cb(nextItem));
+      if (this.options.wait > 0) {
+        setTimeout(() => this.tick(), this.options.wait);
+        return;
+      }
+      this.tick();
+    }
+    this.pendingTick = false;
+  }
+  /**
+   * Updates the queuer options
+   * Returns the new options state
+   */
+  setOptions(newOptions) {
+    this.options = { ...this.options, ...newOptions };
+    return this.options;
+  }
+  /**
+   * Adds an item to the queuer and starts processing if not already running
+   * @returns true if item was added, false if queuer is full
+   */
+  addItem(item, position = this.options.addItemsTo, runOnUpdate = true) {
+    if (this.isFull()) {
+      return false;
+    }
+    if (this.options.getPriority !== defaultOptions.getPriority) {
+      const priority = this.options.getPriority(item);
+      const insertIndex = this.items.findIndex(
+        (existing) => this.options.getPriority(existing) > priority
+      );
+      if (insertIndex === -1) {
+        this.items.push(item);
+      } else {
+        this.items.splice(insertIndex, 0, item);
+      }
+    } else {
+      if (position === "front") {
+        this.items.unshift(item);
+      } else {
+        this.items.push(item);
+      }
+    }
+    if (this.running && !this.pendingTick) {
+      this.pendingTick = true;
+      this.tick();
+    }
+    if (runOnUpdate) {
+      this.options.onUpdate(this);
+    }
+    return true;
+  }
+  /**
+   * Removes and returns an item from the queuer using shift (default) or pop
+   *
+   * @example
+   * ```ts
+   * // Standard FIFO queuer
+   * queuer.getNextItem()
+   * // Stack-like behavior (LIFO)
+   * queuer.getNextItem('back')
+   * ```
+   */
+  getNextItem(position = this.options.getItemsFrom) {
+    let item;
+    if (position === "front") {
+      item = this.items.shift();
+    } else {
+      item = this.items.pop();
+    }
+    if (item !== void 0) {
+      this.executionCount++;
+      this.options.onUpdate(this);
+      this.options.onGetNextItem(item, this);
+    }
+    return item;
+  }
+  /**
+   * Returns an item without removing it
+   *
+   * @example
+   * ```ts
+   * // Look at next item to getNextItem
+   * queuer.peek()
+   * // Look at last item (like stack top)
+   * queuer.peek('back')
+   * ```
+   */
+  peek(position = this.options.getItemsFrom) {
+    if (position === "front") {
+      return this.items[0];
+    }
+    return this.items[this.items.length - 1];
+  }
+  /**
+   * Returns true if the queuer is empty
+   */
+  isEmpty() {
+    return this.items.length === 0;
+  }
+  /**
+   * Returns true if the queuer is full
+   */
+  isFull() {
+    return this.items.length >= this.options.maxSize;
+  }
+  /**
+   * Returns the current size of the queuer
+   */
+  size() {
+    return this.items.length;
+  }
+  /**
+   * Removes all items from the queuer
+   */
+  clear() {
+    this.items = [];
+    this.options.onUpdate(this);
+  }
+  /**
+   * Resets the queuer to its initial state
+   */
+  reset(withInitialItems) {
+    this.clear();
+    this.executionCount = 0;
+    if (withInitialItems) {
+      this.items = [...this.options.initialItems];
+    }
+    this.running = this.options.started;
+  }
+  /**
+   * Returns a copy of all items in the queuer
+   */
+  getAllItems() {
+    return [...this.items];
+  }
+  /**
+   * Returns the number of items that have been removed from the queuer
+   */
+  getExecutionCount() {
+    return this.executionCount;
+  }
+  /**
+   * Adds a callback to be called when an item is processed
+   */
+  onUpdate(cb) {
+    this.onUpdates.push(cb);
+    return () => {
+      this.onUpdates = this.onUpdates.filter((d) => d !== cb);
+    };
+  }
+  /**
+   * Stops the queuer from processing items
+   */
+  stop() {
+    this.running = false;
+    this.pendingTick = false;
+    this.options.onUpdate(this);
+  }
+  /**
+   * Starts the queuer and processes items
+   */
+  start() {
+    this.running = true;
+    if (!this.pendingTick && !this.isEmpty()) {
+      this.pendingTick = true;
+      this.tick();
+    }
+    this.options.onUpdate(this);
+  }
+  /**
+   * Returns true if the queuer is running
+   */
+  isRunning() {
+    return this.running;
+  }
+  /**
+   * Returns true if the queuer is running but has no items to process
+   */
+  isIdle() {
+    return this.running && this.isEmpty();
+  }
+}
+function queue(options = {}) {
+  const queuer = new Queuer({ ...options, started: true });
+  return queuer.addItem.bind(queuer);
+}
+export {
+  Queuer,
+  queue
+};
+//# sourceMappingURL=queuer.js.map

package/dist/esm/queuer.js.map

@@ -0,0 +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 an item is added or removed from the queuer\n   */\n  onUpdate?: (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: () => 0,\n  initialItems: [],\n  maxSize: Infinity,\n  onGetNextItem: () => {},\n  onUpdate: () => {},\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 * - onUpdate/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) => 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  protected options: Required<QueuerOptions<TValue>>\n  private items: Array<TValue> = []\n  private executionCount = 0\n  private onUpdates: 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   * Processes items in the queuer\n   */\n  protected tick() {\n    if (!this.running) {\n      this.pendingTick = false\n      return\n    }\n    while (!this.isEmpty()) {\n      const nextItem = this.getNextItem(this.options.getItemsFrom)\n      if (nextItem === undefined) {\n        break\n      }\n      this.onUpdates.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   * 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   * 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.isFull()) {\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.onUpdate(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.onUpdate(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.peek()\n   * // Look at last item (like stack top)\n   * queuer.peek('back')\n   * ```\n   */\n  peek(\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  isEmpty(): boolean {\n    return this.items.length === 0\n  }\n\n  /**\n   * Returns true if the queuer is full\n   */\n  isFull(): boolean {\n    return this.items.length >= this.options.maxSize\n  }\n\n  /**\n   * Returns the current size of the queuer\n   */\n  size(): number {\n    return this.items.length\n  }\n\n  /**\n   * Removes all items from the queuer\n   */\n  clear(): void {\n    this.items = []\n    this.options.onUpdate(this)\n  }\n\n  /**\n   * Resets the queuer to its initial state\n   */\n  reset(withInitialItems?: boolean): void {\n    this.clear()\n    this.executionCount = 0\n    if (withInitialItems) {\n      this.items = [...this.options.initialItems]\n    }\n    this.running = this.options.started\n  }\n\n  /**\n   * Returns a copy of all items in the queuer\n   */\n  getAllItems(): Array<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   * Adds a callback to be called when an item is processed\n   */\n  onUpdate(cb: (item: TValue) => void) {\n    this.onUpdates.push(cb)\n    return () => {\n      this.onUpdates = this.onUpdates.filter((d) => d !== cb)\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.onUpdate(this)\n  }\n\n  /**\n   * Starts the queuer and processes items\n   */\n  start() {\n    this.running = true\n    if (!this.pendingTick && !this.isEmpty()) {\n      this.pendingTick = true\n      this.tick()\n    }\n    this.options.onUpdate(this)\n  }\n\n  /**\n   * Returns true if the queuer is running\n   */\n  isRunning() {\n    return this.running\n  }\n\n  /**\n   * Returns true if the queuer is running but has no items to process\n   */\n  isIdle() {\n    return this.running && this.isEmpty()\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 *   onUpdate: (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":"AA6CA,MAAM,iBAA+C;AAAA,EACnD,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,aAAa,MAAM;AAAA,EACnB,cAAc,CAAC;AAAA,EACf,SAAS;AAAA,EACT,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,UAAU,MAAM;AAAA,EAAC;AAAA,EACjB,SAAS;AAAA,EACT,MAAM;AACR;AAwDO,MAAM,OAAe;AAAA,EAQ1B,YAAY,iBAAwC,gBAAgB;AANpE,SAAQ,QAAuB,CAAC;AAChC,SAAQ,iBAAiB;AACzB,SAAQ,YAA2C,CAAC;AAEpD,SAAQ,cAAc;AAGpB,SAAK,UAAU,EAAE,GAAG,gBAAgB,GAAG,eAAe;AACjD,SAAA,UAAU,KAAK,QAAQ;AAE5B,aAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,aAAa,QAAQ,KAAK;AACzD,YAAM,OAAO,KAAK,QAAQ,aAAa,CAAC;AACxC,YAAM,SAAS,MAAM,KAAK,QAAQ,aAAa,SAAS;AACxD,WAAK,QAAQ,MAAM,KAAK,QAAQ,YAAY,MAAM;AAAA,IAAA;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAMQ,OAAO;AACX,QAAA,CAAC,KAAK,SAAS;AACjB,WAAK,cAAc;AACnB;AAAA,IAAA;AAEK,WAAA,CAAC,KAAK,WAAW;AACtB,YAAM,WAAW,KAAK,YAAY,KAAK,QAAQ,YAAY;AAC3D,UAAI,aAAa,QAAW;AAC1B;AAAA,MAAA;AAEF,WAAK,UAAU,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC;AAEvC,UAAA,KAAK,QAAQ,OAAO,GAAG;AAEzB,mBAAW,MAAM,KAAK,KAAQ,GAAA,KAAK,QAAQ,IAAI;AAC/C;AAAA,MAAA;AAGF,WAAK,KAAK;AAAA,IAAA;AAEZ,SAAK,cAAc;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrB,WACE,YACuB;AACvB,SAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAW;AAChD,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,QACE,MACA,WAA0B,KAAK,QAAQ,YACvC,cAAuB,MACd;AACL,QAAA,KAAK,UAAU;AACV,aAAA;AAAA,IAAA;AAGT,QAAI,KAAK,QAAQ,gBAAgB,eAAe,aAAa;AAE3D,YAAM,WAAW,KAAK,QAAQ,YAAY,IAAI;AACxC,YAAA,cAAc,KAAK,MAAM;AAAA,QAC7B,CAAC,aAAa,KAAK,QAAQ,YAAY,QAAQ,IAAI;AAAA,MACrD;AAEA,UAAI,gBAAgB,IAAI;AACjB,aAAA,MAAM,KAAK,IAAI;AAAA,MAAA,OACf;AACL,aAAK,MAAM,OAAO,aAAa,GAAG,IAAI;AAAA,MAAA;AAAA,IACxC,OACK;AAEL,UAAI,aAAa,SAAS;AACnB,aAAA,MAAM,QAAQ,IAAI;AAAA,MAAA,OAClB;AACA,aAAA,MAAM,KAAK,IAAI;AAAA,MAAA;AAAA,IACtB;AAGF,QAAI,KAAK,WAAW,CAAC,KAAK,aAAa;AACrC,WAAK,cAAc;AACnB,WAAK,KAAK;AAAA,IAAA;AAEZ,QAAI,aAAa;AACV,WAAA,QAAQ,SAAS,IAAI;AAAA,IAAA;AAErB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,YACE,WAA0B,KAAK,QAAQ,cACnB;AAChB,QAAA;AAEJ,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,MAAM;AAAA,IAAA,OACnB;AACE,aAAA,KAAK,MAAM,IAAI;AAAA,IAAA;AAGxB,QAAI,SAAS,QAAW;AACjB,WAAA;AACA,WAAA,QAAQ,SAAS,IAAI;AACrB,WAAA,QAAQ,cAAc,MAAM,IAAI;AAAA,IAAA;AAEhC,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcT,KACE,WAA0B,KAAK,QAAQ,cACnB;AACpB,QAAI,aAAa,SAAS;AACjB,aAAA,KAAK,MAAM,CAAC;AAAA,IAAA;AAErB,WAAO,KAAK,MAAM,KAAK,MAAM,SAAS,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,UAAmB;AACV,WAAA,KAAK,MAAM,WAAW;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,SAAkB;AAChB,WAAO,KAAK,MAAM,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,OAAe;AACb,WAAO,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMpB,QAAc;AACZ,SAAK,QAAQ,CAAC;AACT,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,MAAM,kBAAkC;AACtC,SAAK,MAAM;AACX,SAAK,iBAAiB;AACtB,QAAI,kBAAkB;AACpB,WAAK,QAAQ,CAAC,GAAG,KAAK,QAAQ,YAAY;AAAA,IAAA;AAEvC,SAAA,UAAU,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,cAA6B;AACpB,WAAA,CAAC,GAAG,KAAK,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMvB,oBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAS,IAA4B;AAC9B,SAAA,UAAU,KAAK,EAAE;AACtB,WAAO,MAAM;AACX,WAAK,YAAY,KAAK,UAAU,OAAO,CAAC,MAAM,MAAM,EAAE;AAAA,IACxD;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMF,OAAO;AACL,SAAK,UAAU;AACf,SAAK,cAAc;AACd,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,QAAQ;AACN,SAAK,UAAU;AACf,QAAI,CAAC,KAAK,eAAe,CAAC,KAAK,WAAW;AACxC,WAAK,cAAc;AACnB,WAAK,KAAK;AAAA,IAAA;AAEP,SAAA,QAAQ,SAAS,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM5B,YAAY;AACV,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,SAAS;AACA,WAAA,KAAK,WAAW,KAAK,QAAQ;AAAA,EAAA;AAExC;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

@@ -0,0 +1,147 @@
+/**
+ * Information about a rate limit rejection
+ */
+export interface RateLimitRejectionInfo {
+    /**
+     * Number of milliseconds until the next execution will be possible
+     */
+    msUntilNextWindow: number;
+    /**
+     * Current number of executions in the window
+     */
+    currentExecutions: number;
+    /**
+     * Maximum allowed executions per window
+     */
+    limit: number;
+    /**
+     * Total number of rejections that have occurred
+     */
+    rejectionCount: number;
+}
+/**
+ * Options for configuring a rate-limited function
+ */
+export interface RateLimiterOptions {
+    /**
+     * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
+     * Defaults to true.
+     */
+    enabled?: boolean;
+    /**
+     * Maximum number of executions allowed within the time window
+     */
+    limit: number;
+    /**
+     * Time window in milliseconds within which the limit applies
+     */
+    window: number;
+    /**
+     * Optional callback function that is called when an execution is rejected due to rate limiting
+     */
+    onReject?: (info: RateLimitRejectionInfo) => void;
+}
+/**
+ * A class that creates a rate-limited function.
+ *
+ * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
+ * 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.
+ *
+ * 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)
+ *
+ * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
+ * smoothing out frequent events, throttling or debouncing usually provide better user experience.
+ *
+ * @example
+ * ```ts
+ * const rateLimiter = new RateLimiter(
+ *   (id: string) => api.getData(id),
+ *   { limit: 5, window: 1000 } // 5 calls per second
+ * );
+ *
+ * // Will execute immediately until limit reached, then block
+ * rateLimiter.maybeExecute('123');
+ * ```
+ */
+export declare class RateLimiter<TFn extends (...args: Array<any>) => any, TArgs extends Parameters<TFn>> {
+    private fn;
+    private executionCount;
+    private rejectionCount;
+    private executionTimes;
+    private options;
+    constructor(fn: TFn, initialOptions: RateLimiterOptions);
+    /**
+     * Updates the rate limiter options
+     * Returns the new options state
+     */
+    setOptions(newOptions: Partial<RateLimiterOptions>): RateLimiterOptions;
+    /**
+     * Returns the number of times the function has been executed
+     */
+    getExecutionCount(): number;
+    /**
+     * Returns the number of times the function has been rejected
+     */
+    getRejectionCount(): number;
+    /**
+     * Returns the number of remaining executions allowed in the current window
+     */
+    getRemainingInWindow(): 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.
+     *
+     * @example
+     * ```ts
+     * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
+     *
+     * // First 5 calls will return true
+     * rateLimiter.maybeExecute('arg1', 'arg2'); // true
+     *
+     * // Additional calls within the window will return false
+     * rateLimiter.maybeExecute('arg1', 'arg2'); // false
+     * ```
+     */
+    maybeExecute(...args: TArgs): boolean;
+    private executeFunction;
+    private rejectFunction;
+    private cleanupOldExecutions;
+    /**
+     * Resets the rate limiter state
+     */
+    reset(): void;
+}
+/**
+ * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.
+ *
+ * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:
+ * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets
+ * - 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
+ *
+ * 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
+ * const rateLimited = rateLimit(makeApiCall, {
+ *   limit: 5,
+ *   window: 60000,
+ *   onReject: ({ msUntilNextWindow }) => {
+ *     console.log(`Rate limit exceeded. Try again in ${msUntilNextWindow}ms`);
+ *   }
+ * });
+ *
+ * // First 5 calls will execute immediately
+ * // Additional calls will be rejected until the minute window resets
+ * rateLimited();
+ *
+ * // For more even execution, consider using throttle instead:
+ * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
+ * ```
+ */
+export declare function rateLimit<TFn extends (...args: Array<any>) => any>(fn: TFn, initialOptions: Omit<RateLimiterOptions, 'enabled'>): (...args: Parameters<TFn>) => boolean;