mweststrate / immer
98%
master: 99%

LAST BUILD BRANCH: github-actions-ci
DEFAULT BRANCH: master
Repo Added
Files 17
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH v5.0.0
branch: v5.0.0
CHANGE BRANCH
x

1047

push

travis-ci

GitHub 
feat: added first class support for `Map` and `Set`

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!

533 of 555 branches covered (96.04%)

Branch coverage included in aggregate %.

723 of 728 relevant lines covered (99.31%)

671.73 hits per line

Relevant lines Covered
728 RELEVANT LINES 723 COVERED LINES
671.73 HITS PER LINE
Source Files on v5.0.0
Coverage ∆ File Lines Relevant Covered Missed Hits/Line Branch Hits Branch Misses

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
1047 v5.0.0 feat: added first class support for `Map` and `Set` 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! S... push GitHub travis-ci pending completion  
See All Builds (1015)