# vanilla-priority-queue
> javascript implementation of a priority queue
Latest version **2.0.2** (published 2020-05-17) · MIT license · 0 weekly downloads
## Install
```sh
npm install vanilla-priority-queue
pnpm add vanilla-priority-queue
yarn add vanilla-priority-queue
bun add vanilla-priority-queue
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.2 |
| Published | 2020-05-17 |
| First published | 2020-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Kevin Lee |
| Maintainers | leekevinyg |
| Keywords | javascript, priority queue, queue, heap, heaps, algorithms, data structures |
## Links
- npm: https://www.npmjs.com/package/vanilla-priority-queue
- Repository: https://github.com/leekevinyg/js-priority-queue
- Homepage: https://github.com/leekevinyg/js-priority-queue#readme
- Issues: https://github.com/leekevinyg/js-priority-queue/issues
- npm.io page: https://npm.io/package/vanilla-priority-queue
## Alternatives
- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads
## Recent versions
- 2.0.2 (latest) — 2020-05-17
- 2.0.1 — 2020-05-17
- 2.0.0 — 2020-05-17
- 1.0.3 — 2020-05-17
- 1.0.2 — 2020-05-15
- 1.0.1 — 2020-05-15
- 1.0.0 — 2020-05-15
## README
# Vanilla Priority Queue
A javascript implementation of a priority queue backed by a binary heap.
[](https://travis-ci.com/leekevinyg/js-priority-queue)
[](https://coveralls.io/github/leekevinyg/js-priority-queue)
[](https://badge.fury.io/js/vanilla-priority-queue)
- Installation
- Usage
- API
# Installation
```npm i vanilla-priority-queue --save```
# Usage
```
const { MinPriorityQueue, MaxPriorityQueue } = require('vanilla-priority-queue');
let minPriorityQueue = new MinPriorityQueue();
/*
The insert operation takes an item and it's priority.
The item argument can be anything.
The priority argument must be provided as an integer value.
*/
minPriorityQueue.insert(3, 3);
minPriorityQueue.insert(10, 10);
minPriorityQueue.peek() // returns 3
minPriorityQueue.remove() // returns 3
minPriorityQueue.remove() // returns 10
minPriorityQueue.isEmpty() // returns true
let maxPriorityQueue = new MaxPriorityQueue();
maxPriorityQueue.insert(3, 3);
maxPriorityQueue.insert(10, 10);
maxPriorityQueue.peek() // returns 10
maxPriorityQueue.remove() // returns 10
maxPriorityQueue.remove() // returns 3
maxPriorityQueue.isEmpty() // returns true
```
# API
Both the ```MaxPriorityQueue``` and ```MinPriorityQueue``` expose the following functions:
* **peek()**
Returns the highest priority item in the queue in constant time. For a ```MaxPriorityQueue``` this is the max element. For a ```MinPriorityQueue``` this is the min element.
* **insert(item, priority)**
The insert operation takes an ```item``` and it's ```priority``` and inserts the following object into the queue:
```
{
item: item,
priority: priority
}
```
The ```item``` argument can be anything.
The ```priority``` argument must be provided as an integer.
The operation completes in ```O(lg n)``` time.
* **remove()**
Removes the highest priority item in the queue in ```O(lg n)``` time. For a ```MaxPriorityQueue``` this is the max element. For a ```MinPriorityQueue``` this is the min element.
* **isEmpty()**
Returns a boolean value indicating whether the queue is empty or not.
* **length()**
Returns the length of the queue.
* **getHeap()**
Returns an array representation of the binary heap backing the priority queue. Note this contains a dummy ```null``` element at index ```0```.
---
_Source: https://npm.io/package/vanilla-priority-queue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._