# shape-of-q

> A simple and fast redis based queue

Latest version **0.3.0** (published 2018-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install shape-of-q
pnpm add shape-of-q
yarn add shape-of-q
bun add shape-of-q
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2018-04-10 |
| First published | 2018-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tomas Della Vedova - @delvedor |
| Maintainers | delvedor, ninjatux |
| Keywords | redis, queue, speed, simple, fifo, lifo |

## Links

- npm: https://www.npmjs.com/package/shape-of-q
- Repository: https://github.com/delvedor/shape-of-q
- Homepage: https://github.com/delvedor/shape-of-q#readme
- Issues: https://github.com/delvedor/shape-of-q/issues
- npm.io page: https://npm.io/package/shape-of-q

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [ioredis](https://npm.io/package/ioredis.md) ^3.2.2

## Recent versions

- 0.3.0 (latest) — 2018-04-10
- 0.2.0 — 2018-04-05
- 0.1.0 — 2018-04-04
- 0.0.1 — 2018-04-04

## README

# shape-of-q

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)  [![Build Status](https://travis-ci.org/delvedor/shape-of-q.svg?branch=master)](https://travis-ci.org/delvedor/shape-of-q)

A simple and fast redis based queue, supports both *fifo* and *lifo*.

## Install

```bash
npm i shape-of-q
```

## Usage

```js
const q = require('shape-of-q')('myqueue')
q.on('error', console.log)

// push a new message
q.push('hello')

q.pull({ polling: true }, (msg, done) => {
  console.log(msg)
  done()
})
```

Async await is supported as well!

```js
q.pull({ polling: true }, async msg => {
  console.log(msg)
})
```

## API

### Constructor

Create a new queue, the queue name parameter is mandatory.

Options:

```js
const q = require('shape-of-q')('myqueue', {
  encoding: 'json', // default: null
  type: 'lifo', // default: 'fifo'
  client: Object, // custom redis client
  host: '127.0.0.1' // redis host for the internal client,
  encoder: msgpack.encode, // default null
  decoder: msgpack.decode, // default null
  binaryData: true // default false
})
```

`shape-of-q` is an event emitter and you should listen for the `error` event.

If you are working with objects and want to speed up the serialization you can use the `encoder` and `decoder` option, both of them must be sync functions.<br>
If the `encoder` produces binary data make sure to pass `{ binaryData: true }` as option.

#### `push`

Add a new message to the queue.

If the encoding has been set to `'json'` you can pass plain objects.

```js
q.push('hello')
```

#### `pull`

Retrieve a single message from the queue.

To enable polling, pass `{ polling: true }` as option and `pollingInterval` if you want to customize the interval (must be expressed in seconds).<br>
The api supports both classic callbacks and async await.

```js
// callbacks
q.pull({ polling: true }, (msg, done) => {
  console.log(msg)
  done()
})

// async-await
q.pull({ polling: true }, async msg => {
  console.log(msg)
})
```

If you pass an error to `done` or return an error in the async version the message will be put back in the queue.

#### `list`

Get all elements in the queue.

```js
q.list((err, msg) => {
  console.log(msg)
})
```

#### `stop`

Stops the polling and closes the connection to redis.

```js
q.stop()
```

#### `flush`

Flushes a queue removing all its elements.

```js
q.flush((err) => {
  if (err) console.log(err)
})
```

## License

MIT

Copyright © 2018 Tomas Della Vedova

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