# binheap

> simple binary heap module

Latest version **1.0.0** (published 2015-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install binheap
pnpm add binheap
yarn add binheap
bun add binheap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-12-26 |
| First published | 2015-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tyler Anderson |
| Maintainers | bravado |
| Keywords | heap, binaryheap |

## Links

- npm: https://www.npmjs.com/package/binheap
- Repository: https://github.com/Tyler-Anderson/binheap
- Homepage: https://github.com/Tyler-Anderson/binheap#readme
- Issues: https://github.com/Tyler-Anderson/binheap/issues
- npm.io page: https://npm.io/package/binheap

## Recent versions

- 1.0.0 (latest) — 2015-12-26

## README

# binheap
a simple binheap i need to work as an npm module

module exports a function/class BinaryHeap which you call with a score function to get the new heap. 
right now scorefunction should return a numerical value but the compare step could easily be patched
to allow for any custom compare function. 

the returned heap is composed of
  .heap gives the contents
  .push will push an element and run the sink down function
  .pop will pop off the first element of the heap and have the heap adjust itself
  .remove takes the node you want to remove and removes it.
  .size is just a function to return the length of the heap.
  
if there is any interest i will add the needed custom scoring function to this library myself, feel free to create
an issue or email me.

---
_Source: https://npm.io/package/binheap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._