Create a Readable Node.JS stream from an Amazon Simple Queue Service (AWS SQS) queue.
By default it will carry on waiting for items on the queue forever, it will retry on errors and backpreasure is handled appropriately.
npm install --save sqs-readable-stream
var AWS = ;var SQSReadableStream = ;var sqs =apiVersion: '2012-11-05'region: 'us-east-1'accessKeyId: 'YOUR AMAZON ACCESS KEY';var sqsStream =sqsClient: thissqsClientqueueUrl: queueUrl;sqsStream
The messages passed through the stream are as returned from aws-sdk
with the addition of a
deleteMessage method which can be used as a
shortcut to delete the message from the queue.
The following options can be passed into the constructor.
sqsClient(required) :: An instance of the SQS class from the AWS SDK (or something else that acts like one)
queueUrl(required) :: The URL of the SQS Queue to read from
receiveMessageOptions:: Options to pass into the calls to receiveMessage. Defaults to:
AttributeNames: 'All'MaxNumberOfMessages: 10WaitTimeSeconds: 20
retryOnErrors(default: true) :: Controls whether it will retry after receiving errors from SQS.
initialBackoff(default: 100) :: Time (ms) to wait for first retry (will increase by doubling for each consecutive error)
maxBackoff(default: 15000) :: Maximum time (ms) to wait for a retry
stopOnQueueEmpty(default: false) :: Controls whether it will stop (eg emit and
endevent and stop requesting new messages) when the Queue is empty. The default behaviour is to wait for new items forever.