feat(plugin-status): ✨ enhance store status plugin and improve naming #78
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The current behavior of the Store Status Plugin involves tracking the
loading
andmodification
status of a store.We've recognized a need for a clearer distinction between modification and initialization. In numerous scenarios, it's essential to determine if a store has been initialized, especially after a backend call or side effect. The existing
isModified
function is not ideal for this purpose.Additionally, the naming of
isModified
, has been identified as potentially misleading. WhileisModified
is intended to indicate whether the store has been modified, it may be interpreted as an ongoing process.What is the new behavior?
The
initialized
function determines if a store has been initialized, making it particularly useful after backend calls or side effects.isModified
has been renamed tomodified
. These aligns well with the newinitialized
signal and aims to enhance code readability in conditionals.Additionally, the deprecated
markAsUnmodified
function is replaced with the more comprehensiveresetStoreStatus
, allowing for manual resetting of both initialization and modification statuses.Does this PR introduce a breaking change?
Other information
setUnmodifiedStatus
tosetInitializedStatus
in effects.initialized()
function to track store initialization status.resetStoreStatus()
to manually reset store status.Deprecation:
isModified()
, usemodified()
instead.markAsUnmodified()
, useresetStoreStatus()
instead.