power-sqs

power-sqs

Power-SQS is a set of powerful functions to deal with AWS SQS. It includes stream to read messages, move messages from one SQS to another or to a persistent data store.

If you just want to use sink operations, there is an option availble to use them via cli. Please see power-sqs-cli

How to install

npm install power-sqs

yarn add power-sqs

How To Use

Power SQS provides following functions to deal with AWS SQS

Reader

getSQSReader

Returns a readable stream of messages with long polling of 10 seconds. The object mode is enabled in the stream and pushes single message across the pipe.

const {getSQSReader} = require("power-sqs");

const config = {"url": "your sqs url"};
const sqsReader = getSQSReader(config);

// returns a Node.js readable stream.

sqsReader.pipe("stream of your choice.")

getSQSPowerReader

Returns a highland stream. The stream can then be used to apply transformers like filter, map, find and etc to generate a stream of data before piping it to another stream.

Please see highland transformers for more information.

const {getSQSPowerReader} = require("power-sqs");

const config = {"url": "your sqs url"};
const sqsReader = getSQSPowerReader(config);

// returns a Node.js readable stream.

sqsReader.filter(() => {
  // filter logic
}).pipe("stream of your choice");

getSQSBulkReader

Returns a readable stream of messages with long polling of 10 seconds. The object mode is enabled in the stream and returns the complete data object returned from the AWS.

The messgages in the pushed chunk can be accessed via the the Messages. It only pushes the data if it has any number of Messages attached to it otherwise it will keep on polling the SQS.

const {getSQSBulkReader} = require("power-sqs");

const config = {"url": "your sqs url"};
const sqsReader = getSQSBulkReader(config);

// returns a Node.js readable stream.

sqsReader.pipe("stream of your choice.")

DeleteMessages

Allows you to delete the messages in batch

const {deleteMessages} = require("power-sqs");

const queueUrl = "your sqs url";
const messages = [{}] // array of messages you want to delete

return deleteMessages(queueUrl, messages)
.then(res => console.log(res));

SendMessages

Allows you to send the messages in batch

const {sendMessages} = require("power-sqs");

const queueUrl = "your sqs url";
const messages = [{"foo": "bar"}] // data you want to send as messages

return sendMessages(queueUrl, messages)
.then(res => console.log(res));

SendFifoMessages

Allows you to send the messages in batch

const {sendFifoMessages} = require("power-sqs");

const queueUrl = "your sqs url";
const group = "groupid";
const messages = [{"foo": "bar"}] // data you want to send as messages

return sendFifoMessages(queueUrl, group, messages)
.then(res => console.log(res));

receiveMessages

Allows you to receive the messages from a sqs. If you are looking for something to poll continuously, have a look at other reader functions which provide streaming and filtering options too.

const {sendMessages} = require("power-sqs");

const queueUrl = "your sqs url";

return receiveMessages(queueUrl)
.then(res => console.log(res));

Sink

initSinkToSQS

Allows you to move messages from one SQS to another in same AWS Account.

const {initSinkToSQS} = require("power-sqs");

const source = {"url": "your sqs url"};
const destination = {"url": "your sqs url"};
const config = {source, destination};

initSinkToSQS(config);

Examples

some of the examples related to specifically single operations like sendMessages, deleteMessages etc are provided in examples directory.

Support or Contact

Having trouble with power-sqs or have any questions? Please raise an issue.