securityos/node_modules/tinyqueue
Berkeley 927854894b First commit 2024-09-06 12:32:35 -03:00
..
.travis.yml First commit 2024-09-06 12:32:35 -03:00
LICENSE First commit 2024-09-06 12:32:35 -03:00
README.md First commit 2024-09-06 12:32:35 -03:00
bench.js First commit 2024-09-06 12:32:35 -03:00
bench2.js First commit 2024-09-06 12:32:35 -03:00
bench3.js First commit 2024-09-06 12:32:35 -03:00
index.js First commit 2024-09-06 12:32:35 -03:00
package.json First commit 2024-09-06 12:32:35 -03:00
test.js First commit 2024-09-06 12:32:35 -03:00
yarn.lock First commit 2024-09-06 12:32:35 -03:00

README.md

tinyqueue

The smallest and simplest binary heap priority queue in JavaScript.

// create an empty priority queue
var queue = new TinyQueue();

// add some items
queue.push(7);
queue.push(5);
queue.push(10);

// remove the top item
var top = queue.pop(); // returns 5

// return the top item (without removal)
top = queue.peek(); // returns 7

// get queue length
queue.length; // returns 2

// create a priority queue from an existing array (modifies the array)
queue = new TinyQueue([7, 5, 10]);

// pass a custom item comparator as a second argument
queue = new TinyQueue([{value: 5}, {value: 7}], function (a, b) {
	return a.value - b.value;
});

// turn a queue into a sorted array
var array = [];
while (queue.length) array.push(queue.pop());

Install as an NPM module:

$ npm install tinyqueue

Make a browser build using Browserify:

$ npm install -g browserify
$ browserify index.js -s TinyQueue > tinyqueue.js

Inspired by js-priority-queue by Adam Hooper.