rsmq-promise - Promise interface for RSMQ
A lightweight message queue for Node.js that requires no dedicated queue server. Just a Redis server.
Usage
- After creating a queue you can send messages to that queue.
- The messages will be handled in a FIFO (first in first out) manner unless specified with a delay.
- Every message has a unique
id
that you can use to delete the message. - The
sendMessage
method will return theid
for a sent message. - The
receiveMessage
method will return anid
along with the message and some stats. - Should you not delete the message it will be eligible to be received again after the visibility timeout is reached.
- Please have a look at the
createQueue
andreceiveMessage
methods described below for optional parameters like visibility timeout and delay.
Install
npm install --save rsmq-promise
Quickstart
const RSMQPromise = ; const rsmq = host: "127.0.0.1" port: 6379;
Parameters for RedisSMQ via an options object:
host
(String): optional (Default: "127.0.0.1") The Redis serverport
(Number): optional (Default: 6379) The Redis portoptions
(Object): optional (Default: {}) The Redis options object.client
(RedisClient): optional A existing redis client instance.host
andserver
will be ignored.ns
(String): optional (Default: "rsmq") The namespace prefix used for all keys created by RSMQrealtime
(Boolean): optional (Default: false) Enable realtime PUBLISH of new messages (see the Realtime section)
Create a Queue
rsmq ;
Send Messages
rsmq ;
Receive a message
rsmq
Delete a message
rsmq ;
List Queues
rsmq ;
Quit Connection
rsmq ;
Thanks for: Patrick Liess
More info: https://github.com/smrchy/rsmq