Skip to content

Commit 7bac68d

Browse files
authored
docs: Add instructions to SQSMessageModel (#1190)
The main point I wanted to add here is that this model is for _received_ messages. I've also added a bit of explanation about its intended use with `SQSService`. Jira: [ENG-2733]
1 parent 4581d61 commit 7bac68d

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

src/models/SQSMessageModel.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
import { SQS } from 'aws-sdk';
22

33
/**
4-
* Message model for SQS.
4+
* Model for message received from SQS.
5+
*
6+
* This model is used to return messages from `SQSService#receive`, and
7+
* provides access to the message body (parsed from JSON) and everything needed
8+
* for deletion (message ID and receipt handle).
9+
*
10+
* Once you've successfully processed a message, flag it for deletion using
11+
* `setForDeletion(true)`. You can then batch-delete messages using
12+
* `SQSService#batchDelete`. This will _not_ delete messages that have
13+
* not had the `forDeletion` flag set, allowing them to remain in the queue and
14+
* be processed again at a later time.
515
*/
616
export default class SQSMessageModel {
717
readonly messageId: string;

0 commit comments

Comments
 (0)