Skip to content
The smallest and simplest priority queue in JavaScript.
JavaScript
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Add ES modules, classes. (#9) Aug 8, 2018
.travis.yml Add ES modules, classes. (#9) Aug 8, 2018
LICENSE add a license file Mar 15, 2017
README.md update readme Aug 8, 2018
bench.js fix: can run bench now (#19) Aug 18, 2019
index.d.ts refactor: improve type definition (#18) Aug 18, 2019
index.js avoid race condition in pop, close #10 Aug 27, 2018
package.json 2.0.3 Jun 14, 2019
rollup.config.js upgrade dependencies Apr 5, 2019
test.js upgrade dependencies Apr 5, 2019

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());

For a faster number-based queue, see flatqueue.

Install

Install using NPM (npm install tinyqueue) or Yarn (yarn add tinyqueue), then:

// import as an ES module
import TinyQueue from 'tinyqueue';

// or require in Node / Browserify
const TinyQueue = require('tinyqueue');

Or use a browser build directly:

<script src="https://unpkg.com/tinyqueue@2.0.0/tinyqueue.min.js"></script>

Thanks

Inspired by js-priority-queue by Adam Hooper.

You can’t perform that action at this time.