sqslite

SQSLite

An implementation of Amazon's Simple Queue Service (SQS). This project aims to imitate live SQS as close as possible.

What about Localstack?

Localstack was an inspiration for this project. We used Localstack for our SQS needs before this project was started. We chose to create this implementation for the following reasons:

• Decoupled from Localstack. Localstack runs many AWS service imitations and therefore builky for local development. Our goal is to have a lightweight implementation.
• Native JavaScript module. This module can be used as Command Line Interface (CLI) application or as an npm module.

---

Example

$ sqslite --help

Usage: sqslite [options]
A SQS http server

Options:
--help Display this help message and exit
--host <host>          The host to listen on (default: localhost)
--port <port> The port to listen on (default: 4567)
  Report bugs at github.com/jennyEckstein/sqslite/issues

To start the SQSLite server:

$ sqslite --port=3001

As a prerequisite to interacting with SQSLite through the command line, first install AWS CLI.

In order to create a queue, run the command shown below. Make sure to provide the same endpoint url where SQSLite server is running.

$ aws sqs create-queue --queue-name=test-queue-1 --region=us-east-1 --endpoint=http://localhost:3001

Or programmatically:

const sqslite = require('sqslite');

sqslite({}).listen(3001, (err, address) => {
  if (err) throw err;
  console.log(`server listening on ${address}`);
});

Once running, here's how to use AWS SDK to connect:

const AWS = require('aws-sdk');

const sqs = new AWS.SQS({ endpoint: 'http://localhost:3001' });
await sqs.listQueues().promise();

---

Installation

With npm do:

npm install -g sqslite

Or to install for development/testing in your project:

npm install -D sqslite

---

Supported Functions

• ChangeMessageVisibility
• CreateQueue
• DeleteMessage
• DeleteMessageBatch
• DeleteQueue
• GetQueueAttributes
• GetQueueUrl
• ListDeadLetterSourceQueues
• ListQueueTags
• ListQueues
• PurgeQueue
• ReceiveMessage
• SendMessage
• SendMessageBatch
• SetQueueAttributes
• TagQueue
• UntagQueue

---

Media

Introducing SQSLite

License

Apache-2.0

Changelog

v2.1.1 (2022-09-17)

• #601: 2.1.0
• 55914e4: Fix node versions in Github workflows