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 = ;const app = Consumer;app;app;appstart;
- The queue is polled continuously for messages using long 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. An SQS 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 the
batchSizeoption detailed below.
- By default, the default Node.js HTTP/HTTPS SQS agent creates a new TCP connection for every new request (AWS SQS documentation). To avoid the cost of establishing a new connection, you can reuse an existing connection by passing a new SQS instance with
const Consumer = ;const AWS = ;const app = Consumer;app;app;appstart;
By default the consumer will look for AWS credentials in the places specified 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 the AWS SQS client:
const Consumer = ;const AWS = ;AWSconfig;const app = Consumer;app;app;app;appstart;
Creates a new SQS consumer.
queueUrl- String - The SQS queue URL
region- String - The AWS region (default
handleMessage- Function - An
asyncfunction (or function that returns a
Promise) to be called whenever a message is received. Receives an SQS message object as it's first argument.
handleMessageBatch- Function - An
asyncfunction (or function that returns a
Promise) to be called whenever a batch of messages is received. Similar to
handleMessagebut will receive the list of messages, not each message individually. If both are set,
handleMessageTimeout- Number - Time in ms to wait for
handleMessageto process a message before timing out. Emits
timeout_erroron timeout. By default, if
handleMessagetimes 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.
batchSize- Number - The number of messages to request from SQS when polling (default
1). 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.
heartbeatInterval- Number - The interval (in seconds) between requests to extend the message visibility timeout. On each heartbeat the visibility is extended by adding
visibilityTimeoutto the number of seconds since the start of the handler function. This value must less than
terminateVisibilityTimeout- Boolean - If true, sets the message visibility timeout to 0 after a
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 to
pollingWaitTimeMs- Number - The duration (in milliseconds) to wait before repolling the queue (defaults to
sqs- Object - An optional AWS SQS object to use if you need to configure the client manually
Start polling the queue for messages.
Stop polling the queue for messages.
Returns the current polling state of the consumer:
true if it is actively polling,
false if it is not.
Each consumer is an
EventEmitter and emits the following events:
||Fired when an error occurs interacting with the queue. If the error correlates to a message, that error is included in Params|
||Fired when an error occurs processing the message.|
||Fired when a message is received.|
||Fired when a message is successfully processed and removed from the queue.|
||None||Fired after one batch of items (up to
||None||Fired when the consumer finally stops its work.|
||None||Fired when the queue is empty (All messages have been consumed).|
AWS IAM Permissions
Consumer will receive and delete messages from the SQS queue. Ensure
sqs:DeleteMessage access is granted on the queue being consumed.
See contributing guidelines