WIP
npm i @amokrushin/redis-queue- RedisQueue
- new RedisQueue(createClient, [options])
- instance
- .enqueue(payload) ⇒
Promise - .dequeue() ⇒
Promise - .cancel()
- .enqueue(payload) ⇒
- static
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<Object>
| 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. |