sqs-consumer 6.0.2 → 6.2.0

package/.github/CONTRIBUTING.md

@@ -34,6 +34,16 @@ Follow the setup instructions in the [README](../README.md).
 
 Ensure all your code is thoroughly tested and that this testing is detailed in the pull request.
 
+## Contributors Licence Agreement
+
+In order to accept contributions, we need all contributors grant Us a licence to the intellectual
+property rights in their Contributions. This Agreement (“Agreement”) is intended to protect your
+rights as a contributor, and to help ensure that the intellectual property contained
+within is available to the whole community, to use and build on.
+
+When you raise a pull request and you haven't previously signed a CLA, the bot will automatically
+ask you to do this. You must complete this step in order for your PR to be merged.
+
 ## Pull Request Process
 
 1. Make sure you have opened an issue and it was approved by a project maintainer before working on a PR

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,115 @@
+name: 'Bug report'
+title: "[Bug]: "
+labels: ["bug", "triage"]
+description: Report a reproducible bug or regression
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue!
+
+        This issue tracker is for reporting reproducible bugs or regression's found in this package, if you have a question or feature request, please report it within the [Discussions tab](https://github.com/bbc/sqs-consumer/discussions) instead.
+
+        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
+
+         - [Discussions](https://github.com/bbc/sqs-consumer/discussions)
+         - [Open Issues](https://github.com/bbc/sqs-consumer/issues?q=is%3Aopen+is%3Aissue)
+         - [Closed Issues](https://github.com/bbc/sqs-consumer/issues?q=is%3Aissue+is%3Aclosed)
+
+        The more information you fill in, the better the community can help you.
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: Your minimal, reproducible example
+      description: |
+        Please add a link to a minimal reproduction.
+        Note:
+        - Please keep your example as simple and reproduceable as possible, try leaving out dependencies that are not required for reproduction.
+        - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
+        - Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
+      placeholder: |
+        e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Describe the steps we have to take to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: Provide a clear and concise description of what you expected to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but i am seeing ___
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: How often does this bug happen?
+      description: |
+        Following the repro steps above, how easily are you able to reproduce this bug?
+      options:
+        - Every time
+        - Often
+        - Sometimes
+        - Only once
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓
+  - type: textarea
+    id: platform
+    attributes:
+      label: Platform
+      description: |
+        Please let us know which Operating System and Node version you were using when the issue occurred.
+      placeholder: |
+        - OS: [e.g. macOS, Windows, Linux, iOS, Android]
+        - Node Version: [e.g. 16.6.0]
+    validations:
+      required: true
+  - type: input
+    id: package-version
+    attributes:
+      label: Package version
+      description: |
+        Please let us know the exact version of the package you were using when the issue occurred. Please don't just put in "latest", as this is subject to change.
+      placeholder: |
+        e.g. v6.0.0
+    validations:
+      required: true
+  - type: input
+    id: ts-version
+    attributes:
+      label: AWS SDK version
+      description: |
+        Please include what version of the AWS SDK you are using
+      placeholder: |
+        e.g. v3.226.0
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Feature Requests & Questions
+    url: https://github.com/bbc/sqs-consumer/discussions
+    about: Please ask and answer questions here.

package/.github/workflows/cla.yml

@@ -0,0 +1,25 @@
+name: "CLA Check"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Check"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: 'sqs-consumer/v1/cla.json'
+          remote-organization-name: 'bbc'
+          remote-repository-name: 'cla-signatures'
+          path-to-document: 'https://bbc.github.io/cla-signatures/cla/v1/cla.html'
+          branch: 'main'
+          allowlist: bot*
+          custom-allsigned-prcomment: '**CLA CHECK** All Contributors have signed the CLA'

package/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '43 21 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

package/.github/workflows/coverage.yml

@@ -30,6 +30,6 @@ jobs:
       - name: Report Coverage
         uses: paambaati/codeclimate-action@v3.2.0
         env:
-          CC_TEST_REPORTER_ID: 2d851f8f3a9348ac4f43262305037f80a730c2660fda50af8ae4d445fd89333b
+          CC_TEST_REPORTER_ID: 760097cb88b4c685dce427cf94a8e12a5f082774d06b4f4f5daef839ffc07821
         with:
           coverageCommand: npm run lcov

package/.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install Node Modules
+        run: npm ci
+
+      - name: Build Docs
+        run: npm run generate-docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './public'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

package/.prettierignore

@@ -1,4 +1,5 @@
 node_modules
 coverage
 bake-scripts
-dist
+dist
+public

package/README.md

@@ -2,15 +2,17 @@
 
 [![NPM downloads](https://img.shields.io/npm/dm/sqs-consumer.svg?style=flat)](https://npmjs.org/package/sqs-consumer)
 [![Build Status](https://github.com/bbc/sqs-consumer/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bbc/sqs-consumer/actions/workflows/test.yml)
-[![Code Climate](https://codeclimate.com/github/BBC/sqs-consumer/badges/gpa.svg)](https://codeclimate.com/github/BBC/sqs-consumer)
-[![Test Coverage](https://codeclimate.com/github/BBC/sqs-consumer/badges/coverage.svg)](https://codeclimate.com/github/BBC/sqs-consumer)
+[![Maintainability](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/maintainability)](https://codeclimate.com/github/bbc/sqs-consumer/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/16ec3f59e73bc898b7ff/test_coverage)](https://codeclimate.com/github/bbc/sqs-consumer/test_coverage)
 
 Build SQS-based applications without the boilerplate. Just define an async function that handles the SQS message processing.
 
 ## Installation
 
+To install this package, simply enter the following command into your terminal (or the variant of whatever package manager you are using):
+
 ```bash
-npm install sqs-consumer --save-dev
+npm install --save-dev sqs-consumer
 ```
 
 > **Note**
@@ -43,14 +45,16 @@ app.on('processing_error', (err) => {
 app.start();
 ```
 
-- The queue is polled continuously for messages using [long polling](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html).
+- The queue is polled continuously for messages using [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html).
 - Messages are deleted from the queue once the handler function has completed successfully.
-- Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An [SQS redrive policy](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html) can be used to move messages that cannot be processed to a dead letter queue.
+- Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An [SQS redrive policy](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html) can be used to move messages that cannot be processed to a dead letter queue.
 - By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the `batchSize` option [detailed below](#options).
 
+You can also find some examples of sqs-consumer implemented in various ways within the [examples directory](./examples/).
+
 ### Credentials
 
-By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
+By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](https://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
 
 ```bash
 export AWS_SECRET_ACCESS_KEY=...
@@ -92,30 +96,15 @@ app.on('timeout_error', (err) => {
 app.start();
 ```
 
+### AWS IAM Permissions
+
+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.
+
 ## API
 
 ### `Consumer.create(options)`
 
-Creates a new SQS consumer.
-
-#### Options
-
-- `queueUrl` - _String_ - The SQS queue URL
-- `region` - _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](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) object to use if you need to configure the client manually
-- `shouldDeleteMessages` - _Boolean_ - Default to `true`, if you don't want the package to delete messages from sqs set this to `false`
+Creates a new SQS consumer using the [defined options](https://bbc.github.io/sqs-consumer/interfaces/ConsumerOptions.html).
 
 ### `consumer.start()`
 
@@ -123,7 +112,7 @@ Start polling the queue for messages.
 
 ### `consumer.stop()`
 
-Stop polling the queue for messages.
+Stop polling the queue for messages (pre existing requests will still be made until concluded).
 
 ### `consumer.isRunning`
 
@@ -131,23 +120,14 @@ Returns the current polling state of the consumer: `true` if it is actively poll
 
 ### Events
 
-Each consumer is an [`EventEmitter`](http://nodejs.org/api/events.html) and emits the following events:
+Each consumer is an [`EventEmitter`](https://nodejs.org/api/events.html) and [emits these events](https://bbc.github.io/sqs-consumer/interfaces/Events.html).
 
-| 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).                                                                |
+## Contributing
 
-### AWS IAM Permissions
+We welcome and appreciate contributions for anyone who would like to take the time to fix a bug or implement a new feature.
 
-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.
+But before you get started, [please read the contributing guidelines](https://github.com/bbc/sqs-consumer/blob/main/.github/CONTRIBUTING.md) and [code of conduct](https://github.com/bbc/sqs-consumer/blob/main/.github/CODE_OF_CONDUCT.md).
 
-### Contributing
+## License
 
-See contributing [guidelines](https://github.com/bbc/sqs-consumer/blob/main/.github/CONTRIBUTING.md).
+SQS Consumer is distributed under the Apache License, Version 2.0, see [LICENSE](https://github.com/bbc/sqs-consumer/blob/main/LICENSE) for more information.

package/dist/bind.d.ts

@@ -1 +1,5 @@
+/**
+ * Auto binds the provided properties
+ * @param obj an object containing the available properties
+ */
 export declare function autoBind(obj: object): void;

package/dist/bind.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.autoBind = void 0;
+/**
+ * Determines if the property is a method
+ * @param propertyName the name of the property
+ * @param value the value of the property
+ */
 function isMethod(propertyName, value) {
     return propertyName !== 'constructor' && typeof value === 'function';
 }
+/**
+ * Auto binds the provided properties
+ * @param obj an object containing the available properties
+ */
 function autoBind(obj) {
     const propertyNames = Object.getOwnPropertyNames(obj.constructor.prototype);
     propertyNames.forEach((propertyName) => {

package/dist/consumer.d.ts

@@ -1,72 +1,111 @@
-/// <reference types="node" />
-import { SQSClient, Message } from '@aws-sdk/client-sqs';
-import { EventEmitter } from 'events';
-export interface ConsumerOptions {
-    queueUrl?: string;
-    attributeNames?: string[];
-    messageAttributeNames?: string[];
-    stopped?: boolean;
-    batchSize?: number;
-    visibilityTimeout?: number;
-    waitTimeSeconds?: number;
-    authenticationErrorTimeout?: number;
-    pollingWaitTimeMs?: number;
-    terminateVisibilityTimeout?: boolean;
-    heartbeatInterval?: number;
-    sqs?: SQSClient;
-    region?: string;
-    handleMessageTimeout?: number;
-    shouldDeleteMessages?: boolean;
-    handleMessage?(message: Message): Promise<void>;
-    handleMessageBatch?(messages: Message[]): Promise<void>;
-}
-interface Events {
-    response_processed: [];
-    empty: [];
-    message_received: [Message];
-    message_processed: [Message];
-    error: [Error, void | Message | Message[]];
-    timeout_error: [Error, Message];
-    processing_error: [Error, Message];
-    stopped: [];
-}
-export declare class Consumer extends EventEmitter {
+import { ConsumerOptions, TypedEventEmitter } from './types';
+/**
+ * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
+ */
+export declare class Consumer extends TypedEventEmitter {
+    private pollingTimeoutId;
+    private heartbeatTimeoutId;
+    private handleMessageTimeoutId;
+    private stopped;
     private queueUrl;
     private handleMessage;
     private handleMessageBatch;
+    private sqs;
     private handleMessageTimeout;
     private attributeNames;
     private messageAttributeNames;
-    private stopped;
+    private shouldDeleteMessages;
     private batchSize;
     private visibilityTimeout;
+    private terminateVisibilityTimeout;
     private waitTimeSeconds;
     private authenticationErrorTimeout;
     private pollingWaitTimeMs;
-    private terminateVisibilityTimeout;
     private heartbeatInterval;
-    private sqs;
-    private shouldDeleteMessages;
     constructor(options: ConsumerOptions);
-    emit<T extends keyof Events>(event: T, ...args: Events[T]): boolean;
-    on<T extends keyof Events>(event: T, listener: (...args: Events[T]) => void): this;
-    once<T extends keyof Events>(event: T, listener: (...args: Events[T]) => void): this;
-    get isRunning(): boolean;
+    /**
+     * Creates a new SQS consumer.
+     */
     static create(options: ConsumerOptions): Consumer;
+    /**
+     * Start polling the queue for messages.
+     */
     start(): void;
+    /**
+     * Stop polling the queue for messages (pre existing requests will still be made until concluded).
+     */
     stop(): void;
-    private handleSqsResponse;
-    private processMessage;
-    private receiveMessage;
-    private deleteMessage;
-    private executeHandler;
-    private changeVisibilityTimeout;
+    /**
+     * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+     */
+    get isRunning(): boolean;
+    /**
+     * Emit one of the consumer's error events depending on the error received.
+     * @param err The error object to forward on
+     * @param message The message that the error occurred on
+     */
     private emitError;
+    /**
+     * Poll for new messages from SQS
+     */
     private poll;
+    /**
+     * Send a request to SQS to retrieve messages
+     * @param params The required params to receive messages from SQS
+     */
+    private receiveMessage;
+    /**
+     * Handles the response from AWS SQS, determining if we should proceed to
+     * the message handler.
+     * @param response The output from AWS SQS
+     */
+    private handleSqsResponse;
+    /**
+     * Process a message that has been received from SQS. This will execute the message
+     * handler and delete the message once complete.
+     * @param message The message that was delivered from SQS
+     */
+    private processMessage;
+    /**
+     * Process a batch of messages from the SQS queue.
+     * @param messages The messages that were delivered from SQS
+     */
     private processMessageBatch;
-    private deleteMessageBatch;
-    private executeBatchHandler;
-    private changeVisibilityTimeoutBatch;
+    /**
+     * Trigger a function on a set interval
+     * @param heartbeatFn The function that should be triggered
+     */
     private startHeartbeat;
+    /**
+     * Change the visibility timeout on a message
+     * @param message The message to change the value of
+     * @param timeout The new timeout that should be set
+     */
+    private changeVisibilityTimeout;
+    /**
+     * Change the visibility timeout on a batch of messages
+     * @param messages The messages to change the value of
+     * @param timeout The new timeout that should be set
+     */
+    private changeVisibilityTimeoutBatch;
+    /**
+     * Trigger the applications handleMessage function
+     * @param message The message that was received from SQS
+     */
+    private executeHandler;
+    /**
+     * Execute the application's message batch handler
+     * @param messages The messages that should be forwarded from the SQS queue
+     */
+    private executeBatchHandler;
+    /**
+     * Delete a single message from SQS
+     * @param message The message to delete from the SQS queue
+     */
+    private deleteMessage;
+    /**
+     * Delete a batch of messages from the SQS queue.
+     * @param messages The messages that should be deleted from SQS
+     */
+    private deleteMessageBatch;
 }
-export {};