Document reconcile() in-place mutation caveat - #28
Open
rajanpanth wants to merge 1 commit into
Open
Conversation
useStore applies updates with Solid's reconcile(), which mutates the previous object value in place to match the new one. Document that consequence — storing references to external proxy objects is a footgun — plus the ReconcileOptions pass-through and a deep-copy workaround, per the report in nanostores#27.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #27
Documents the
reconcile()behaviour reported in #27:useStoreapplies every update with Solid'sreconcile(), so for object/array values the previous object is mutated in place to match the new one — a footgun when the store holds references to objects you don't own (e.g. proxies from another library).The new README section explains:
reconcile()is used (fine-grained rendering) and that theuseStoresecond argument passes through asReconcileOptions(e.g.keyfor array stores) — previously undocumented;Docs-only change. I left the rest of the README untouched (it is not prettier-formatted, so no formatting churn).