@probitas/client-sqs

Basic usage with existing queue

import { createSqsClient } from "@probitas/client-sqs";

async function example() {
  const sqs = await createSqsClient({
    region: "ap-northeast-1",
    queueUrl: "https://sqs.ap-northeast-1.amazonaws.com/123456789/my-queue",
    credentials: { accessKeyId: "test", secretAccessKey: "test" },
  });

  // Send a message
  const sendResult = await sqs.send(JSON.stringify({
    type: "ORDER",
    orderId: "123",
  }));

  if (sendResult.ok) {
    console.log("Message ID:", sendResult.messageId);
  } else {
    console.error("Error:", sendResult.error.message);
  }

  await sqs.close();
}

Using LocalStack for local development

import { createSqsClient } from "@probitas/client-sqs";

async function example() {
  const sqs = await createSqsClient({
    region: "us-east-1",
    url: "http://localhost:4566",
    credentials: {
      accessKeyId: "test",
      secretAccessKey: "test",
    },
  });

  // Create queue dynamically (also sets queueUrl)
  const result = await sqs.ensureQueue("test-queue");
  if (result.ok) {
    console.log(result.queueUrl);  // http://localhost:4566/000000000000/test-queue
  }

  await sqs.close();
}

Receiving messages with long polling

import { createSqsClient } from "@probitas/client-sqs";

async function example() {
  const sqs = await createSqsClient({
    region: "us-east-1",
    url: "http://localhost:4566",
    credentials: { accessKeyId: "test", secretAccessKey: "test" },
  });
  await sqs.ensureQueue("test-queue");

  // Long polling waits up to 20 seconds for messages
  const receiveResult = await sqs.receive({
    maxMessages: 10,
    waitTimeSeconds: 20,
    visibilityTimeout: 30,
  });

  if (receiveResult.ok) {
    console.log("Received:", receiveResult.messages.length);

    // Process and acknowledge messages
    for (const msg of receiveResult.messages) {
      const data = JSON.parse(msg.body);
      console.log("Processing:", data);

      // Delete after successful processing
      await sqs.delete(msg.receiptHandle);
    }
  }

  await sqs.close();
}

Batch operations for high throughput

import { createSqsClient } from "@probitas/client-sqs";

async function example() {
  const sqs = await createSqsClient({
    region: "us-east-1",
    url: "http://localhost:4566",
    credentials: { accessKeyId: "test", secretAccessKey: "test" },
  });
  await sqs.ensureQueue("test-queue");

  // Send multiple messages in a single API call
  const batchResult = await sqs.sendBatch([
    { id: "1", body: JSON.stringify({ event: "user.created", userId: "a1" }) },
    { id: "2", body: JSON.stringify({ event: "user.created", userId: "a2" }) },
    { id: "3", body: JSON.stringify({ event: "user.updated", userId: "a3" }) },
  ]);

  if (batchResult.ok) {
    console.log(`Sent: ${batchResult.successful.length}`);
    console.log(`Failed: ${batchResult.failed.length}`);
  }

  // Batch delete processed messages
  const receiveResult = await sqs.receive({ maxMessages: 10 });
  if (receiveResult.ok) {
    const handles = receiveResult.messages.map((m) => m.receiptHandle);
    await sqs.deleteBatch(handles);
  }

  await sqs.close();
}

Using await using for automatic cleanup

import { createSqsClient } from "@probitas/client-sqs";

async function example() {
  await using sqs = await createSqsClient({
    region: "us-east-1",
    url: "http://localhost:4566",
    credentials: { accessKeyId: "test", secretAccessKey: "test" },
  });

  await sqs.ensureQueue("test-queue");
  await sqs.send("Hello, SQS!");
  // Client automatically closed when scope exits
}