bbc / sqs-consumer

Build Amazon Simple Queue Service (SQS) based applications without the boilerplate
https://bbc.github.io/sqs-consumer/
Other
1.74k stars 333 forks source link

feat!: replacing the isRunning method with status #459

Closed nicholasgriffintn closed 6 months ago

nicholasgriffintn commented 7 months ago

Description: Following on from #454, this removes the isRunning method in favour of a status method that returns both the running and polling state.

Type of change:

Why is this change required?: This would allow users to get the running and polling state from one method rather than creating multiple ways of getting this information, it can also be expanded in the future with more information.

This is a breaking change as it changes an existing method, outside of that, this change should not actually effect how the Consumer processes messages.

Code changes:

codeclimate[bot] commented 6 months ago

Code Climate has analyzed commit 3946277f and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 98.3% (0.0% change).

View more on Code Climate.