mini sqs client using undici

!CI workflow

Description

This module allows minimal set of SQS service functions using the aws-json protocol with "undici" as http agent.

The @fgiova/aws-signature module is used for signing requests to optimize performance.

Are supported:
- sending messages
- receiving messages
- deleting messages
- changing message visibility

Installation

``bash
npm install @fgiova/mini-sqs-client
`

Usage

`typescript
import {MiniSQSClient} from '@fgiova/mini-sqs-client'
import console = require("console");

const client = new MiniSQSClient("eu-central-1");

await client.sendMessage("arn:aws:sqs:eu-central-1:000000000000:test", {
MessageBody: "Hello world",
MessageAttributes: {
"my-attribute": {
DataType: "String",
StringValue: "my-value"
}
}
});

const messages = await client.receiveMessage("arn:aws:sqs:eu-central-1:000000000000:test", {
WaitTimeSeconds: 20,
MaxNumberOfMessages: 1,
MessageAttributeNames: ["my-attribute"]
});

const message = messages[0];

await client.changeMessageVisibility("arn:aws:sqs:eu-central-1:000000000000:test", {
ReceiptHandle: message.ReceiptHandle,
VisibilityTimeout: 10
});

console.log(message.Body);

await client.deleteMessage("arn:aws:sqs:eu-central-1:000000000000:test", message.ReceiptHandle);
`

API

`typescript
MiniSQSClient(region: string, endpoint?: string, undiciOptions?: Pool.Options, signer?: Signer | SignerOptions)
MiniSQSClient.sendMessage(queueARN: string, message: SendMessage): Promise
MiniSQSClient.sendMessageBatch(queueARN: string, messages: SendMessage[]): Promise
MiniSQSClient.receiveMessage(queueARN: string, options: ReceiveMessage): Promise
MiniSQSClient.deleteMessage(queueARN: string, receiptHandle: string): Promise
MiniSQSClient.deleteMessageBatch(queueARN: string, receiptHandles: string[]): Promise
MiniSQSClient.changeMessageVisibility(queueARN: string, receiptHandle: string, visibilityTimeout: number): Promise
MiniSQSClient.changeMessageVisibilityBatch(queueARN: string, receiptHandles: string[], visibilityTimeout: number): Promise
MiniSQSClient.destroy(signer: boolean): Promise // signer destroyer default true
``

All types are defined in schemas.ts and are derived from the AWS SQS API

The main difference is that batch operations are not limited to 10 items, but accept any number of items and provide for running the batches needed to exhaust the total number of items.

License

Licensed under MIT.