Skip to content

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
rickharrison committed Apr 25, 2023
1 parent f0a9c97 commit 6a3af88
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ client.pollQueue({ VisibilityTimeout: 600 }, function (message) {

Everything is built around promises and JSON. Amazon SQS only supports message bodies as strings, but this client will transform that to and from JSON for you automatically. When polling the queue, `@meadow/sqs` expects that you return a promise. When that promise resolves, the message will automatically be deleted from the SQS queue. If the promise that you returned throws an error, the `VisibilityTimeout` of the message will be set to 0 so the queue can receive it again for re-processing.

### Constructor Options

When calling `new sqs()` you may pass in an argument of options like this: `new sqs({ visibilityTimeoutOnError: 60 })`. The available options are:

- `visibilityTimeoutOnError` - When the `pollQueue` handler throws an error, the visibility timeout of the message will be set to this value
- `preventVisibiltyTimeout` - When set to true, the visibility timeout of the message will remain unchanged after an error is thrown in the handler. This will disable the default behavior of removing the visibility timeout.

#### sendMessage(payload, [options])

- `payload` - A JSON object that will be persisted to the Amazon SQS queue.
Expand All @@ -70,7 +77,7 @@ Everything is built around promises and JSON. Amazon SQS only supports message b

#### pollQueue (options, handler)

Calling this method will long-poll the Amazon SQS queue waiting for messages to come in. For each message that is received, the handler will be called with the body of the message as a JSON object. You are required to return a promise from your handler that resolves when the work for this message is completed. After the promise resolves, `@meadow/sqs` will automatically delete the message from the SQS queue.
Calling this method will long-poll the Amazon SQS queue waiting for messages to come in. For each message that is received, the handler will be called with the body of the message as a JSON object. You are required to return a promise from your handler that resolves when the work for this message is completed. After the promise resolves, `@meadow/sqs` will automatically delete the message from the SQS queue. If an error is thrown, `@meadow/sqs` will remove the visibility timeout so that the message can be immediately re-processed. If you would like different behavior, there are two options you may pass in to the constructor to change the default.

- `options` - These options will be sent to the Amazon SQS `receiveMessage` function defined here: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html#receiveMessage-property
- `handler` - A function that returns a promise, which is meant to handle the message. The first parameter will be the message body as a JSON object. The second parameter will be the SQS message object
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@meadow/sqs",
"version": "2.1.0",
"version": "2.1.1",
"description": "Promise/JSON based client for Amazon SQS with automatic long-polling.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 6a3af88

Please sign in to comment.