Merge pull request #4 from Sagacify/feature/streams

Streams

README.md

@@ -98,6 +98,64 @@ await sqsHandler.destroyBatch([
 ]);
 ```
 
+### Readable Stream Usage
+
+```js
+const AWS = require('aws-sdk');
+const { SqsHandler } = require('@sagacify/sqs-handler');
+
+const sqsInstance = new AWS.SQS({
+    accessKeyId: 'your_access_key_id',
+    secretAccessKey: 'your_secret_access_key',
+    region: 'an_aws_region'
+})
+
+const sqsHandler = new SqsHandler(
+  sqsInstance,
+  'https://sqs.eu-west-1.amazonaws.com/23452042942/some-sqs-queue', {
+    VisibilityTimeout: 120,
+    WaitTimeSeconds: 0
+  }
+);
+
+const readable = sqsHandler.readableStream();
+
+readable.on('data', (message) => {
+  console.log(message);
+  sqsHandler.destroy(message.receiptHandle);
+});
+
+const autoDestroyReadable = sqsHandeler.readableStream({ autoDestroy: true });
+autoDestroyReadable.on('data', (message) => console.log(message));
+```
+
+### Writable Stream Usage
+
+```js
+const AWS = require('aws-sdk');
+const { SqsHandler } = require('@sagacify/sqs-handler');
+
+const sqsInstance = new AWS.SQS({
+    accessKeyId: 'your_access_key_id',
+    secretAccessKey: 'your_secret_access_key',
+    region: 'an_aws_region'
+})
+
+const sqsHandler = new SqsHandler(
+  sqsInstance,
+  'https://sqs.eu-west-1.amazonaws.com/23452042942/some-sqs-queue', {
+    VisibilityTimeout: 120,
+    WaitTimeSeconds: 0
+  }
+);
+
+const writable = sqsHandler.writableStream();
+
+writable.write({
+  { data: 'value' }
+});
+```
+
 ### API
 
 **constructor(sqs, queueUrl, options)**
@@ -208,6 +266,25 @@ Equivalent of [AWS.SQS.deleteMessageBatch](https://docs.aws.amazon.com/AWSJavaSc
 Only message related operations have been implemented.
 For queue related operations use directly the SQS instance.
 
+**readableStream(options)**
+
+returns a readable stream from the SQS queue.
+Each message received from the queue will trigger the `data` event.
+
+*Options:*
+
+- autoDestroy: automatically destroy received message from the queue once pushed to the stream buffer, if set to false you will have to destroy the message yourself otherwise it will be available to be consumed after the *visibilityTimeout* (default: false)
+- autoClose: automatically close the stream when no more message are received from the queue (default: false)
+
+see **receive** for other options details.
+
+**writableStream(options)**
+
+returns a writable stream to the SQS queue.
+Each message written to this stream will be pushed to the queue with the specified options.
+
+see **send** for options details.
+
 ## Npm scripts
 
 ### Running code formating