Skip to content

Releases: immerjs/immer

v10.1.1

27 Apr 20:07
e2d222b
Compare
Choose a tag to compare

10.1.1 (2024-04-27)

Bug Fixes

v10.1.0

27 Apr 19:56
53e3203
Compare
Choose a tag to compare

10.1.0 (2024-04-27)

Features

  • performance: Make non-strict mode faster for classes. Addresses #1071 (53e3203). Immer 10.x solved slow iteration for plain JS objects. This update applies the same handling to class instances. In cases this makes class instance handling 3 times faster. Note that this slightly modifies the behavior of Immer with classes in obscure corner cases, in ways that match current documentation, but do not match previous behavior. If you run into issues with this release icmw. class instances, use setUseStrictShallowCopy("class_only") to revert to the old behavior. For more details see https://immerjs.github.io/immer/complex-objects#semantics-in-detail

v10.0.4

09 Mar 21:37
Compare
Choose a tag to compare

10.0.4 (2024-03-09)

Bug Fixes

v10.0.3

02 Oct 06:36
f6736a4
Compare
Choose a tag to compare

10.0.3 (2023-10-02)

Bug Fixes

v10.0.2

09 May 18:24
75e004d
Compare
Choose a tag to compare

10.0.2 (2023-05-09)

Bug Fixes

  • export Objectish type (#1043) (75e004d)
  • Move index.js.flow from dist/ -> dist/cjs/ to match index.js (#1038) (a3b5603)

v10.0.1

17 Apr 19:00
Compare
Choose a tag to compare

10.0.1 (2023-04-17)

Bug Fixes

  • production bundle was loaded incorrectly, fixes #1037 (707e72b)

v10.0.0

17 Apr 10:38
2ef9a42
Compare
Choose a tag to compare

10.0.0 (2023-04-17)

Release notes

  • [breaking change] Immer 10 only supports modern browsers, that have support for Proxy, Reflect, Symbol and Map and Set.
  • [breaking change] There is no longer a UMD build exposed (thanks Mark Erikson for modernizing the build setup in #1032!
  • [breaking change] getters and setters are ignored by default on plain object, as this is a very uncommon case and provides a significant performance boost (ca 33%, but depends a lot on the scenario). Fixes #867, #1012. Thanks hrsh7th for implementing it in #941!
  • [breaking change] Promise based reducers are no longer supported. Conceptually it is an anti pattern to hold on to drafts over time. If needed the old behavior can still be achieved by leveraging createDraft and finishDraft.
  • [breaking change] ES5 mode (for legacy browsers) has been dropped. If your project relies on enableES5(), you SHOULD NOT upgrade Immer. enableES5 has been removed.
  • [breaking change] produce is no longer exposed as the default export. This improves eco system compatibility, and makes sure that there is only one correct way of doing things
  • [breaking change] enableAllPlugins has been removed, use enablePatches(); enableMapSet() instead
  • [breaking change] shortening the length of a JSON array now results in delete patches, rather than a mutation of the length property, in accordance with JSON spec. Thanks kshramt for implementing this in #964!
  • Immer is now an ESM package that can be directly imported into the browser. CJS should still work, UMD support has been removed.

Overall, there is a rough performance increase of 33% for Immer (and in some cases significantly higher), and the (non gzipped) bundle size has reduced from 16 to 11.5 KB, while the the minimal gzipped import of just produce has remained roughly the same at 3.3 KB.

For more details, see #1015

Migration steps

  1. If you have any enableES5() call, don't migrate
  2. When using getters/ setters icmw plain objects, call useStrictShallowCopy(true) at startup
  3. Replace all default imports: Replace import produce from "immer" with import {produce} from "immer"
  4. Replace all calls to enableAllPlugins() with enablePatches(); enableMapSet(); to be more specific and smoothen future migrations.
  5. If any producer returned a Promise, refactor it to leverage createDraft instead. Roughly:
const newState = await produce(oldState, recipe)

// becomes
const draft  = createDraft(oldState)
await recipe(draft)
const newState = finishDraft(draft)

v9.0.21

23 Mar 17:41
7c15339
Compare
Choose a tag to compare

9.0.21 (2023-03-23)

Bug Fixes

  • ensure type exports is first in package.json export declaration (#1018) (b6ccd0f)

v9.0.20

23 Mar 17:38
385837d
Compare
Choose a tag to compare

9.0.20 (2023-03-23)

Bug Fixes

  • patching maps failed when using number keys (#1025) (dd83e2e)

v9.0.19

27 Jan 14:59
Compare
Choose a tag to compare

9.0.19 (2023-01-27)

Bug Fixes

  • don't freeze drafts returned from produce if they were passed in as draft (#917) (46867f8)
  • produce results should never be frozen when returned from nested produces, to prevent 'hiding' drafts. Fixes #935 (a810960)
  • release and publish from 'main' rather than 'master' branch (82acc40)
  • revert earlier fix (#990) for recursive types (#1014) (3eeb331)
  • Upgrade Github actions to Node 16 attempt 1 (9d4ea93)
  • Upgrade Github actions to Node 16 attempt 2 (082eecd)