@barchart/common-js/collections/specialized/PriorityQueue.js

Library of common JavaScript utilities

const array = require('./../../lang/array'),
	assert = require('./../../lang/assert'),
	Queue = require('./../Queue');

module.exports = (() => {
	'use strict';

	/**
	 * A queue that sorts items as they are inserted.
	 *
	 * @public
	 * @extends {Queue}
	 */
	class PriorityQueue extends Queue {
		constructor(comparator) {
			super();

			assert.argumentIsRequired(comparator, 'comparator', Function);

			this._comparator = comparator;
		}

		enqueue(item) {
			array.insert(this._array, item, this._comparator);

			return item;
		}

		dequeue() {
			return super.dequeue();
		}

		peek() {
			return super.peek();
		}

		scan(action) {
			return super.scan(action);
		}

		toArray() {
			return super.toArray();
		}

		toString() {
			return '[PriorityQueue]';
		}
	}

	return PriorityQueue;
})();