Updates to objects deep inside a Set should not result in patches for the Set itself
#450
Labels
Comments
mweststrate
added a commit
that referenced
this issue
Oct 30, 2019
BREAKING CHANGE: Maps and Sets are treated differently now; they will no longer directly mutated when updated inside a draft This release introduces first class support for Maps and Sets! Some things to keep in mind: * Inside recipes, you can directly modify Maps and Sets with methods like `add`, `set`, `delete` and `clear` * Those methods do mutate draft Maps and Sets, but won't actually change their originals! * Immer does not polyfill Map and Set automatically in environments where those aren't available out of the box * Maps and Sets are supported both in ES5 and Proxy mode * If `autoFreeze` is enabled, the maps and sets returned from a producer will be artificially frozen by making their mutative APIs unusable * Non primitive keys for Maps, and non primitive values for Sets are supported. However, we strongly recommend to not combine non-primitive keys to Maps with patches, for reasons expressed below. Open questions * TypeScript support for storing immutable types inside Maps and Sets, and converting them to `Draft`'s, is limited, see #448 for details * Since JSON-patch standard doesn't offer support for Sets or Maps, it is not entirely clear how mutations to those are best described by patches, so this might be refined in the future. See also #450 Credits to @runnez, @aigoncharov and @aleclarson for making this happen!
|
Closing for now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Making changes to objects stored inside Sets result currently in patches for the Set itself. However, the patch could be more precisely targeted to the thing inside the set, if we assume indices are reliable (in principle Sets preserve insertion order).
See this review comment for details.
Or should "indices" in maps and sets be represented differently in patches entirely?
The text was updated successfully, but these errors were encountered: