Yet Another SQS Client for Nodejs.
- Message Acknowledgement
- Event Interface
- Configurable Polling Interval
- Async Message Delivery
npm install sqs.js --savevar sqs = require('sqs.js');
var reader = sqs.reader({
accessKeyId: 'somekey',
secretAccessKey: 'secretKey',
region: 'us-east-1',
queueUrl: 'someQueueUrl',
startPolling: true
});
reader.on('error', function(err) {
console.error(err);
});
reader.on('message', function(msg) {
console.log(Received %s, msg.Body);
msg.ack();
});
var writer = sqs.writer({
accessKeyId: 'somekey',
secretAccessKey: 'secretKey',
region: 'us-east-1',
queueUrl: 'someQueueUrl'
});
writer.publish({MessageBody: '{"id": 1}'});Required fields:
accessKeyIdAWS AccessKeyId credentialsecretAccessKeyAWS secretAccessKey credentialregionAWS regionqueueUrlAWS SQS URL
Optional fields:
versionapiVersion (latest)visibilityVisibilityTimeoutpollIntervalHow often SQS is polled (1000)pollingSizeHow many messages should each request receive (10)startPollingAutomatically start polling
Emits the following events:
message(msg) received messageerror(err) error received by polling AWS
Fetches messages from the queue.
Calls .receiveMessage() continuously.
Stops polling messages.
Messages default properties are described here.
Messages which shouldn't be delivered anymore should be removed from SQS. Invoke #ack to delete the message. An optional callback can be provided which receives (err, data) as parameters.
Required fields:
accessKeyIdAWS AccessKeyId credentialsecretAccessKeyAWS secretAccessKey credentialregionAWS regionqueueUrlAWS SQS URL
Emits the following events:
error(err) error received by submitting to AWS
Required fields in msg:
MessageBody(String)
Optional parameter:
fnwill be called with(err, data)
msgsis an array of messages (can't bigger than 10)
Required fields in msg:
MessageBody(String)
Optional parameter:
fnwill be called with(err, data)
Async Delivery method. Every 10th emit, publishBatch will be invoked with the first 10 messages stored.
Required fields in msg:
MessageBody(String)
- Make publish interface simpler (less AWSish)
- Return callbacks and Promises
MIT