Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: replacing the isRunning method with status #459

Merged
merged 4 commits into from
Mar 11, 2024

Conversation

nicholasgriffintn
Copy link
Member

@nicholasgriffintn nicholasgriffintn commented Feb 6, 2024

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:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to 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:

  • Updated the README to document the old state and the removal of isRunning
  • Added a new getStatus method to return the states
  • Updated tests

@nicholasgriffintn nicholasgriffintn added this to the 9.0.0 milestone Feb 6, 2024
@nicholasgriffintn nicholasgriffintn changed the title feat!: replacing the isRunning method with getStatus feat!: replacing the isRunning method with status Feb 6, 2024
Copy link

codeclimate bot commented Mar 11, 2024

Code Climate has analyzed commit 3946277 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.

@nicholasgriffintn nicholasgriffintn marked this pull request as ready for review March 11, 2024 18:54
@nicholasgriffintn nicholasgriffintn requested review from a team as code owners March 11, 2024 18:54
@nicholasgriffintn nicholasgriffintn merged commit 9f07383 into main Mar 11, 2024
7 checks passed
@nicholasgriffintn nicholasgriffintn deleted the replacing-isrunning-with-status branch March 11, 2024 18:57
@github-actions github-actions bot locked and limited conversation to collaborators Mar 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant