Priority Queue

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]

Installation

``
npm install @decoy9697/priority-queue
`

Usage

`js
import PQ, { LOW_FIRST } from "@decoy9697/priority-queue";

const pq = new PQ({ sort: LOW_FIRST });

// The number influences priority
// - lower takes precedence (given LOW_FIRST, otherwise use HIGH_FIRST)
// - with equal numbers, recency of insert takes precedence
pq.insert("🌵", 5);
pq.insert("🌿", 10);
pq.insert("🌴", 3);

// .peek() gives the item with the lowest number, but does not dequeue it
pq.peek(); // 🌴
pq.peek(); // 🌴

// .pop() gives the item with the lowest number, dequeuing it
pq.pop(); // 🌴
pq.pop(); // 🌵
pq.pop(); // 🌿
pq.pop(); // undefined

// .isEmpty() returns a boolean, true given it is empty
pq.isEmpty(); // true
`

Development

This project uses nix to install dependencies for the development shell.

$3

nix develop - starts a development shell with system dependencies

#### Within the shell

npm i - install project dependencies

npm test - run the tests

npm bench - run benchmarkjs

npm format` - run the linter

[build-badge]: https://github.com/craigdallimore/priority-queue/workflows/CI/badge.svg
[build]: https://github.com/craigdallimore/priority-queue/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/craigdallimore/priority-queue.svg
[coverage]: https://codecov.io/github/craigdallimore/priority-queue
[downloads-badge]: https://img.shields.io/npm/dm/@decoy9697/priority-queue.svg
[downloads]: https://www.npmjs.com/package/@decoy9697/priority-queue
[size-badge]: https://img.shields.io/bundlephobia/minzip/@decoy9697/priority-queue.svg
[size]: https://bundlephobia.com/result?p=@decoy9697/priority-queue