Skip to content

Commit

Permalink
Adds README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rick Harrison committed Jul 20, 2016
1 parent 933ccbf commit 0c88498
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# @meadow/sqs

[![Build Status](https://circleci.com/gh/meadow/sqs.svg?style=shield)](https://circleci.com/gh/meadow/sqs)
[![codecov.io](https://codecov.io/github/meadow/sqs/coverage.svg?branch=master&precision=2)](https://codecov.io/github/meadow/sqs?branch=master)
[![npm](https://img.shields.io/npm/v/@meadow/sqs.svg)](https://www.npmjs.com/package/@meadow/sqs)

Promise/JSON based client for Amazon SQS with automatic long-polling.

- Requires node v6.x

## Installation

```js
npm install @meadow/sqs --save
```

## Usage

Create a client:

```js
const sqs = require('@meadow/sqs');

const client = new sqs({
region: 'us-west-2',
accessKeyId: 'AKFOOBAR',
secretAccessKey: 'barbaz',
queue: 'https://sqs.us-west-2.amazonaws.com/foobar/barbaz'
});
```

Send a message:

```js
client.sendMessage({
type: 'ACTION_TYPE',
payload: {
foo: 'bar'
}
});
```

Long poll the queue for messages:

```js
client.pollQueue({ VisibilityTimeout: 600 }, function (message) {
console.log(message);

return new Promise(function (resolve) {
// Perform the work for this message

resolve();
});
});
```

## API

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.

#### sendMessage(payload)

- `payload` - A JSON object that will be persisted to the Amazon SQS queue.

#### 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.

- `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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@meadow/sqs",
"version": "1.0.0",
"description": "Client for Amazon SQS with built-in long polling.",
"description": "Promise/JSON based client for Amazon SQS with automatic long-polling.",
"main": "index.js",
"scripts": {
"cover": "nyc ava",
Expand Down

0 comments on commit 0c88498

Please sign in to comment.