https://github.com/zackees/sqs-legacy-adapter

Wraps the sqs portion of npm package "aws-sdk" using "@aws-sdk/client-sqs" on the backend
https://github.com/zackees/sqs-legacy-adapter

Last synced: about 1 month ago
JSON representation

Wraps the sqs portion of npm package "aws-sdk" using "@aws-sdk/client-sqs" on the backend

• Host: GitHub
• URL: https://github.com/zackees/sqs-legacy-adapter
• Owner: zackees
• License: apache-2.0
• Created: 2024-07-04T05:05:46.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-04T19:45:35.000Z (6 months ago)
• Last Synced: 2024-11-14T13:45:22.668Z (about 2 months ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sqs-legacy-adapter

`sqs-legacy-adapter` is a drop in replacement for `aws-sdk` which delegates to the `@aws-sdk/client-sqs` package on the backend.

This allows users to migrate to `@aws-sdk/client-sqs` while still keeping the `aws-sdk` interface for SQS access.

This is in a beta state and few methods are implemented. If you are using a dead simple access pattern then this package may work for you.

**What's Missing**

Most of the exotic options that you would pass on to `AWS.SQS({...})` are simply ignored. Basic stuff like `region`, `secretAccessKey`, `accessKeyId`, `endpoint` is implemented and tested.

Pull requests welcome.

## Installation

To install the package, use npm:

```sh

npm install sqs-legacy-adapter

```

## Usage

Here's a basic example of how to use the `sqs-legacy-adapter`:

```javascript

// const AWS = require('aws-sdk');  // this is replaced by sqs-legacy-adapter

const AWS = require('sqs-legacy-adapter');

const dotenv = require('dotenv');

dotenv.config();

async function runSqsTest() {

    const sqs = new AWS.SQS({

        apiVersion: '2012-11-05',  // Ignored right now

        region: 'us-east-1',

        accessKeyId: process.env.AWS_ACCESS_KEY_ID,

        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,

        endpoint: new AWS.Endpoint('http://localhost'),

    });

    const queueName = 'my-test-queue';

    let queueUrl;

    // Check if the queue already exists

    const listQueuesResponse = await sqs.listQueues({ QueueNamePrefix: queueName }).promise();

    if (listQueuesResponse.QueueUrls && listQueuesResponse.QueueUrls.length > 0) {

        queueUrl = listQueuesResponse.QueueUrls[0];

        console.log(`Queue already exists: ${queueUrl}`);

    } else {

        // If the queue doesn't exist, create it

        const createQueueResponse = await sqs.createQueue({ QueueName: queueName }).promise();

        queueUrl = createQueueResponse.QueueUrl;

        console.log(`Queue created: ${queueUrl}`);

    }

    await sqs.sendMessage({ QueueUrl: queueUrl, MessageBody: 'hello world' }).promise();

    console.log('Message sent');

    const receiveResponse = await sqs.receiveMessage({ QueueUrl: queueUrl, MaxNumberOfMessages: 1 }).promise();

    if (receiveResponse.Messages && receiveResponse.Messages.length > 0) {

        const message = receiveResponse.Messages[0];

        console.log('Received message:', message.Body);

        await sqs.deleteMessage({ QueueUrl: queueUrl, ReceiptHandle: message.ReceiptHandle }).promise();

        console.log('Message deleted');

    }

    await sqs.deleteQueue({ QueueUrl: queueUrl }).promise();

    console.log('Queue deleted');

}

runSqsTest().catch(console.error);

```

## API

The `AWS.SQS` class provides the following methods:

- `listQueues(params)`: Lists queues. Returns a promise that resolves to an object containing QueueUrls.

- `createQueue(params)`: Creates a new SQS queue. Returns a promise that resolves to an object containing the QueueUrl.

- `sendMessage(params)`: Sends a message to a specified queue. Returns a promise that resolves to an object containing the MessageId.

- `receiveMessage(params)`: Receives messages from a specified queue. Returns a promise that resolves to an object containing Messages.

- `deleteMessage(params)`: Deletes a specified message from a specified queue. Returns a promise that resolves when the message is deleted.

- `deleteQueue(params)`: Deletes the specified queue. Returns a promise that resolves when the queue is deleted.

All methods return objects with a `promise()` method for use with async/await.

## License

This project is licensed under the Apache License.

## Release Notes

  * 1.1.4 - Updated readme