Merge 06266b7 into ba9e1e6

CHANGELOG.md

@@ -2,9 +2,18 @@
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Development
+- nothing yet
+
+## [v3.0.0]
 ### Added
 - Added missing documentation on the `timeoutReached` event [#24](https://github.com/PruvoNet/squiss-ts/issues/24) (Thanks to [UpGo](https://github.com/upugo-dev) for the PR)
 - Added contributes list
+- Added typings for all events
+- Emit event on `keep` event - [#27](https://github.com/PruvoNet/squiss-ts/issues/27)
+- `deleted` event payload on `Squiss` class to also contain the message itself - [#28](https://github.com/PruvoNet/squiss-ts/issues/28) (BREAKING CHANGE)
+- `deleted` event payload on `Message` class to contain the success id - [#28](https://github.com/PruvoNet/squiss-ts/issues/28) (BREAKING CHANGE)
+- send `autoExtendError` event instead of `error` event on `Squiss` class - [#28](https://github.com/PruvoNet/squiss-ts/issues/28) (BREAKING CHANGE)
+- `aborted` event payload on `Squiss` class to be the error instance - [#28](https://github.com/PruvoNet/squiss-ts/issues/28)
 ### Fixed
 - deduplicate messages in delete batches [#26](https://github.com/PruvoNet/squiss-ts/issues/26)
 
@@ -95,3 +104,4 @@ Marking the library as stable after stress usage in a full blown production envi
 [v1.5.1]: https://github.com/PruvoNet/squiss-ts/compare/v1.5.0...v1.5.1
 [v1.5.2]: https://github.com/PruvoNet/squiss-ts/compare/v1.5.1...v1.5.2
 [v2.0.0]: https://github.com/PruvoNet/squiss-ts/compare/v1.5.2...v2.0.0
+[v3.0.0]: https://github.com/PruvoNet/squiss-ts/compare/v2.0.0...v3.0.0

README.md

@@ -188,6 +188,9 @@ Emitted when Squiss asks SQS for new messages, and doesn't get any.
 ### released {Message}
 Emitted after `release()` or `releaseMessage` has been called and the VisibilityTimeout of a message has successfully been changed to `0`. The `handled` event will also be fired for released messages, but that will come earlier, when the release function is initially called.
 
+### keep {Message}
+Emitted after `keep()` has been called. This happens when the timeout extender logic has exhausted all of its tries to extend the message visibility.
+
 ### timeoutReached {Message}
 Emitted when a message reaches it's timeout limit, including any extensions made with the `autoExtendTimeout` feature. The event is sent on the message itself, and on the Squiss class. Note that on the event sent on the message, there is no data sent to the listener callback function (because the `message` will be in scope anyway).