feat: Add ability to disable automatic bookkeeping #11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a new config variable, autoUpdateEnabled, for the config object of the ChangeDetector constructor. I defaulted it to true, to make the class behave the same as was prior to the update by default. When disabled, the onus is now on the consumer of the API to invoke updateRecords themselves with the records that they want to update the bookkeeping on. This is useful as it allows for repeatability upon failures. I updated the README with details of the new option. I also bumped the semantic version in package.json from 1.1.0 to 1.2.0 as I believe this is a new feature, but doesn't break existing API usage. This commit will resolve crownheightsaid#2
|
Great change! Sorry I just saw this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a new config variable, autoUpdateEnabled, for the config object of
the ChangeDetector constructor. I defaulted it to true, to make the
class behave the same as was prior to the update by default.
When disabled, the onus is now on the consumer of the API to invoke
updateRecords themselves with the records that they want to update the
bookkeeping on. This is useful as it allows for repeatability upon
failures.
I updated the README with details of the new option.
I also bumped the semantic version in package.json from 1.1.0 to 1.2.0
as I believe this is a new feature, but doesn't break existing API
usage.
This commit will resolve #2