API reference / @backpack/amazon-sqs / SqsPublisher

Class: SqsPublisher

Utility for publishing messages to Amazon SQS.

Example

import { SQSClient } from "@aws-sdk/client-sqs";
import { SqsPublisher } from "@backpack/amazon-sqs";

const client = new SQSClient();
const publisher = new SqsPublisher(client, "my-queue-url");

// sends the message as raw payload
await publisher.sendRaw("raw payload");

// sends the message as JSON payload
await publisher.sendJson({ foo: 'Foo' });

Constructors

Constructor

new SqsPublisher(
   sqsClient, 
   queueUrl, 
   logger?): SqsPublisher;

Parameters

Parameter	Type	Description
sqsClient	SQSClient	The SQS client from AWS SDK.
queueUrl	string	The URL of the SQS queue to publish to.
logger?	Logger	A PowerTools logger instance, to enable additional logging.

Returns

SqsPublisher

Methods

publish()

publish(message, queueUrl): Promise<void>;

Sends a single message to an SQS queue.

Parameters

Parameter	Type	Description
message	string	The raw message payload.
queueUrl	string	The URL of the SQS queue to publish to.

Returns

Promise<void>

Deprecated

Please use SqsPublisher#sendRaw or SqsPublisher#sendJson instead.

---

sendJson()

sendJson(message): Promise<void>;

Publishes a message as JSON to an SQS queue.

Parameters

Parameter	Type	Description
message	unknown	The message object which will be published as JSON.

Returns

Promise<void>

---

sendRaw()

sendRaw(message): Promise<void>;

Sends a raw message to an SQS queue.

Parameters

Parameter	Type	Description
message	string	The raw message payload.

Returns

Promise<void>