Package Exports
- tinyqueue
- tinyqueue/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tinyqueue) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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.