Repository files navigation

Build SQS-based applications without the boilerplate. Just define an async function that handles the SQS message processing.

npm install sqs-consumer --save

const{ Consumer}=require('sqs-consumer');constapp=Consumer.create({queueUrl:'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',handleMessage:async(message)=>{// do some work with `message`}});app.on('error',(err)=>{console.error(err.message);});app.on('processing_error',(err)=>{console.error(err.message);});app.start();

• The queue is polled continuously for messages usinglong polling.
• Messages are deleted from the queue once the handler function has completed successfully.
• Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. AnSQS redrive policy can be used to move messages that cannot be processed to a dead letter queue.
• By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use thebatchSize optiondetailed below.

By default the consumer will look for AWS credentials in the placesspecified by the AWS SDK. The simplest option is to export your credentials as environment variables:

export AWS_SECRET_ACCESS_KEY=...export AWS_ACCESS_KEY_ID=...

If you need to specify your credentials manually, you can use a pre-configured instance of theAWS SQS client:

constConsumer=require('sqs-consumer');constAWS=require('aws-sdk');AWS.config.update({region:'eu-west-1',accessKeyId:'...',secretAccessKey:'...'});constapp=Consumer.create({queueUrl:'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',handleMessage:async(message)=>{// ...},sqs:newAWS.SQS()});app.on('error',(err)=>{console.error(err.message);});app.on('processing_error',(err)=>{console.error(err.message);});app.on('timeout_error',(err)=>{console.error(err.message);});app.start();

Creates a new SQS consumer.

• queueUrl -String - The SQS queue URL
• region -String - The AWS region (defaulteu-west-1)
• handleMessage -Function - Anasync function (or function that returns aPromise) to be called whenever a message is received. Receives an SQS message object as it's first argument.
• handleMessageTimeout -String - Time in ms to wait forhandleMessage to process a message before timing out. Emitstimeout_error on timeout. By default, ifhandleMessage times out, the unprocessed message returns to the end of the queue.
• attributeNames -Array - List of queue attributes to retrieve (i.e.['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']).
• messageAttributeNames -Array - List of message attributes to retrieve (i.e.['name', 'address']).
• batchSize -Number - The number of messages to request from SQS when polling (default1). This cannot be higher than the AWS limit of 10.
• visibilityTimeout -Number - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
• terminateVisibilityTimeout -Boolean - If true, sets the message visibility timeout to 0 after aprocessing_error (defaults tofalse).
• waitTimeSeconds -Number - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning.
• authenticationErrorTimeout -Number - The duration (in milliseconds) to wait before retrying after an authentication error (defaults to10000).
• sqs -Object - An optionalAWS SQS object to use if you need to configure the client manually

Start polling the queue for messages.

Stop polling the queue for messages.

Each consumer is anEventEmitter and emits the following events:

Consumer will receive and delete messages from the SQS queue. Ensuresqs:ReceiveMessage andsqs:DeleteMessage access is granted on the queue being consumed.

See contributingguildlines