Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
sqs-consumer
Advanced tools
Readme
Build SQS-based applications without the boilerplate. Just define an async function that handles the SQS message processing.
npm install sqs-consumer --save-dev
Note This library assumes you are using AWS SDK v3. If you are using v2, please install v5.8.0:
npm install sqs-consumer@5.8.0 --save-dev
import { Consumer } from 'sqs-consumer';
const app = 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();
batchSize
option detailed below.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 SQS Client client.
import { Consumer } from 'sqs-consumer';
import { SQSClient } from '@aws-sdk/client-sqs';
const app = Consumer.create({
queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
handleMessage: async (message) => {
// ...
},
sqs: new SQSClient({
region: 'my-region',
credentials: {
accessKeyId: process.env.AWS_ACCESS_KEY_ID,
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
}
})
});
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();
Consumer.create(options)
Creates a new SQS consumer.
queueUrl
- String - The SQS queue URLregion
- String - The AWS region (default eu-west-1
)handleMessage
- Function - An async
function (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 async
function (or function that returns a Promise
) to be called whenever a batch of messages is received. Similar to handleMessage
but will receive the list of messages, not each message individually. If both are set, handleMessageBatch
overrides handleMessage
.handleMessageTimeout
- Number - Time in ms to wait for handleMessage
to process a message before timing out. Emits timeout_error
on timeout. By default, if handleMessage
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 (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 visibilityTimeout
to the number of seconds since the start of the handler function. This value must less than visibilityTimeout
.terminateVisibilityTimeout
- Boolean - If true, sets the message visibility timeout to 0 after a processing_error
(defaults to false
).waitTimeSeconds
- Number - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning (defaults to 20
).authenticationErrorTimeout
- Number - The duration (in milliseconds) to wait before retrying after an authentication error (defaults to 10000
).pollingWaitTimeMs
- Number - The duration (in milliseconds) to wait before repolling the queue (defaults to 0
).sqs
- Object - An optional SQS Client object to use if you need to configure the client manuallyshouldDeleteMessages
- Boolean - Default to true
, if you don't want the package to delete messages from sqs set this to false
consumer.start()
Start polling the queue for messages.
consumer.stop()
Stop polling the queue for messages.
consumer.isRunning
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:
Event | Params | Description |
---|---|---|
error | err , [message] | Fired when an error occurs interacting with the queue. If the error correlates to a message, that message is included in Params |
processing_error | err , message | Fired when an error occurs processing the message. |
timeout_error | err , message | Fired when handleMessageTimeout is supplied as an option and if handleMessage times out. |
message_received | message | Fired when a message is received. |
message_processed | message | Fired when a message is successfully processed and removed from the queue. |
response_processed | None | Fired after one batch of items (up to batchSize ) has been successfully processed. |
stopped | None | Fired when the consumer finally stops its work. |
empty | None | Fired when the queue is empty (All messages have been consumed). |
Consumer will receive and delete messages from the SQS queue. Ensure sqs:ReceiveMessage
, sqs:DeleteMessage
, sqs:DeleteMessageBatch
, sqs:ChangeMessageVisibility
and sqs:ChangeMessageVisibilityBatch
access is granted on the queue being consumed.
See contributing guidelines.
FAQs
Build SQS-based Node applications without the boilerplate
The npm package sqs-consumer receives a total of 460,007 weekly downloads. As such, sqs-consumer popularity was classified as popular.
We found that sqs-consumer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.