mini sqs client using undici

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 (single and batch)
• receiving messages
• deleting messages (single and batch)
• changing message visibility (single and batch)

Requirements

Node.js ^22.14.0 || >= 24.10.0

Installation

npm install @fgiova/mini-sqs-client

Usage

import {MiniSQSClient} from '@fgiova/mini-sqs-client'

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 result = await client.receiveMessage("arn:aws:sqs:eu-central-1:000000000000:test", {
	WaitTimeSeconds: 20,
	MaxNumberOfMessages: 1,
	MessageAttributeNames: ["my-attribute"]
});

const message = result.Messages[0];

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

console.log(message.Body);

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

API

MiniSQSClient(region: string, endpoint?: string, undiciOptions?: Pool.Options, signer?: Signer | SignerOptions)
MiniSQSClient.sendMessage(queueARN: string, message: SendMessage): Promise<SendMessageResult>
MiniSQSClient.sendMessageBatch(queueARN: string, messages: SendMessageBatchItem[]): Promise<SendMessageBatchResult>
MiniSQSClient.receiveMessage(queueARN: string, options: ReceiveMessage): Promise<ReceiveMessageResult>
MiniSQSClient.deleteMessage(queueARN: string, receiptHandle: string): Promise<boolean>
MiniSQSClient.deleteMessageBatch(queueARN: string, receiptHandles: string[]): Promise<boolean>
MiniSQSClient.changeMessageVisibility(queueARN: string, receiptHandle: string, visibilityTimeout: number): Promise<boolean>
MiniSQSClient.changeMessageVisibilityBatch(queueARN: string, receiptHandles: string[], visibilityTimeout: number): Promise<boolean>
MiniSQSClient.destroy(signer?: boolean): Promise<any[]>

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.