# infinite-queue

> A small library which implements a queue where you are able to request items early if the queue is empty.

Latest version **1.1.1** (published 2020-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install infinite-queue
pnpm add infinite-queue
yarn add infinite-queue
bun add infinite-queue
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-06-28 |
| First published | 2020-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tom Jenkinson |
| Maintainers | tjenkinson |
| Keywords | queue, infinite, promise |

## Links

- npm: https://www.npmjs.com/package/infinite-queue
- Repository: https://github.com/tjenkinson/infinite-queue
- Homepage: https://github.com/tjenkinson/infinite-queue#readme
- Issues: https://github.com/tjenkinson/infinite-queue/issues
- npm.io page: https://npm.io/package/infinite-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

- 1.1.1 (latest) — 2020-06-28
- 1.1.0 — 2020-06-28
- 1.0.1 — 2020-06-27
- 1.0.0 — 2020-06-27

## README

[![npm version](https://badge.fury.io/js/infinite-queue.svg)](https://badge.fury.io/js/infinite-queue)

# Infinite Queue

A small library which implements a queue where you are able to request items early if the queue is empty.

## Installation

```sh
npm install --save infinite-queue
```

or available on JSDelivr at "https://cdn.jsdelivr.net/npm/infinite-queue@1".

## API

### `InfiniteQueue<TItem>()`

Create a queue.

### `queue.push(item: TItem): void`

Push an item onto the queue.

### `queue.next(): Promise<TItem>`

Returns a promise that will resolve with the oldest item in the queue, when there is one.

### `queue.next<TReturn>(onItem (item: TItem) => TReturn): Promise<TReturn>`

Provide an `onItem` callback which will be called immediately if there is already an item in the queue, or synchronously from the next `push()` call.

The promise returned from `next()` will resolve with whatever you return from `onItem`.

Use [`queue.next()`](#queuenext-promisetitem) unless you need to be notified synchronously.

### `queue.numItems()`

Returns the number of items remaining in the queue.

### `queue.reset()`

Clears the queue and rejects any pending `next()` promises with `queueResetError`.

## Example

```ts
import { InfiniteQueue } from 'infinite-queue';

const queue = InfiniteQueue<string>();

queue.push('a');
console.log('pushed 1');
setTimeout(() => {
  queue.push('b');
  queue.push('c');
  console.log('pushed 2 and 3');
}, 1000);

console.log('waiting for 1');
console.log('got 1', await queue.next()));
console.log('waiting for 2');
console.log('got 2', await queue.next()));
console.log('waiting for 3');
console.log('got 3', await queue.next()));
```

This would output:

```
pushed 1
waiting for 1
got 1 a
waiting for 2
pushed 2 and 3
got 2 b
got 3 c
```

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