@barchart/common-js/dist/cjs/collections/Queue.js

Library of common JavaScript utilities

var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
  for (var name in all)
    __defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
  if (from && typeof from === "object" || typeof from === "function") {
    for (let key of __getOwnPropNames(from))
      if (!__hasOwnProp.call(to, key) && key !== except)
        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  }
  return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  // If the importer is in node compatibility mode or this is not an ESM
  // file that has been converted to a CommonJS file using a Babel-
  // compatible transform (i.e. "__esModule" has not been set), then set
  // "default" to the CommonJS "module.exports" for node compatibility.
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var Queue_exports = {};
__export(Queue_exports, {
  default: () => Queue
});
module.exports = __toCommonJS(Queue_exports);
var assert = __toESM(require("./../lang/assert.js"));
class Queue {
  #array;
  constructor() {
    this.#array = [];
  }
  /**
   * Adds an item to the end of the queue.
   *
   * @public
   * @param {*} item - The item to add.
   * @returns {*} The item added to the queue.
   */
  enqueue(item) {
    this.#array.push(item);
    return item;
  }
  /**
   * Removes the next item from the queue and returns it. Throws if the queue is empty.
   *
   * @public
   * @returns {*} The item removed from the queue.
   * @throws {Error} If the queue is empty.
   */
  dequeue() {
    if (this.empty()) {
      throw new Error("Queue is empty");
    }
    return this.#array.shift();
  }
  /**
   * Returns the next item in the queue without removing it.
   *
   * @public
   * @returns {*} The next item in the queue.
   * @throws {Error} If the queue is empty.
   */
  peek() {
    if (this.empty()) {
      throw new Error("Queue is empty");
    }
    return this.#array[0];
  }
  /**
   * Indicates whether the queue is empty.
   *
   * @public
   * @returns {boolean} True if the queue is empty; otherwise, false.
   */
  empty() {
    return this.#array.length === 0;
  }
  /**
   * Runs an action on each item in the queue.
   *
   * @public
   * @param {Function} action - The action to run.
   */
  scan(action) {
    assert.argumentIsRequired(action, "action", Function);
    this.#array.forEach((item) => action(item));
  }
  /**
   * Returns a copy of the queue's items without affecting its internal state.
   *
   * @public
   * @returns {Array<*>} A copy of the queue's items.
   */
  toArray() {
    return this.#array.slice(0);
  }
  /**
   * Returns the queue's internal array for use by derived classes.
   *
   * @protected
   * @returns {Array<*>} The internal array.
   */
  _getArray() {
    return this.#array;
  }
  /**
   * Returns a string representation.
   *
   * @public
   * @returns {string}
   */
  toString() {
    return "[Queue]";
  }
}

{
	const cjsExports = module.exports;
	const cjsDefaultExport = cjsExports && cjsExports.__esModule ? cjsExports.default : cjsExports;

	if (cjsDefaultExport && (typeof cjsDefaultExport === 'function' || typeof cjsDefaultExport === 'object')) {
		Object.keys(cjsExports).forEach((key) => {
			if (key !== 'default' && key !== '__esModule') {
				cjsDefaultExport[key] = cjsExports[key];
			}
		});
	}

	module.exports = cjsDefaultExport;
}