# sqs-reader

> AWS SQS queue reader for Typescript

Latest version **1.2.0** (published 2022-08-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install sqs-reader
pnpm add sqs-reader
yarn add sqs-reader
bun add sqs-reader
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2022-08-25 |
| First published | 2021-03-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Trevor Robinson |
| Maintainers | trevorr |
| Keywords | sqs, aws, queue, typescript |

## Links

- npm: https://www.npmjs.com/package/sqs-reader
- Repository: https://github.com/trevorr/sqs-reader
- Homepage: https://github.com/trevorr/sqs-reader#readme
- Issues: https://github.com/trevorr/sqs-reader/issues
- npm.io page: https://npm.io/package/sqs-reader

## Dependencies (1)

- [sleep-cancel](https://npm.io/package/sleep-cancel.md) ^1.0.0

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2022-08-25
- 1.1.0 — 2022-01-26
- 1.0.0 — 2021-03-18

## README

# sqs-reader: AWS SQS queue reader for Typescript

[![npm](https://img.shields.io/npm/v/sqs-reader)](https://www.npmjs.com/package/sqs-reader)
[![CircleCI](https://img.shields.io/circleci/build/github/trevorr/sqs-reader)](https://circleci.com/gh/trevorr/sqs-reader)
[![Coverage Status](https://coveralls.io/repos/github/trevorr/sqs-reader/badge.svg?branch=master)](https://coveralls.io/github/trevorr/sqs-reader?branch=master)

A small, simple, robust asynchronous queue reader for [Amazon Simple Queue Service (SQS)](https://aws.amazon.com/sqs/) written in Typescript.

## Features

* Configurable exponential delay between empty receive attempts to limit polling costs when idle
* Can force polling to resume during idle delay
* Supports immediate abort of receive/delay for graceful shutdown
* Abstract logging mechanism uses console by default but can easily use frameworks like [Winston](https://github.com/winstonjs/winston)

## Installation

```sh
npm install sqs-reader
```

## Usage

```ts
import { SQSReader } from 'sqs-reader';

const { AWS_SQS_QUEUE_URL } = process.env;

if (!AWS_SQS_QUEUE_URL) {
  throw new Error('AWS_SQS_QUEUE_URL is not configured');
}

const queueReader = new SQSReader(AWS_SQS_QUEUE_URL, async (message) => {
  console.log('Received message', message.MessageId);
});

let shuttingDown = false;

async function shutDown(): Promise<void> {
  if (!shuttingDown) {
    shuttingDown = true;
    console.info('Shutting down...');
    setTimeout((): void => {
      console.warn('Timed out waiting for shutdown');
      process.exit(1);
    }, 30000);
    try {
      queueReader.stop();
      await queueReader.join();
    } catch (err) {
      console.warn('Error in queue reader:', err);
    }
    process.exit(0);
  }
}

process.on('SIGINT', shutDown);
process.on('SIGTERM', shutDown);

(async function () {
  queueReader.start();
  await queueReader.join();
  shutDown();
})();

```

## License

`sqs-reader` is available under the [ISC license](LICENSE).

---
_Source: https://npm.io/package/sqs-reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
