# fast-fifo

> A fast fifo implementation similar to the one powering nextTick in Node.js core

Latest version **1.3.2** (published 2023-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install fast-fifo
pnpm add fast-fifo
yarn add fast-fifo
bun add fast-fifo
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2023-08-21 |
| First published | 2019-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/fast-fifo) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Author | Mathias Buus |
| Maintainers | mafintosh |

## Links

- npm: https://www.npmjs.com/package/fast-fifo
- Repository: https://github.com/mafintosh/fast-fifo
- Issues: https://github.com/mafintosh/fast-fifo/issues
- npm.io page: https://npm.io/package/fast-fifo

## Recent versions

- 1.3.2 (latest) — 2023-08-21
- 1.3.1 — 2023-08-21
- 1.3.0 — 2023-06-26
- 1.2.0 — 2023-04-06
- 1.1.0 — 2022-01-21
- 1.0.0 — 2019-02-18

## README

# fast-fifo

A fast fifo implementation similar to the one powering nextTick in Node.js core

```
npm install fast-fifo
```

Uses a linked list of growing fixed sized arrays to implement the FIFO to avoid
allocating a wrapper object for each item.

## Usage

``` js
const FIFO = require('fast-fifo')

const q = new FIFO()

q.push('hello')
q.push('world')

q.shift() // returns hello
q.shift() // returns world
```

## API

#### `q = new FIFO()`

Create a new FIFO.

#### `q.push(value)`

Push a value to the FIFO. `value` can be anything other than undefined.

#### `value = q.shift()`

Return the oldest value from the FIFO.

#### `q.clear()`

Remove all values from the FIFO.

#### `bool = q.isEmpty()`

Returns `true` if the FIFO is empty and false otherwise.

#### `value = q.peek()`

Return the oldest value from the FIFO without shifting it out.

#### `len = q.length`

Get the number of entries remaining in the FIFO.

## Benchmarks

Included in bench.js is a simple benchmark that benchmarks this against a simple
linked list based FIFO.

On my machine the benchmark looks like this:

```
fifo bulk push and shift: 2881.508ms
fifo individual push and shift: 3248.437ms
fast-fifo bulk push and shift: 1606.972ms
fast-fifo individual push and shift: 1328.064ms
fifo bulk push and shift: 3266.902ms
fifo individual push and shift: 3320.944ms
fast-fifo bulk push and shift: 1858.307ms
fast-fifo individual push and shift: 1516.983ms
```

YMMV

## License

MIT

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