Class Producer

Index

Constructors

Properties

batchSize queueUrl sqs region? create

Methods

queueSize send sendBatch validate

Constructors

constructor

new Producer(options): Producer
Parameters
- options: ProducerOptions
Returns Producer
- Defined in producer.ts:23

Properties

batchSize

batchSize: number

queueUrl

queueUrl: string

sqs

sqs: SQSClient

`Optional` region

region?: string

`Static` create

create: ((options) => Producer)

Type declaration

- (options): Producer
- Parameters
  - options: ProducerOptions
  Returns Producer

Methods

queueSize

queueSize(): Promise<number>
Returns the number of messages in the queue.

Returns Promise<number>
A promise that resolves to the number of messages in the queue.
- Defined in producer.ts:40

send

send(messages): Promise<SendMessageBatchResultEntry[]>
Send a message to the queue.
Parameters
- messages: string | Message | (string | Message)[]
  A single message or an array of messages.
Returns Promise<SendMessageBatchResultEntry[]>
A promise that resolves to the result of the send operation.
- Defined in producer.ts:60

`Private` sendBatch

sendBatch(failedMessages?, successfulMessages?, messages?, startIndex?): Promise<SendMessageBatchResultEntry[]>
Send a batch of messages to the queue.
Parameters
- Optional failedMessages: string[]
  An array of failed message IDs.
- Optional successfulMessages: SendMessageBatchResultEntry[]
  An array of successful message results.
- Optional messages: (string | Message)[]
  An array of messages to send.
- Optional startIndex: number
  The index of the first message in the batch.
Returns Promise<SendMessageBatchResultEntry[]>
A promise that resolves to the result of the send operation.

Throws
FailedMessagesError
- Defined in producer.ts:101

`Private` validate

validate(options): void
Validate the producer options.
Parameters
- options: ProducerOptions
  The producer options to validate.
Returns void
Throws
Error if any required options are missing or invalid.
- Defined in producer.ts:81