Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/migration/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This doc summarises the breaking changes introduced in v2 and what you need to d
- [RequestService](#requestservice)
- [Models](#models)
- [StatusModel](#statusmodel)
- [SQSMessageModel](#sqsmessagemodel)

The new version of dependency injection does not work if code is minified. See [Notes](../../README.md#notes) in the main readme for how to turn this off in webpack.

Expand Down Expand Up @@ -215,3 +216,5 @@ Note that we can keep `status` unset initially, and TypeScript will complain if
### `SQSMessageModel`

The model constructor will now validate that `message` has all fields required of a received SQS message. This should not break existing applications that are using this model correctly, but is included in the 2.0.0 release as a precaution.

The class name has also changed from `Message` to `SQSMessageModel` in order to be consistent with the name exported from the package index. Again, this is not expected to break anything, and does not affect imports because the class is a default export.
2 changes: 1 addition & 1 deletion src/models/SQSMessageModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { SQS } from 'aws-sdk';
/**
* Message model for SQS.
*/
export default class Message {
export default class SQSMessageModel {
readonly messageId: string;

readonly receiptHandle: string;
Expand Down