[![NPM Stable Version][npm-stable-version-image]][npm-url] [![Build Status][travis-master-image]][travis-url] [![Test Coverage][codecov-image]][codecov-url-master] [![Dependency Status][david-image]][david-url-master] [![Node.js Version][node-version-imag
npm install @amokrushin/redis-queue_WIP_
``bash`
npm i @amokrushin/redis-queue
* RedisQueue
* [new RedisQueue(createClient, [options])](#new+RedisQueue)
* _instance_
* .enqueue(payload) ⇒ Promise
* .dequeue() ⇒ Promise
* .cancel()
* _static_
* .serialize()
* .deserialize()
Creates a RedisQueue instance
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| createClient | function | | Function returning Redis instance. |[options.pollTimeout]
| | number | 10000 | Force subscriber to poll a queue for a new item. Timer restarts every time after new item was enqueued. |[options.notificationsChannel]
| | string | __redis-queue_notifications__ | |
Enqueue new message to a queue.
| Param | Type | Description |
| --- | --- | --- |
| payload | any | Any serializable payload. The payload is serialized using the .serialize() method. |
Dequeue message from a queue.
Returns: Promise
| Property | Type | Description |
| --- | --- | --- |
| id | string | Message identyfier |payload
| | any | The payload deserialized using the .deserialize() method. |ack
| | function | The function should be called if message processing was failed. |nack
| | function` | The function should be called if message processing was succesful. |
[npm-stable-version-image]: https://img.shields.io/npm/v/@amokrushin/redis-queue.svg
[npm-url]: https://npmjs.com/package/@amokrushin/redis-queue
[travis-master-image]: https://img.shields.io/travis/amokrushin/redis-queue/master.svg
[travis-url]: https://travis-ci.org/amokrushin/redis-queue
[codecov-image]: https://img.shields.io/codecov/c/github/amokrushin/redis-queue/master.svg
[codecov-url-master]: https://codecov.io/github/amokrushin/redis-queue?branch=master
[david-image]: https://img.shields.io/david/amokrushin/redis-queue.svg
[david-url-master]: https://david-dm.org/amokrushin/redis-queue
[node-version-image]: https://img.shields.io/node/v/@amokrushin/redis-queue.svg
[node-version-url]: https://nodejs.org/en/download/
[license-image]: https://img.shields.io/npm/l/@amokrushin/redis-queue.svg
[license-url]: https://raw.githubusercontent.com/amokrushin/redis-queue/master/LICENSE