queueLimit

[danstarns]

Ability to limit the in-memory events held in the 'events array', if the array is at 'capacity' new events will be dropped (not pushed onto the array).

Example Definition

interface Options {
  /**
   * Number of items to be held in memory.
   */
  queueLimit?: number;
  ...
}

Example

const forEmitOf = require("../dist");
const { EventEmitter } = require("events");

async function main() {
  const emitter = new EventEmitter();

  const iterator = forEmitOf(emitter, {
    queueLimit: 3,
  });

  emitter.emit("data", 1);
  emitter.emit("data", 2);
  emitter.emit("data", 3);
  emitter.emit("data", 4); // DISCARDED

  const first = await iterator.next();
  const second = await iterator.next();
  const third = await iterator.next();
  const forth = await iterator.next(); // null? 🤔
}

main();

[Farenheith]

What do you think about instead of memoryLimit the property being called queueLImit?

Edit:
About the fourth next(), I think the expected behavior is for it waits until a new event is emitted... in that case, as the keepAlive is not in use, the execution would end

[danstarns]

@Farenheith I like queueLImit makes more sense & thanks for clarifying my '🤔' was not sure the exact behavior.