UNPKG

123 kBMarkdownView Raw
1# mobx
2
3## 6.4.2
4
5### Patch Changes
6
7- [`2caf7e1a`](https://github.com/mobxjs/mobx/commit/2caf7e1a3504dde3d7c9bde3c6fb56ca85168018) [#3316](https://github.com/mobxjs/mobx/pull/3316) Thanks [@urugator](https://github.com/urugator)! - `requiresObservable` always takes precedence over global `reactionRequiresObservable`
8
9## 6.4.1
10
11### Patch Changes
12
13- [`d6fa9a19`](https://github.com/mobxjs/mobx/commit/d6fa9a1970ebfb8a8adaf5bf0dc73125acec2dee) [#3306](https://github.com/mobxjs/mobx/pull/3306) Thanks [@urugator](https://github.com/urugator)! - fix missing type inferrence of `observe` and `intercept` for arrays
14
15## 6.4.0
16
17### Minor Changes
18
19- [`6b926833`](https://github.com/mobxjs/mobx/commit/6b926833ac7abbf92ff5c309613d2345f72527ee) [#3287](https://github.com/mobxjs/mobx/pull/3287) Thanks [@kubk](https://github.com/kubk)! - Remove any from 'merge' and 'replace' methods of ObservableMap
20
21### Patch Changes
22
23- [`dee35be4`](https://github.com/mobxjs/mobx/commit/dee35be427989b6adc3c8f7ae8dc632ea66f3538) [#3300](https://github.com/mobxjs/mobx/pull/3300) Thanks [@kubk](https://github.com/kubk)! - Make the error message about Object.freeze more informative
24
25## 6.3.13
26
27### Patch Changes
28
29- [`23803202`](https://github.com/mobxjs/mobx/commit/2380320263f5edcd06d7ba6bdf02aff3fd7d305a) [#3273](https://github.com/mobxjs/mobx/pull/3273) Thanks [@urugator](https://github.com/urugator)! - fix `flow.bound` #3271
30
31## 6.3.12
32
33### Patch Changes
34
35- [`654a2013`](https://github.com/mobxjs/mobx/commit/654a2013107ac6e5bbe3851e4eed22f0c9130525) [#3257](https://github.com/mobxjs/mobx/pull/3257) Thanks [@urugator](https://github.com/urugator)! - fix: observable map initialization violates `enforceActions: "always"`
36
37## 6.3.11
38
39### Patch Changes
40
41- [`bf5da6ba`](https://github.com/mobxjs/mobx/commit/bf5da6bad982dc3d955d5f27f7fea6f94b041ea7) [#3239](https://github.com/mobxjs/mobx/pull/3239) Thanks [@bernardobelchior](https://github.com/bernardobelchior)! - Improved `toJS` jsdoc
42
43## 6.3.10
44
45### Patch Changes
46
47- [`2d70798e`](https://github.com/mobxjs/mobx/commit/2d70798eb327187d93757757ceaf410a608735b2) [#3233](https://github.com/mobxjs/mobx/pull/3233) Thanks [@anderlaw](https://github.com/anderlaw)! - `eq.ts` fix comparer logic
48
49## 6.3.9
50
51### Patch Changes
52
53- [`87e5a037`](https://github.com/mobxjs/mobx/commit/87e5a03735dbc1930e54a15b5ce88ad684bc3dc1) [#3214](https://github.com/mobxjs/mobx/pull/3214) Thanks [@urugator](https://github.com/urugator)! - `requiresReaction` always takes precedence over global `computedRequiresReaction`
54
55* [`9b90e25c`](https://github.com/mobxjs/mobx/commit/9b90e25c7bc0cdc0a07d1f847683604e86790f24) [#3198](https://github.com/mobxjs/mobx/pull/3198) Thanks [@urugator](https://github.com/urugator)! - fix `isPlainObject` impl (fixes #3197)
56
57## 6.3.8
58
59### Patch Changes
60
61- [`9d5e65cb`](https://github.com/mobxjs/mobx/commit/9d5e65cbd612f262d925e57cebb559f5cf36c502) [#3193](https://github.com/mobxjs/mobx/pull/3193) Thanks [@ChocolateLoverRaj](https://github.com/ChocolateLoverRaj)! - Make `IAtom['reportObserved']` return `boolean`
62
63* [`55508af6`](https://github.com/mobxjs/mobx/commit/55508af690fa875e6affaf30f34280b3f27b6126) [#3189](https://github.com/mobxjs/mobx/pull/3189) Thanks [@RvanderLaan](https://github.com/RvanderLaan)! - Fix for RangeError in ObservableArray.replace for large arrays
64
65## 6.3.7
66
67### Patch Changes
68
69- [`3a7dee6f`](https://github.com/mobxjs/mobx/commit/3a7dee6fdaddbb4b79205b054601a8020c226fcc) [#3180](https://github.com/mobxjs/mobx/pull/3180) Thanks [@kubk](https://github.com/kubk)! - Fix type inference of observe function
70
71## 6.3.6
72
73### Patch Changes
74
75- [`49468204`](https://github.com/mobxjs/mobx/commit/49468204d3bc28d15dbf383c0b7f874ca26dff30) [#3162](https://github.com/mobxjs/mobx/pull/3162) Thanks [@upsuper](https://github.com/upsuper)! - Have cancelled when reject with an error rather than a string
76
77* [`4afb1ec2`](https://github.com/mobxjs/mobx/commit/4afb1ec24427cf8e1f768d0c6fc49d0f44f4ab8e) [#3154](https://github.com/mobxjs/mobx/pull/3154) Thanks [@urugator](https://github.com/urugator)! - `makeObservable` throws when mixing @decorator syntax with annotations
78
79## 6.3.5
80
81### Patch Changes
82
83- [`4ac6b454`](https://github.com/mobxjs/mobx/commit/4ac6b45473c2e3b07c8e683cd395bc5edfaa8e15) [#3146](https://github.com/mobxjs/mobx/pull/3146) Thanks [@urugator](https://github.com/urugator)! - fix #3109: spy: computed shouldn't report update unless the value changed
84
85## 6.3.4
86
87### Patch Changes
88
89- [`0dbf3eb6`](https://github.com/mobxjs/mobx/commit/0dbf3eb6eecfa9cd6cd9dc7d707e8d70927e79bf) [#3141](https://github.com/mobxjs/mobx/pull/3141) Thanks [@urugator](https://github.com/urugator)! - [spy: bound actions report correct object](https://github.com/mobxjs/mobx/discussions/3140)
90
91## 6.3.3
92
93### Patch Changes
94
95- [`d78a1592`](https://github.com/mobxjs/mobx/commit/d78a15929052b96698b3355a0b4c8335750422db) [#2902](https://github.com/mobxjs/mobx/pull/2902) Thanks [@z3rog](https://github.com/z3rog)! - chore: observable use internal constants
96
97* [`db21d85f`](https://github.com/mobxjs/mobx/commit/db21d85fcd41c6c142998f53e722ee0a0e9b5c18) [#2998](https://github.com/mobxjs/mobx/pull/2998) Thanks [@urugator](https://github.com/urugator)! - `trace()`: log when computed becomes suspended
98 `requiresReaction` warns instead of throwing
99
100- [`b9fa119c`](https://github.com/mobxjs/mobx/commit/b9fa119c90e23d4b327763189f24c00be2fb2c26) [#3056](https://github.com/mobxjs/mobx/pull/3056) Thanks [@upsuper](https://github.com/upsuper)! - Create WHEN_TIMEOUT error earlier to capture useful stack
101
102* [`99491ec2`](https://github.com/mobxjs/mobx/commit/99491ec2d315a3a01cdbe40d9a24d920a09cbd0e) [#2972](https://github.com/mobxjs/mobx/pull/2972) Thanks [@kk-gjyang](https://github.com/kk-gjyang)! - Polyfill `Object.is` for old/unsupported browsers
103
104- [`0d28db8a`](https://github.com/mobxjs/mobx/commit/0d28db8a0ba99f5cce744bb83b5bd88ec45a7e41) [#2927](https://github.com/mobxjs/mobx/pull/2927) Thanks [@upsuper](https://github.com/upsuper)! - Give proper typing to opts.equals of reaction
105
106* [`c6dc925c`](https://github.com/mobxjs/mobx/commit/c6dc925c6cf7eeff9237ee07c55927a7bbc14cb7) [#2985](https://github.com/mobxjs/mobx/pull/2985) Thanks [@fecqs](https://github.com/fecqs)! - Remove duplicate global property check
107
108## 6.3.2
109
110### Patch Changes
111
112- [`4011b378`](https://github.com/mobxjs/mobx/commit/4011b3789d57e3dab0b85a835fe2979033133ce9) [#2949](https://github.com/mobxjs/mobx/pull/2949) Thanks [@urugator](https://github.com/urugator)! - fix #2948: flow ignores `autoBind` option
113
114## 6.3.1
115
116### Patch Changes
117
118- [`d678ebd7`](https://github.com/mobxjs/mobx/commit/d678ebd7e54efb3aeae4541f87f5bcf93a623ec6) [#2944](https://github.com/mobxjs/mobx/pull/2944) Thanks [@urugator](https://github.com/urugator)! - Fix [#2941](https://github.com/mobxjs/mobx/issues/2941) - flow.bound replaces method on proto with bound function
119
120## 6.3.0
121
122### Minor Changes
123
124- [`035bf409`](https://github.com/mobxjs/mobx/commit/035bf4096dd72d296af1fc25304adaade73cc7eb) [#2906](https://github.com/mobxjs/mobx/pull/2906) Thanks [@urugator](https://github.com/urugator)! - Provide `flow.bound` annotation/decorator
125
126### Patch Changes
127
128- [`3dedb4d4`](https://github.com/mobxjs/mobx/commit/3dedb4d4b5376f3991183923838da942a9a81506) [#2904](https://github.com/mobxjs/mobx/pull/2904) Thanks [@ahoisl](https://github.com/ahoisl)! - Make toJS work with computed value props
129
130## 6.2.0
131
132### Minor Changes
133
134- [`bc8db3df`](https://github.com/mobxjs/mobx/commit/bc8db3df9405034999f8feb8c95ba8045c7ae008) [#2779](https://github.com/mobxjs/mobx/pull/2779) Thanks [@urugator](https://github.com/urugator)! - In mobx5 all own properties were by default observable regardless of their value. Since mobx6 we treat functional properties as `action`s or to be precise `autoAction`s. `autoAction` provides `action`'s benefits to your functions, without the need to explicitely annotate them as `actions`.
135 We think this is useful, but as a consequence, such properties are no longer `observable` and therefore non-writable and also non-enumerable. This turned out to be suprising and inconvinient to some users:
136 https://github.com/mobxjs/mobx/discussions/2760
137 https://github.com/mobxjs/mobx/discussions/2586
138 https://github.com/mobxjs/mobx/issues/2835
139 https://github.com/mobxjs/mobx/issues/2629
140 https://github.com/mobxjs/mobx/issues/2551
141 https://github.com/mobxjs/mobx/issues/2637
142 So we decided to change it: All _own_ props _including functions_ are `observable` (enumerable, writable) as in v5, but additionally all functions that become part of deeply observable structure are by default converted to `autoAction`/`flow`.
143 Note that `deep` option affects this conversion in the same way as it affects conversion of other values (object/array/map/set).
144
145 - by default all functions are converted to `autoAction`s/`flow`s
146 - by default all originally _own_ props are now observable and enumerable (as in pre v6)
147 - `deep: false` ignores _all_ property values (including functions that would be previously converted to `autoAction`/`flow`)
148 - by default _lone_ setters are converted to `action`s
149
150### Patch Changes
151
152- [`16cab8b1`](https://github.com/mobxjs/mobx/commit/16cab8b14cf4a0d995d3f367123abfab5aed8326) [#2806](https://github.com/mobxjs/mobx/pull/2806) Thanks [@urugator](https://github.com/urugator)! - Annotations refactor - reduced code duplication
153
154* [`6b324edc`](https://github.com/mobxjs/mobx/commit/6b324edc69e7e9041a01e20d2e86f424046f3e25) [#2873](https://github.com/mobxjs/mobx/pull/2873) Thanks [@urugator](https://github.com/urugator)! - Fix [#2871](https://github.com/mobxjs/mobx/issues/2871): `toJS` throws with `configure({ useProxies: "ifavailable" })`
155
156- [`b5141883`](https://github.com/mobxjs/mobx/commit/b5141883434cba86b257d68a7badff5038c14296) [#2872](https://github.com/mobxjs/mobx/pull/2872) Thanks [@urugator](https://github.com/urugator)! - Fix [#2859](https://github.com/mobxjs/mobx/issues/2859): Trace log only if derivation is actually about to re-run
157
158* [`0945c265`](https://github.com/mobxjs/mobx/commit/0945c26513057457e1534a80558a3eb98487dc96) [#2840](https://github.com/mobxjs/mobx/pull/2840) Thanks [@iChenLei](https://github.com/iChenLei)! - export IComputedFactory typescript type definition
159
160## 6.1.8
161
162### Patch Changes
163
164- [`ca4914f9`](https://github.com/mobxjs/mobx/commit/ca4914f978aef427e7b2223328fd66b82e522d89) [#2836](https://github.com/mobxjs/mobx/pull/2836) Thanks [@urugator](https://github.com/urugator)! - Fix [#2832](https://github.com/mobxjs/mobx/issues/2832) - annotation cache ignores overrides
165
166## 6.1.7
167
168### Patch Changes
169
170- [`5640aa77`](https://github.com/mobxjs/mobx/commit/5640aa7794420a5fc2f99ac0819de11696d6ba71) [#2799](https://github.com/mobxjs/mobx/pull/2799) Thanks [@urugator](https://github.com/urugator)! - - fix: user provided debug names are not preserved on production
171 - fix: property atom's debug name is dynamic on production
172 - fix: `observable(primitive, options)` ignores `options`
173 - fix: `getDebugName(action)` throws `[MobX] Cannot obtain atom from undefined`
174 - [fix: terser using `unsafe: true`](https://github.com/mobxjs/mobx/issues/2751#issuecomment-778171773)
175
176## 6.1.6
177
178### Patch Changes
179
180- [`9b195b17`](https://github.com/mobxjs/mobx/commit/9b195b17bd661b9c0c4ab3a8ef323e23c2f118e4) [#2780](https://github.com/mobxjs/mobx/pull/2780) Thanks [@iChenLei](https://github.com/iChenLei)! - The overall memory usage of MobX has been reduced in production builds by skipping the generation of debug identifiers. The internal `mapid_` field of Reaction has been removed as part of the change.
181
182## 6.1.5
183
184### Patch Changes
185
186- [`3979bee3`](https://github.com/mobxjs/mobx/commit/3979bee36c82d342050978834197ea15a7ddbbf8) [#2773](https://github.com/mobxjs/mobx/pull/2773) Thanks [@urugator](https://github.com/urugator)! - Decorators optimization
187
188* [`7820e5ea`](https://github.com/mobxjs/mobx/commit/7820e5eae0c9dcdfa1e69cf92e0bfa209b2b478b) [#2769](https://github.com/mobxjs/mobx/pull/2769) Thanks [@iChenLei](https://github.com/iChenLei)! - add warn for extending builtins
189
190- [`a7c15171`](https://github.com/mobxjs/mobx/commit/a7c1517133915c2891e92a865fe5475627b6b89f) [#2775](https://github.com/mobxjs/mobx/pull/2775) Thanks [@pkit](https://github.com/pkit)! - use globalThis in global detection
191
192* [`5d41b646`](https://github.com/mobxjs/mobx/commit/5d41b6462cf609df869a088e353bc485846c88f8) [#2774](https://github.com/mobxjs/mobx/pull/2774) Thanks [@urugator](https://github.com/urugator)! - Fix: `makeAutoObservable` now working properly with symbolic keys
193 Fix: `isComputedProp` and `getAtom` second arg type is incompatible with Symbols
194
195## 6.1.4
196
197### Patch Changes
198
199- [`0677c0e7`](https://github.com/mobxjs/mobx/commit/0677c0e788bc11ceba909bba16b2b009e90a4c97) [#2766](https://github.com/mobxjs/mobx/pull/2766) Thanks [@urugator](https://github.com/urugator)! - Fix: Inherited annotated fields are not assignable
200
201## 6.1.3
202
203### Patch Changes
204
205- [`d2a2a52e`](https://github.com/mobxjs/mobx/commit/d2a2a52e59e1cf5867bf72e49e7f134c7055ac5d) [#2763](https://github.com/mobxjs/mobx/pull/2763) Thanks [@vkrol](https://github.com/vkrol)! - Add `safeDescriptors` to `configure` options type
206
207## 6.1.2
208
209### Patch Changes
210
211- [`ca09f2f5`](https://github.com/mobxjs/mobx/commit/ca09f2f5744f438b0b6572b60e055ca8b59646de) [#2761](https://github.com/mobxjs/mobx/pull/2761) Thanks [@urugator](https://github.com/urugator)! - `configure({ safeDescriptors: false })` now forces all props of observable objects to be writable and configurable
212
213## 6.1.1
214
215### Patch Changes
216
217- [`39eca50d`](https://github.com/mobxjs/mobx/commit/39eca50de3936807037cb1205bbab29a3e328bc0) [#2757](https://github.com/mobxjs/mobx/pull/2757) Thanks [@urugator](https://github.com/urugator)! - Fix error stringification on minified build
218 Fix `isObservableProp` not supporting `Symbols`
219 Fix `makeAutoObservable` not ignoring `inferredAnnotationsSymbol`
220
221## 6.1.0
222
223This release fixes a plethora of bugs related to sub-classing and reflecting / iterating on observable objects.
224The behavior of MobX is in many edge cases much more explicitly defined now.
225
226A new annotation was introduced: `@override` / `override` to support re-defining actions and computed values(!) on sub classses.
227
228For idiomatic MobX usage this release should have little impact, but if you are using a lot of sub-classing, reflection APIs or direct object manipulations like `defineProperty`,
229this release might introduce previously unseen errors for cases that silently failed before, or even worked successfully even though the correct behavior wasn't specified earlier.
230
231If you are migrating from MobX 4/5 we strongly recommend to go to 6.1 in one go, and skip 6.0.\*, as some buggy behavior compared to the previous majors has been corrected.
232
233As always, our libraries come as-is and are maintained by volunteers. Upgrades are at own risk and voluntary. Bug reports require a minimal reproductions and a correctly filled out issue template.
234
235Support the ongoing maintenance at: https://opencollective.com/mobx
236
237### Minor Changes
238
239[`28f8a11d`](https://github.com/mobxjs/mobx/commit/28f8a11d8b94f1aca2eec4ae9c5f45c5ea2f4362) [#2641](https://github.com/mobxjs/mobx/pull/2641) Thanks [@urugator](https://github.com/urugator)!
240
241- `action`, `computed`, `flow` defined on prototype can be overriden by subclass via `override` annotation/decorator. Previously broken.
242- Overriding anything defined on instance itself (`this`) is not supported and should throw. Previously partially possible or broken.
243- Attempt to re-annotate property always throws. Previously mostly undefined outcome.
244- All annotated and non-observable props (action/flow) are non-writable. Previously writable.
245- All annotated props of non-plain object are non-configurable. Previously configurable.
246- Observable object should now work more reliably in various (edge) cases.
247- Proxied objects now support `Object.defineProperty`. Previously unsupported/broken.
248- `extendObservable/makeObservable/defineProperty` notifies observers/listeners/interceptors about added props. Previously inconsistent.
249- `keys/values/entries` works like `Object.keys/values/entries`. Previously included only observables.
250- `has` works like `in`. Previously reported `true` only for existing own observable props.
251- `set` no longer transforms existing non-observable prop to observable prop, but simply sets the value.
252- `remove/delete` works with non-observable and computed props. Previously unsupported/broken.
253- Passing `options` to `observable/extendObservable/makeObservable` throws if the object is already observable . Previously passed options were mostly ignored.
254- `autoBind` option is now sticky - same as `deep` and `name` option.
255- `observable/extendObservable` now also picks non-enumerable keys (same as `make[Auto]Observable`).
256- Removed deprecated `action.bound("name")`
257- Proxied objects should be compatible with `Reflect` API. Previously throwing instead of returning booleans.
258
259## 6.0.5
260
261### Patch Changes
262
263- [`6b304232`](https://github.com/mobxjs/mobx/commit/6b30423266e5418a3f20389d0bd0eae31f3384d2) [#2644](https://github.com/mobxjs/mobx/pull/2644) Thanks [@rokoroku](https://github.com/rokoroku)! - Fix broken error reference in errors.ts
264
265* [`83b84fd3`](https://github.com/mobxjs/mobx/commit/83b84fd354f2253fdd8ea556e217a92fc2633c00) [#2740](https://github.com/mobxjs/mobx/pull/2740) Thanks [@iChenLei](https://github.com/iChenLei)! - Infer optional / promise `action` args type correctly
266
267- [`65c7b73b`](https://github.com/mobxjs/mobx/commit/65c7b73b7f0b1a69a1a2786b5f484419d129d10b) [#2717](https://github.com/mobxjs/mobx/pull/2717) Thanks [@ahoisl](https://github.com/ahoisl)! - The TypeScript type `CreateObservableOptions` is now exported.
268
269* [`989390d4`](https://github.com/mobxjs/mobx/commit/989390d46bbe9941b61ac6c6d1292f96445e7cc3) [#2594](https://github.com/mobxjs/mobx/pull/2594) Thanks [@urugator](https://github.com/urugator)! - Fixed [#2579](https://github.com/mobxjs/mobx/issues/2579) - `observable` does not ignore class instances
270
271- [`dea1cf18`](https://github.com/mobxjs/mobx/commit/dea1cf189b0f43929f4f626229d34a80bd10212e) [#2726](https://github.com/mobxjs/mobx/pull/2726) Thanks [@mweststrate](https://github.com/mweststrate)! - fix: `onBecomeObserved` was not triggered correctly for computed dependencies of computeds. Fixes #2686, #2667
272
273* [`592e6e99`](https://github.com/mobxjs/mobx/commit/592e6e996c2d5264e162cfb0921a071c1d815c92) [#2743](https://github.com/mobxjs/mobx/pull/2743) Thanks [@vkrol](https://github.com/vkrol)! - Remove `sideEffects` section in `mobx-react-lite` `package.json`
274
275> 🚨🚨🚨 If you are upgrading from V4/V5, please follow [the migration guide](https://mobx.js.org/migrating-from-4-or-5.html).
276
277## 6.0.4
278
279### Patch Changes
280
281- [`79a09f49`](https://github.com/mobxjs/mobx/commit/79a09f49a9f2baddbab8d89e9a7ac07cffadf624) [#2615](https://github.com/mobxjs/mobx/pull/2615) Thanks [@urugator](https://github.com/urugator)! - Fix [#2614](https://github.com/mobxjs/mobx/issues/2614) - `makeObservable` does not respect `options.name`
282
283## 6.0.3
284
285### Patch Changes
286
287- [`d0e6778d`](https://github.com/mobxjs/mobx/commit/d0e6778de73f6dfad61283c04103049732b2aea2) - Create ESM bundles with NODE_ENV correctly replaced so it can be used in browser (#2564)
288
289## 6.0.2
290
291### Patch Changes
292
293- [`b5d64d19`](https://github.com/mobxjs/mobx/commit/b5d64d1965ecd9a593886279ddaf96eda61c4a77) [#2548](https://github.com/mobxjs/mobx/pull/2548) Thanks [@urugator](https://github.com/urugator)! - Fixed [2542](https://github.com/mobxjs/mobx/issues/2542), makeAutoObservable not respecting deep option [@urugator](https://github.com/urugator)
294
295* [`f4c22925`](https://github.com/mobxjs/mobx/commit/f4c229259a72f0497d3f9b6a05af9d9c4280d8b1) [#2582](https://github.com/mobxjs/mobx/pull/2582) Thanks [@tomenden](https://github.com/tomenden)! - Support running in a web-worker
296
297## 6.0.1
298
299- Fixed issue in TS typings of `makeObservable` in combination with a member named `toString()`
300
301## 6.0.0
302
303### New features
304
305- [`makeObservable(target, annotations)`](../../docs/observable-state.md#makeobservable) is now the recommended way to make objects with a fixed shape observable, such as classes.
306- [`makeAutoObservable(target)`](../../docs/observable-state.md#makeautoobservable) will automatically determine the annotations used by `makeObservable`. Methods will be marked as 'autoAction', so that they can be used both from a computed value or as standalone method.
307- MobX 6 can be used in both modern environments, and environments that don't support Proxy. So both MobX 4 and 5 users can upgrade to 6. See [proxy support](../../docs/configuration.md#proxy-support) for more details.
308- `observable.array` now supports `{ proxy: false }` as option.
309- `reaction`'s effect function now receives the previous value seen by the reaction as second argument.
310- `flow` can now be used as annotation as well. You might need `flowResult` in case you use TypeScript to extract the correct result type. [details](../../docs/actions.md#using-flow-instead-of-async--await-).
311
312### Breaking changes
313
314#### Changes that might affect you
315
316- The `decorate` API has been removed, and needs to be replaced by `makeObservable` in the constructor of the targeted class. It accepts the same arguments. The `mobx-undecorate` can transform this automatically.
317- When using `extendObservable` / `observable`, fields that contained functions used to be turned into observables. This is no longer the case, they will be converted into `autoActions`.
318- [Strict mode](../../docs/configuration.md#enforceactions) for actions is now enabled by default in `observed` mode.
319- `toJS` no longer takes any options. It no longer converts Maps and Sets to plain data structures. Generic, flexible serialization of data structures is out of scope for the MobX project, and writing custom serialization methods is a much more scalable approach to serialization (tip: leverage `computed`s to define how class instances should be serialized).
320- The methods `intercept` and `observe` are no longer exposed on observable arrays, maps and boxed observables. Import them as utility from mobx instead: `import { observe, intercept } from "mobx"`, and pass the collection as first argument: `observer(collection, callback)`. Note that we still recommend to avoid these APIs.
321- `observableMap.toPOJO()`, `observableMap.toJS()` have been dropped. Use `new Map(observableMap)` instead if you want to convert an observable map to a plain Map shallowly.
322- `observableMap.toJSON()` now returns an entries array rather than a new Map, to better support serialization.
323- `observableSet.toJS()` has been dropped. Use `new Set(observableSet)` instead if you want to convert an observable Set to a plain Set shallowly.
324- `observableSet.toJSON()` now returns an array rather than a new Set, to better support serialization.
325- Sorting or reversing an observableArray in a derivation (without slicing first) will now throw rather than warn. In contrast, it is now allowed to sort or reverse observable arrays in-place, as long as it happens in an action.
326- `isArrayLike` is no longer exposed as utility. Use `Array.isArray(x) || isObservableArray(x)` instead.
327
328#### Obscure things that don't work anymore, but that probably won't affect you
329
330- It is no longer possible to re-decorate a field (through either `@observable` or `makeObservable`) that is already declared in a super class.
331- `runInAction` no longer supports passing a name as first argument. Name the original function or use `action(name, fn)()` if you care about the debug name.
332- `computed(getterFn, setterFn)` no longer accepts a setter function as a second argument. Use the `set` option instead: `computed(getterFn, { set: setterFn })`.
333- In observable arrays, for `findIndex` / `find` method, the `offset` argument (the third one) is no longer supported, to be consistent with ES arrays.
334- The option `computedConfigurable` of `configure` is no longer supported as it is now the default.
335- `observableArray.toJS()` has been removed, use `observableArray.slice()` instead, which does the same.
336- Killed support for the `IGNORE_MOBX_MINIFY_WARNING` environment flag.
337- `_allowStateChangesInComputation(fn)` is no longer needed, use `runInAction(fn)` instead.
338- In `computed`, the `when` predicate (first arg), and `reaction` predicate (first arg) it is now forbidden to directly change state. State changes should be done in their effect functions, or otherwise at least wrapped in `runInAction` (only the state change, not the observables you want to track!). Note that this is still an anti-pattern.
339- The `observableArray.get()` and `observableArray.set()` methods are no longer supported.
340- The `IObservableObject` interface is no longer exported from MobX.
341- The second argument to the `reaction` effect function, the disposer object, is now passed in as third argument. The second argument is now the previous value seen by the reaction.
342- `onBecomeObserved` / `onBecomeUnobserved` will now only trigger for observables that are actually used by a reaction (see [#2309](https://github.com/mobxjs/mobx/issues/2309) for background).
343
344### Fixes
345
346- [#2326](https://github.com/mobxjs/mobx/issues/2326): Incorrect `this` for array callbacks such as in `array.forEach`
347- [#2379](https://github.com/mobxjs/mobx/issues/2379): Fixed issue with `array.concat`
348- [#2309](https://github.com/mobxjs/mobx/issues/2309): Fixed several inconsistencies between keepAlive'd computed values and `on(un)BecomeObserved`
349- Fixed several inconsistencies when `on(un)BecomeObserved` was triggered for observables changed in actions without having an observer
350
351## 5.15.7 / 4.15.7
352
353- Fixed [2438](https://github.com/mobxjs/mobx/issues/2438), factory types caused eslint warnings, by [@amareis](https://github.com/Amareis) through [2439](https://github.com/mobxjs/mobx/pull/2439)
354- Fixed [2432](https://github.com/mobxjs/mobx/issues/2423), array.reduce without initial value by [@urugator](https://github.com/urugator)
355
356## 5.15.6 / 4.15.6
357
358- Fixed [2423](https://github.com/mobxjs/mobx/issues/2423), array methods not dehancing by [@urugator](https://github.com/urugator)
359- Fixed [2424](https://github.com/mobxjs/mobx/issues/2424) Map / Set instantiation triggering a strict warning, through [#2425](https://github.com/mobxjs/mobx/pull/2425) by [@moonball](https://github.com/moonball)
360
361## 5.15.5 / 4.15.5
362
363- Fixed ObservableSet.prototype.forEach not being reactive in 4.x [#2341](https://github.com/mobxjs/mobx/pull/2341) by [@melnikov-s](https://github.com/melnikov-s)
364- Add error when computed value declared for unspecified getter [#1867](https://github.com/mobxjs/mobx/issues/1867) by [@berrunder](https://github.com/berrunder)
365- Fixed [#2326](https://github.com/mobxjs/mobx/issues/2326) correct array is passed to callbacks by [@urugator](https://github.com/urugator)
366- Fixed [#2278](https://github.com/mobxjs/mobx/issues/2278), `map.delete` should respect strict mode, by [@urugator](https://github.com/urugator)
367- Fixed [#2253](https://github.com/mobxjs/mobx/issues/2253), [#1980](https://github.com/mobxjs/mobx/issues/1980), map key order not always preserved by [@urugator](https://github.com/urugator)
368- Fixed [#2412](https://github.com/mobxjs/mobx/issues/2412), non-enumerable getters not being picked up by `extendObservable` by [@urugator](https://github.com/urugator)
369
370- Several performance improvements
371- Dropped `browser` fields from `package.json`
372
373## 5.15.4 / 4.15.4
374
375- Fix process.env replacement in build [#2267](https://github.com/mobxjs/mobx/pull/2267) by [@fredyc](https://github.com/fredyc)
376
377## 5.15.3 / 4.15.3
378
379- Define action name to be as the function name [#2262](https://github.com/mobxjs/mobx/pull/2262) by [@nadavkaner](https://github.com/nadavkaner)
380
381## 5.15.2 / 4.15.2
382
383- Fixed [#2230](https://github.com/mobxjs/mobx/issue/2230) computedvalue: throw error object instead of string when options is empty [#2243](https://github.com/mobxjs/mobx/pull/2243) by [@ramkumarvenkat](https://github.com/ramkumarvenkat)
384- supports ES6 Sets and Maps in shallow comparer. [#2238](https://github.com/mobxjs/mobx/pull/2238) by [@hearnden](https://github.com/hearnden)
385- `extendObservable`: can be used existing properties again. Fixes [#2250](https://github.com/mobxjs/mobx/issue/2250) through [#2252](https://github.com/mobxjs/mobx/pull/2252) by [@davefeucht](https://github.com/davefeucht)
386
387## 5.15.1 / 4.15.1
388
389- Make initial values of observable set accept readonly array [#2202](https://github.com/mobxjs/mobx/pull/2202)
390- Expose `_allowStateReadsStart` & `_allowStateReadsEnd`. This is low level stuff you shouldn't need that's mostly useful for library creators. [#2233](https://github.com/mobxjs/mobx/pull/2233)
391- Fixed an issue with `observableRequiresReaction` and updating observable during reaction [#2195](https://github.com/mobxjs/mobx/pull/2196)
392- Improved type inference for `action` [#2213](https://github.com/mobxjs/mobx/pull/2213) ([see detailed explanation](https://github.com/mobxjs/mobx/pull/2218#discussion_r349889440))
393
394## 5.15.0
395
396**The minimum required TypeScript version is now 3.6**
397
398- Fixed flow typings with Typescript v3.6. This means that version of Typescript is required when using flows.
399- Cancelled flows now reject with a `FlowCancellationError` instance whose error message is the same as in previous versions (`"FLOW_CANCELLED"`) so this is not breaking. [#2172](https://github.com/mobxjs/mobx/pull/2172) by [@vonovak](https://github.com/vonovak)
400- Fix running mobx in web worker [#2184](https://github.com/mobxjs/mobx/pull/2184/files) by [@shahata](https://github.com/shahata)
401- Fixed flow typings for Facebook's Flow. A new `CancellablePromise` Flow type is exported. [#2164](https://github.com/mobxjs/mobx/pull/2164) by [@vonovak](https://github.com/vonovak)
402- Added support for symbol keys on observable properties (MobX 5 only). [#2175](https://github.com/mobxjs/mobx/pull/2175) by [@StephenHaney](https://github.com/StephenHaney)
403
404## 5.14.2
405
406- Fixed installation issue trying to run `postinstall` hook for a website [#2165](https://github.com/mobxjs/mobx/issues/2165).
407
408## 5.14.1 / 4.14.1
409
410- Fixed a possible issue with action stack errors and multiple mobx versions installed at the same time [#2135](https://github.com/mobxjs/mobx/issues/2135).
411- Added `comparer.shallow` for shallow object/array comparisons [#1561](https://github.com/mobxjs/mobx/issues/1561).
412- Fixed disposing an interception within an interception throwing an error [#1950](https://github.com/mobxjs/mobx/issues/1950).
413
414## 5.14.0 / 4.14.0
415
416- Added experimental `reactionRequiresObservable` & `observableRequiresReaction` config [#2079](https://github.com/mobxjs/mobx/pull/2079), [Docs](https://github.com/mobxjs/mobx/pull/2082)
417- Added experimental `requiresObservable` config to `reaction`, `autorun` & `when` options [#2079](https://github.com/mobxjs/mobx/pull/2079), [Docs](https://github.com/mobxjs/mobx/pull/2082)
418
419## 5.13.1 / 4.13.1
420
421- Don't use `global` and `self` keywords unless defined. Fixes [#2070](https://github.com/mobxjs/mobx/issues/2070).
422- onBecome(Un)Observed didn't trigger when using number as key of observable map. Fixes [#2067](https://github.com/mobxjs/mobx/issues/2067).
423- Exposed `_startAction` and `_endAction` to be able to start and action and finish it without needing a code block. This is low level stuff you shouldn't need that's mostly useful for library creators.
424
425## 5.13.0 / 4.13.0
426
427- Fixed potential memory leak in observable maps, when non-primitive values are used as keys. Fixes [#2031](https://github.com/mobxjs/mobx/issues/2031) through [#2032](https://github.com/mobxjs/mobx/pull/2032).
428- Added support to store additional non-observable(!) fields (string or symbol based) on array, to better reflect behavior of MobX 4. Fixes [#2044](https://github.com/mobxjs/mobx/issues/2044) through [#2046](https://github.com/mobxjs/mobx/pull/2046)
429
430## 5.11.0 / 4.12.0
431
432- Added `computedConfigurable` config [#2011](https://github.com/mobxjs/mobx/pull/2011), [#2013](https://github.com/mobxjs/mobx/pull/2014)
433
434## 4.11.0
435
436**BREAKING CHANGE**
437
438Reverted the support of Symbols in general in MobX 4, as it gives to many potential build errors and increases the system requirements for MobX 4 (which was an oversight in 4.10.0). Apologies for the breaking change (lack of new major version numbers). If lock files are properly used however, no harm should be caused by this change.
439
440- Reverted `Symbol` support in observable maps and objects. Reverts [#1944](https://github.com/mobxjs/mobx/pull/1944) through [#1988](https://github.com/mobxjs/mobx/pull/1988). Fixes [#1986](https://github.com/mobxjs/mobx/issues/1986), [#1987](https://github.com/mobxjs/mobx/issues/1987)
441
442## 5.10.1
443
444- Fixed a recent regression where array update events would send undefined as `change.object` through [#1985](https://github.com/mobxjs/mobx/pull/1985) by [xaviergonz](https://github.com/xaviergonz)
445
446## 5.10.0 / 4.10.0
447
448- Added support for symbol named properties in maps and objects. Fixes [#1809](https://github.com/mobxjs/mobx/issues/1809) and [#1925](https://github.com/mobxjs/mobx/issues/1925) through [#1944](https://github.com/mobxjs/mobx/pull/1944) by [@loklaan](https://github.com/loklaan)
449- Added `set` support for `observable.set`, see [#1945](https://github.com/mobxjs/mobx/pull/1945) by [xaviergonz](https://github.com/xaviergonz)
450- Fixed events for arrays using the wrong object, [#1964](https://github.com/mobxjs/mobx/pull/1964) by [xaviergonz](https://github.com/xaviergonz)
451- Improved flow typings [#1960](https://github.com/mobxjs/mobx/pull/1960) by [@tbezman](https://github.com/tbezman)
452- Updated tooling, [#1949](https://github.com/mobxjs/mobx/pull/1949) and [#1931](https://github.com/mobxjs/mobx/pull/1931) by [xaviergonz](https://github.com/xaviergonz)
453
454## 5.9.4 / 4.9.4
455
456- Allow symbol keys in `ObservableMap`, see [#1930](https://github.com/mobxjs/mobx/pull/1930) by [pimterry](https://github.com/pimterry)
457- Fixed type definitions of `toStringTag` for Maps and Sets, see [#1929](https://github.com/mobxjs/mobx/pull/1929) by [lennerd](https://github.com/lennerd)
458
459## 4.9.3
460
461- Fixed `observable.set` compatibility with IE 11, see [#1917](https://github.com/mobxjs/mobx/pull/1917) by [kalmi](https://github.com/kalmi)
462
463## 4.9.2
464
465- Fixed regression [#1878](https://github.com/mobxjs/mobx/issues/1878), accidental use of `Symbol` breaking Internet Explorer / React Native compatibility.
466
467## 4.9.1
468
469- Fixed regression in `toJS`: observable maps were not properly serialized. Fixes [#1875](https://github.com/mobxjs/mobx/issues/1875)
470
471## 5.9.0 / 4.9.0
472
473**Features**
474
475- Introduced support for observable sets! Through [#1592](https://github.com/mobxjs/mobx/pull/1592) by [@newraina](https://github.com/newraina)
476- `observable.box` now accepts an `equals` option, to be able to pass a custom comparision function. Through [#1862](https://github.com/mobxjs/mobx/pull/1862), [#1874](https://github.com/mobxjs/mobx/pull/1874) by [@fi3ework](https://github.com/fi3ework). Fixes [#1580](https://github.com/mobxjs/mobx/issues/1580)
477- Improved logging of reactions; if an action throws an exception, errors in reactions that react to that are only logged as warnings. Fixes [#1836](https://github.com/mobxjs/mobx/issues/1836)
478
479**Fixes**
480
481- Improved typings for `flow`, see [#1827](https://github.com/mobxjs/mobx/pull/1827) by [@xaviergonz](https://github.com/xaviergonz)
482- Don't allow subclassing map, fixes [#1858](https://github.com/mobxjs/mobx/issues/1858)
483- Fixed `trace(true)` not being able to handle multi-line comments in traced function. Fixes [#1850](https://github.com/mobxjs/mobx/issues/1850)
484- `@computed` now introduces non-configurable properties, to fail fast on incorrect inheritance or property deletion. Fixes [#1867](https://github.com/mobxjs/mobx/issues/1867)
485- The options `enforceActions` and `isolateGlobalState` now work correctly when used together. Fixes [#1869](https://github.com/mobxjs/mobx/issues/1869)
486
487## 5.8.0 / 4.8.0
488
489- MobX now requires TypeScript 3 (this was already the case in 5.7.0, but in this version the difference is actually noticeable in the typings).
490- Fixed array dehancer sometimes skipping. Fixes [#1839](https://github.com/mobxjs/mobx/issues/1839) through [#1841](https://github.com/mobxjs/mobx/pull/1841) by [k-g-a](https://github.com/k-g-a)
491- Fixed issue where webpack 4 wouldn't use the ESM module [#1834](https://github.com/mobxjs/mobx/pull/1834) by [mrtnbroder](https://github.com/mrtnbroder)
492- Improved type inference for `flow` in TypeScript 3. Fixes [#1816](https://github.com/mobxjs/mobx/issue/1816) through [#1825](https://github.com/mobxjs/mobx/pull/1825) by [ismailhabib](https://github.com/ismailhabib)
493- Introduced support for global environment variable `IGNORE_MOBX_MINIFIY_WARNING=true` to skip the built-in minification warning. See [#1835](https://github.com/mobxjs/mobx/pull/1835) by [fi3ework](https://github.com/fi3ework)
494- Fixed onBecome(Un)Observed dispoer cleanup. Fixes [#1537](https://github.com/mobxjs/mobx/issues/1537) through [#1833](https://github.com/mobxjs/mobx/pull/1833) by [fi3ework](https://github.com/fi3ework)
495
496## 5.7.1 / 4.7.1
497
498- Fixed [#1839](https://github.com/mobxjs/mobx/issues/1839), ObservableArrayAdministration.dehanceValues does not dehance last value.
499
500## 5.7.0 / 4.7.0
501
502- Upgraded typings to TypeScript 3
503- Fixed [#1742](https://github.com/mobxjs/mobx/issues/1742), change detection fails when multiple mobx instances were active.
504- Fixed [#1624](https://github.com/mobxjs/mobx/issues/1624), use built-in flow types for iterators
505- Fixed [#1777](https://github.com/mobxjs/mobx/issues/1777) through [#1826](https://github.com/mobxjs/mobx/pull/1826), stack overflow exception, in development mode, when using `@computed` on a React component. The MobX 5 behavior here has been reverted to the MobX 4 behavior.
506
507## 5.6.0 / 4.6.0
508
509- `keepAlive` has become smarter and won't recomputed computed values that are kept alive, as long as they aren't read. Implements [#1534](https://github.com/mobxjs/mobx/issues/1534)
510- Fixed [#1796](https://github.com/mobxjs/mobx/issues/1796), undeleting a property that had an initial value of `undefined` was undetected
511- Improved Flow typings, see [#1794](https://github.com/mobxjs/mobx/pull/1794) and [#1786](https://github.com/mobxjs/mobx/pull/1786)
512
513## 5.5.2 / 4.5.2
514
515- Fixed bug in `toJS` not handling `null` values correctly. Fixes [#1557](https://github.com/mobxjs/mobx/issues/1557) through [#1783](https://github.com/mobxjs/mobx/pull/1783) by [@wangyiz4262](https://github.com/wangyiz4262)
516
517## 5.5.1 / 4.5.1
518
519- `toJS` now has a `recurseEverything` everything option, that even detects and converts observable objects that are "behind" non-observable objects. See [#1699](https://github.com/mobxjs/mobx/pull/1699) by [wangyiz4262](https://github.com/wangyiz4262)
520- Added flow typings form `comparer`, see [#1751](https://github.com/mobxjs/mobx/pull/1752) by [pdong](https://github.com/pdong)
521- Update flow typings for configuration options, [#1772](https://github.com/mobxjs/mobx/pull/1772) by [alexandersorokin](https://github.com/alexandersorokin)
522
523## 5.5.0 / 4.5.0
524
525(Minor version of `5` was bumped significantly to make the number better correlate together :-))
526
527- Fixed [#1740](https://github.com/mobxjs/mobx/issues/1740): combining decorators and `extendObservable` in a class constructor caused errors to be thrown
528- Fixed [#1739](https://github.com/mobxjs/mobx/issues/1740):
529 - Proxies: `delete`-ing a property was not always picked up by the reactivity system
530 - Non-proxies: `remove()`-ing a property was not always picked up by the `has()` and `get()` utilities
531 - `has` now returns `true` for computed fields
532 - `get` now returns a value for computed fields
533- Introduced `_allowStateChangeInsideComputed`. Don't use it :-).
534- MobX is now transpiled using babel 7
535
536## 5.1.2 / 4.4.2
537
538- Fixed [#1650](https://github.com/mobxjs/mobx/issues/1650), decorating fields with the name `toString` does not behave correctly.
539
540## 5.1.1 / 4.4.1
541
542- Improved typings of `decorate`, see [#1711](https://github.com/mobxjs/mobx/pull/1711) by [makepost](https://github.com/makepost)
543
544## 5.1.0 / 4.4.0
545
546- Improved handling of multiple MobX instances. MobX will no longer complain about being loaded multiple times (one should still prevent it though, to prevent blowing up bundle size!), but merge internal state by default. If multiple MobX versions need to be loaded, call `configure({ isolateGlobalState: true })`. Note that this means that observables from the different MobX instances won't cooperate. Fixes [#1681](https://github.com/mobxjs/mobx/issues/1681), [#1082](https://github.com/mobxjs/mobx/issues/1082)
547- `enforceActions` options now supports the values: `"never"`, `"observed"` and `"always"` to make the behavior more clear. Fixes [#1680](https://github.com/mobxjs/mobx/issues/1680), [#1473](https://github.com/mobxjs/mobx/issues/1473)
548
549## 5.0.5
550
551- Fixed [#1667](https://github.com/mobxjs/mobx/issues/1667): creating a large array could result in undefined items (MobX 4.\* was not affected)
552
553## 4.3.2 / 5.0.4
554
555- Fixed [#1685](https://github.com/mobxjs/mobx/issues/1685): expose `IAutorunOptions`
556- `decorate` now can apply multiple decorators, by accepting an array and applying them right to left: `decorate(Todo, { title: [serializable(primitive), persist('object'), observable] })`. By [@ramybenaroya](https://github.com/ramybenaroya) through [#1691](https://github.com/mobxjs/mobx/pull/1691) and [#1686](https://github.com/mobxjs/mobx/pull/1686)
557- Improved typings of `flow` so that it accepts async generators. By [@dannsam](https://github.com/dannsam) through [#1656](https://github.com/mobxjs/mobx/pull/1656) and [#1655](https://github.com/mobxjs/mobx/pull/1655)
558- `keys()` now also supports arrays. Fixes [#1600](https://github.com/mobxjs/mobx/pull/1600) through [#1601](https://github.com/mobxjs/mobx/pull/1601) by [@nunocastromartins](https://github.com/nunocastromartins)
559
560## 5.0.3
561
562- Fixed issue where it was no longer possible to define custom properties on observable arrays
563
564## 5.0.2
565
566- Fixed issue where iterators where not compiled to ES5, breaking the ES5 based builds.
567
568## 5.0.1 (Unpublished)
569
570- Fixed regression bug: `ObservableMap.size` was no longer observable. Fixes [#1583](https://github.com/mobxjs/mobx/issues/1583)
571- Downgraded lib export from ES6 to ES5. To many build tools still trip over ES6. Fixes [#1584](https://github.com/mobxjs/mobx/issues/1584). A modern build is available through `import ... from "mobx/lib/mobx.es6"` (or setup an alias in your build system)
572- Added support for mobx-react-devtools
573
574## 5.0.0
575
576[Release blogpost](https://medium.com/p/4852bce05572/)
577
578### Proxy support!
579
580MobX 5 is the first MobX version fully leveraging Proxies. This has two big advantages
581
5821. MobX can now detect the addition of properties on plain observable objects, so it is now possible to use plain observable objects as dynamic collections.
5832. Observable arrays are now recognized as arrays by all third party libraries, which will avoid the need to slice them.
584
585### The system requirements to run MobX has been upped
586
587- MobX 5 can only be used on environments that support `Proxies`. See the [browser support](https://github.com/mobxjs/mobx#browser-support) for details.
588- Since MobX no longer runs on older browsers, the compilation target has been upgraded to ES2015 syntax supporting browsers. This means that MobX is not loadable on older browsers without down compilation to ES5.
589- If for whatever reason your project cannot meet this requirements, please stick to MobX 4. It will be actively maintained. All current features of MobX 5 are expressable in MobX 4 as well, but it means that for example to use dynamic objects some [additional APIs](https://mobx.js.org/refguide/object-api.html) are needed.
590- The performance footprint of MobX 5 should be pretty similar to MobX 4. In our performance tests we saw some minor improvements in memory footprint, but overall it should be pretty comparable.
591
592### Breaking changes
593
594- The required runtime needs to support the non-polyfillable `Proxy` API.
595- The minimum runtime target is now ES2015, not ES5
596- `spy` has become a no-op in production builds
597- All earlier deprecated APIs are dropped. Make sure to not have any deprecation warnings before upgrading.
598- `array.move` and `array.peek` are removed from the API
599- Dropped the third argument to `array.find` and `array.findIndex` since they were not standardized in ES.
600- `.$mobx` property has been dropped from all observables and replaced by a Symbol. Instead of using `x.$mobx.name`, use `import { $mobx } from "mobx"; x[$mobx].name` etc.
601- In some cases, the order in which autoruns are fired could have changed due to some internal optimizations (note that MobX never had a guarantee about the order in which autoruns fired!)
602
603### New features
604
605- It is possible to pass the `proxy: false` argument to `observable.object` to disable proxying (theoretically slightly faster, but removes no dynamic key addition)
606
607### Known Issues
608
609- Observable objects can no longer be frozen (otherwise they would become un-observable😎). If you are actually trying to do so MobX will now throw an exception like: `[mobx] Dynamic observable objects cannot be frozen]`. A place where that might happen unexpectedly is when passing an observable object as `style` property to a React component. Like `<span style={someObservableObject} />`, since React will freeze all style objects. The work-around is to simply pass a fresh, non-observable object for styling like: `<span style={{...someObservableObject}} />`.
610- ~~If you are using `mobx` with `mobx-react`, and you are upgrading `mobx-react` to the MobX 5 compatible version (`mobx-react@5.2.0`) you will notice that `this.props` or `this.state` are not yet observable in the `constructor` or `componentWillMount`. This is for forward compatibility with React 16.3 where `componentWillMount` has been deprecated. In most cases using `componentDidMount` instead will suffice, especially when the goal is to setup reactions. For more info see [#478](https://github.com/mobxjs/mobx-react/issues/478).~~ Fixed in mobx-react 5.2.1. But note that you should still migrate away from `componentWillMount`😎.
611- Jest `toEqual` might throw an error `allKeys[x].match is not a function` when trying to equal observable arrays. This is a bug in Jest [report](https://github.com/facebook/jest/issues/6398). The simple work around for now is to slice (or `toJS` if the problem is recursive) the array first.
612- Jest `toEqual` matcher might no longer correctly equal your class instances, complaining about differences in the MobX adminstration. This is due to a bug with the processing of symbols: [report](https://github.com/facebook/jest/issues/6392). For now you might want to use a custom matcher if you are directly equalling observable objects. As a work around `toJS(object)` could be used before diffing.
613
614_Note June 7th, 2018:_ Both issues are already in Jest master and should be released soon.
615
616### Migration guide
617
618- Make sure to not use any API that produces deprecation warnings in MobX 4. Beyond that MobX 5 should pretty well as drop-in replacement of MobX 4.
619- You _could_ perform the following clean ups:
620 - Don't `slice()` arrays when passing them to external libraries. (Note you still shouldn't pass observable data structures to non-`observer` React components, which is an orthogonal concept)
621 - You could replace observable maps with observable objects if you are only using string-based keys.
622- Don't call the `reverse` or `sort` operations directly on observableArray's anymore, as it's behavior slightly differed from the built-in implementations of those methods. Instead use `observableArray.slice().sort()` to perform the sort on a copy. This gives no additional performance overhead compared to MobX 4. (The reason behind this is that built-in `sort` updates the array in place, but the observable array implementation always performed the sort on a defensive copy, and this change makes that explicit).
623- you may remove usages of `isArrayLike()` since `Array.isArray()` will now return true for observable arrays
624
625### API's that have been dropped
626
627- The `arrayBuffer` setting is no longer supported by `configure` (it has become irrelevant)
628- `observable.shallowBox`, `observable.shallowArray`, `observable.shallowMap`, `observable.shallowObject`, `extendShallowObservable` api's have been removed. Instead, pass `{ deep: false }` to their non-shallow counter parts.
629- `observableArray.peek`, `observableArray.move`
630
631## 4.3.1
632
633- Fixed [#1534](Fixes https://github.com/mobxjs/mobx/issues/1534): @computed({keepAlive: true}) no long calculates before being accessed.
634- Added the `$mobx` export symbol for MobX 5 forward compatibity
635
636## 4.3.0
637
638- Introduced the `entries(observable)` API, by @samjacobclift through [#1536](https://github.com/mobxjs/mobx/pull/1536)
639- Fixed [#1535](https://github.com/mobxjs/mobx/issues/1535): Change in nested computed value was not propagated if read outside action context when there is a pending reaction. For more details see the exact test case.
640- Illegal property access through prototypes is now a warning instead of an error. Fixes [#1506](https://github.com/mobxjs/mobx/issues/1506). By @AmazingTurtle through [#1529](https://github.com/mobxjs/mobx/pull/1529)
641- Fixed issue where providing a custom setter to `@computed({ set: ... })` wasn't picked up
642- Fixed #1545: Actions properties where not re-assignable when using TypeScript
643- Illegal Access checks are now a warning instead of an error. Fix
644
645## 4.2.1
646
647- Fixed flow typings for `mobx.configure` [#1521](https://github.com/mobxjs/mobx/pull/1521) by @andrew--r
648- Improved typings for `mobx.flow`, fixes [#1527](https://github.com/mobxjs/mobx/issues/1527)
649- Throw error when using `@observable` in combination with a getter. [#1511](https://github.com/mobxjs/mobx/pull/1511) by @quanganhtran
650- `toJS` now uses Map internally, for faster detection of cycles. [#1517](https://github.com/mobxjs/mobx/pull/1517) by @loatheb
651- Fixed [#1512](https://github.com/mobxjs/mobx/issues/1512): `observe` hooks not being triggered when using `mobx.set`, Fixed in [#1514](https://github.com/mobxjs/mobx/pull/1514) by @quanganhtran
652- Several minor improvements, additional tests and doc improvements.
653
654## 4.2.0
655
656- Introduced `configure({ enforceActions: "strict" })`, which is more strict then `enforceActions: true`, as it will also throw on non-observed changes to observables. See also [#1473](https://github.com/mobxjs/mobx/issues/1473)
657- Fixed [#1480](https://github.com/mobxjs/mobx/issues/1480): Exceptions in the effect handler of `reaction` where not properly picked up by the global reaction system
658- Fixed a bug where computed values updated their cached value, even when the comparer considered the new value equal to the previous one. Thanks @kuitos for finding this and fixing it! [#1499](https://github.com/mobxjs/mobx/pull/1499)
659- Undeprecated `ObservableMap`, fixes [#1496](https://github.com/mobxjs/mobx/issues/1496)
660- Observable arrays now support `Symbol.toStringTag` (if available / polyfilled). This allows libraries like Ramda to detect automatically that observable arrays are arrays. Fixes [#1490](https://github.com/mobxjs/mobx/issues/1490). Note that `Array.isArray` will keep returning false for the entire MobX 4 range.
661- Actions are now always `configurable` and `writable`, like in MobX 3. Fixes [#1477](https://github.com/mobxjs/mobx/issues/1477)
662- Merged several improvements to the flow typings. [#1501](https://github.com/mobxjs/mobx/pull/1501) by @quanganhtran
663- Fixed several accidental usages of the global `fail`, by @mtaran-google through [#1483](https://github.com/mobxjs/mobx/pull/1483) and [#1482](https://github.com/mobxjs/mobx/pull/1482)
664
665## 4.1.1
666
667- Import `default` from MobX will no longer throw, but only warn instead. This fixes some issues with tools that reflect on the `default` export of a module
668- Disposing a spy listener inside a spy handler no longer causes an exception. Fixes [#1459](https://github.com/mobxjs/mobx/issues/1459) through [#1460](https://github.com/mobxjs/mobx/pull/1460) by [farwayer](https://github.com/farwayer)
669- Added a missing `runInAction` overload in the flow typings. [#1451](https://github.com/mobxjs/mobx/pull/1451) by [AMilassin](https://github.com/mobxjs/mobx/issues?q=is%3Apr+author%3AAMilassin)
670- Improved the typings of `decorate`. See [#1450](https://github.com/mobxjs/mobx/pull/1450) by [makepost](https://github.com/mobxjs/mobx/issues?q=is%3Apr+author%3Amakepost)
671
672## 4.1.0
673
674- Introduced `keepAlive` as option to `computed`
675- All observable api's now default to `any` for their generic arguments
676- Improved `flow` cancellation
677- The effect of `when` is now automatically an action.
678- `@computed` properties are now declared on their owner rather then the protoptype. Fixes an issue where `@computed` fields didn't work in React Native on proxied objects. See [#1396](https://github.com/mobxjs/mobx/issues/1396)
679- `action` and `action.bound` decorated fields are now reassignable, so that they can be stubbed
680
681## 4.0.2
682
683- Fixed issue where exceptions like `TypeError: Cannot define property:__mobxDidRunLazyInitializers, object is not extensible.` were thrown. Fixes [#1404](https://github.com/mobxjs/mobx/issues/1404)
684- Improved flow typings for `flow`, [#1399](https://github.com/mobxjs/mobx/pull/1399) by @ismailhabib
685
686## 4.0.1
687
688- Updated flow typings, see [#1393](https://github.com/mobxjs/mobx/pull/1393) by [andrew--r](https://github.com/andrew--r)
689
690## 4.0.0
691
692- For the highlights of this release, read the [blog](https://medium.com/p/c1fbc08008da/):
693- For migration notes: see the [wiki page](https://github.com/mobxjs/mobx/wiki/Migrating-from-mobx-3-to-mobx-4)
694- Note; many things that were removed to make the api surface smaller. If you think some feature shouldn't have been removed, feel free to open an issue!
695
696This is the extensive list of all changes.
697
698### New features
699
700The changes mentioned here are discussed in detail in the [release highlights](https://medium.com/p/c1fbc08008da/), or were simply updated in the docs.
701
702- MobX 4 introduces separation between the production and non production build. The production build strips most typechecks, resulting in a faster and smaller build. Make sure to substitute process.env.NODE_ENV = "production" in your build process! If you are using MobX in a react project, you most probably already have set this up. Otherwise, the idea is explained [here](https://reactjs.org/docs/add-react-to-an-existing-app.html).
703- Introduced `flow` to create a chain of async actions. This is the same function as [`asyncActions`](https://github.com/mobxjs/mobx-utils#asyncaction) of the mobx-utils package
704- These `flow`'s are now cancellable, by calling `.cancel()` on the returned promise, which will throw a cancellation exception into the generator function.
705- `flow` also has experimental support for async iterators (`async * function`)
706- Introduced `decorate(thing, decorators)` to decorate classes or object without needing decorator syntax.
707- Introduced `onBecomeObserved` and `onBecomeUnobserved`. These API's enable hooking into the observability system and get notified about when an observable starts / stops becoming used. This is great to automaticaly fetch data from external resources, or stop doing so.
708- `computed` / `@computed` now accepts a `requiresReaction` option. If it set, the computed value will throw an exception if it is being read while not being tracked by some reaction.
709- To make `requiresReaction` the default, use `mobx.configure({ computedRequiresReaction: true })`
710- Introduced `mobx.configure({ disableErrorBoundaries })`, for easier debugging of exceptoins. By [NaridaL](https://github.com/NaridaL) through [#1262](https://github.com/mobxjs/mobx/pull/1262)
711- `toJS` now accepts the options: `{ detectCycles?: boolean, exportMapsAsObjects?: boolean }`, both `true` by default
712- Observable maps are now backed by real ES6 Maps. This means that any value can be used as key now, not just strings and numbers.
713- The flow typings have been updated. Since this is a manual effort, there can be mistakes, so feel free to PR!
714
715- `computed(fn, options?)` / `@computed(options) get fn()` now accept the following options:
716
717 - `set: (value) => void` to set a custom setter on the computed property
718 - `name: "debug name"`
719 - `equals: fn` the equality value to use for the computed to determine whether its output has changed. The default is `comparer.default`. Alternatives are `comparer.structural`, `comparer.identity` or just your own comparison function.
720 - `requiresReaction: boolean` see above.
721
722- `autorun(fn, options?)` now accepts the following options:
723
724 - `delay: number` debounce the autorun with the given amount of milliseconds. This replaces the MobX 3 api `autorunAsync`
725 - `name: "debug name"`
726 - `scheduler: function` a custom scheduler to run the autorun. For example to connect running the autorun to `requestAnimationFrame`. See the docs for more details
727 - `onError`. A custom error handler to be notified when an autorun throws an exception.
728
729- `reaction(expr, effect, options?)` now accepts the following options:
730
731 - `delay: number` debounce the autorun with the given amount of milliseconds. This replaces the MobX 3 api `autorunAsync`
732 - `fireImmediately`. Immediately fire the effect function after the first evaluation of `expr`
733 - `equals`. Custom equality function to determine whether the `expr` function differed from its previous result, and hence should fire `effect`. Accepts the same options as the `equals` option of computed.
734 - All the options `autorun` accepts
735
736- `when(predicate, effect?, options?)` now accepts the following options:
737 - `name: "debug name"`
738 - `onError`. A custom error handler to be notified when an autorun throws an exception.
739 - `timeout: number` a timeout in milliseconds, after which the `onError` handler will be triggered to signal the condition not being met within a certain time
740- The `effect` parameter of `when` has become optional. If it is omitted, `when` will return a promise. This makes it easy to `await` a condition, for example: `await when(() => user.profile.loaded)`. The returned promise can be cancelled using `promise.cancel()`
741
742- There is now an utility API that enables manipulating observable maps, objects and arrays with the same api. These api's are fully reactive, which means that even new property declarations can be detected by mobx if `set` is used to add them, and `values` or `keys` to iterate them.
743
744 - `values(thing)` returns all values in the collection as array
745 - `keys(thing)` returns all keys in the collection as array
746 - `set(thing, key, value)` or `set(thing, { key: value })` Updates the given collection with the provided key / value pair(s).
747 - `remove(thing, key)` removes the specified child from the collection. For arrays splicing is used.
748 - `has(thing, key)` returns true if the collection has the specified _observable_ property.
749 - `get(thing, key)` returns the chlid under the specified key.
750
751- `observable`, `observable.array`, `observable.object`, `observable.map` and `extendObservable` now accept an additional options object, which can specify the following attributes:
752 - `name: "debug name"`
753 - `deep: boolean`. `true` by default, indicates whether the children of this collection are automatically converted into observables as well.
754 - `defaultDecorator: <decorator>` specifies the default decorator used for new children / properties, by default: `observable.deep`, but could be changed to `observable.ref`, `observable.struct` etc. (The `deep` property is just a short-hand for switching between `observable.deep` or `observable.ref` as default decorator for new properties)
755
756### Breaking changes
757
758The changes mentioned here are discussed in detail in the [migration notes](https://github.com/mobxjs/mobx/wiki/Migrating-from-mobx-3-to-mobx-4)
759
760- MobX 4 requires `Map` to be globally available. Polyfill it if targeting IE < 11 or other older browsers.
761- For typescript users, MobX now requires `Map` and several `Symbol`s to exist for its typings. So make sure that the `lib` configuration of your project is set to `"es6"`. (The compilation target can still be `"es5"`)
762- `observable.shallowArray(values)` has been removed, instead use `observable.array(values, { deep: false })`
763- `observable.shallowMap(values)` has been removed, instead use `observable.map(values, { deep: false })`
764- `observable.shallowObject(values)` has been removed, instead use `observable.object(values, {}, { deep: false })`
765- `extendShallowObservable(target, props)`, instead use `extendObservable(target, props, {}, { deep: false })`
766- The decorators `observable.ref`, `observable.shallow`, `observable.deep`, `observable.struct` can no longer be used as functions. Instead, they should be passed as part of the `decorators` param to resp. `observable.object` and `extendObservable`
767- The new signature of `extendObservable` is `extendObservable(target, props, decorators?, options?)`. This also means it is no longer possible to pass multiple bags of properties to `extendObservable`. ~~`extendObservable` can no longer be used to re-declare properties. Use `set` instead to update existing properties (or introduce new ones).~~ Update 13-01-2020: the latter limitation has been reverted in MobX 4.15.2 / 5.15.2
768- Iterating maps now follows the spec, that is, `map.values()`, `map.entries()`, `map.keys()`, `map[@@iterator]()` and `array[@@iterator]()` no longer return an array, but an iterator. Use `mobx.values(map)` or `Array.from(map)` to convert the iterators to arrays.
769- dropped `@computed.equals`, instead, you can now use `@computed({ equals: ... })`
770- `useStrict(boolean)` was dropped, use `configure({ enforceActions: boolean })` instead
771- `isolateGlobalState` was dropped, use `configure({ isolateGlobalState: true})` instead
772- If there are multiple mobx instances active in a single project, an exception will be thrown. Previously only a warning was printed. Fixes #1098. For details, see [#1082](https://github.com/mobxjs/mobx/issues/1082).
773- Dropped the `shareGlobalState` feature. Instead, projects should be setup properly and it is up to the hosting package to make sure that there is only one MobX instance
774- `expr` has been moved to mobx-utils. Remember, `expr(fn)` is just `computed(fn).get()`
775- `createTransformer` has been moved to mobx-utils
776- Passing `context` explicitly to `autorun`, `reaction` etc is no longer supported. Use arrow functions or function.bind instead.
777- Removed `autorunAsync`. Use the `delay` option of `autorun` instead.
778- `autorun`, `when`, `reaction` don't support name as first argument anymore, instead pass the `name` option.
779- The `extras.` namespace has been dropped to enable tree-shaking non-used MobX features. All methods that where there originally are now exported at top level. If they are part of the official public API (you are encouraged to use them) they are exported as is. If they are experimental or somehow internal (you are discouraged to use them), they are prefixed with `_`.
780- Dropped bower support. Fixes #1263
781- The `spyReportStart`, `spyReportEnd`, `spyReport` and `isSpyEnabled` are no longer public. It is no longer possible to emit custom spy events as to avoid confusing in listeners what the possible set of events is.
782- Dropped `isStrictModeEnabled`
783- `observable(value)` will only succeed if it can turn the value into an observable data structure (a Map, Array or observable object). But it will no longer create an observable box for other values to avoid confusion. Call `observable.box(value)` explictly in such cases.
784- `isComputed` and `isObservable` no longer accept a property as second argument. Instead use `isComputedProp` and `isObservableProp`.
785- Removed `whyRun`, use `trace` instead
786- The spy event signature has slightly changed
787- The `Atom` class is no longer exposed. Use `createAtom` instead (same signature).
788- Calling reportObserved() on a self made atom will no longer trigger the hooks if reportObserved is triggered outside a reactive context.
789- The options `struct` and `compareStructural` for computed values are deprecated, use `@computed.struct` or `computed({ equals: comparer.structural})` instead.
790- `isModifierDescriptor` is no longer exposed.
791- `deepEqual` is no longer exposed, use `comparer.structural` instead.
792- `setReactionScheduler` -> `configure({ reactionScheduler: fn })`
793- `reserveArrayBuffer` -> `configure({ reactionErrorHandler: fn })`
794- `ObservableMap` is no longer exposed as constructor, use `observable.map` or `isObservableMap` instead
795- `map` -> `observable.map`
796- `runInAction` no longer accepts a custom scope
797- Dropped the already deprecated and broken `default` export that made it harder to tree-shake mobx. Make sure to always use `import { x } from "mobx"` and not `import mobx from "mobx"`.
798- Killed the already deprecated modifiers `asFlat` etc. If you war still using this, see the MobX 2 -> 3 migration notes.
799- Observable maps now fully implement the map interface. See [#1361](https://github.com/mobxjs/mobx/pull/1361) by [Marc Fallows](https://github.com/marcfallows)
800- Observable arrays will no longer expose the `.move` method
801- Dropped the `observable.deep.struct` modifier
802- Dropped the `observable.ref.struct` modifier
803- `observable.struct` now behaves like `observable.ref.struct` (this used to be `observable.deep.struct`). That is; values in an `observable.struct` field will be stored as is, but structural comparison will be used when assigning a new value
804- IReactionDisposer.onError has been removed, use the `onError` option of reactions instead
805
806### Issues fixed in this release:
807
808The issues are incoprorated in the above notes.
809
810- [#1316](https://github.com/mobxjs/mobx/issues/1316) - Improve `observable` api
811- [#992](https://github.com/mobxjs/mobx/issues/992) - `onBecomeObserved` & `onBecomeUnobserved`
812- [#1301](https://github.com/mobxjs/mobx/issues/1301) - Set `onError` handler when creating reactions
813- [#817](https://github.com/mobxjs/mobx/issues/817) - Improve typings of `observe`
814- [#800](https://github.com/mobxjs/mobx/issues/800) - Use `Map` as backend implementation of observable maps
815- [#1361](https://github.com/mobxjs/mobx/issues/1361) - Make observableMaps structurally correct maps
816- [#813](https://github.com/mobxjs/mobx/issues/813) - Create separate dev and production builds
817- [#961](https://github.com/mobxjs/mobx/issues/961), [#1197](https://github.com/mobxjs/mobx/issues/1197) - Make it possible to forbid reading an untracked computed value
818- [#1098](https://github.com/mobxjs/mobx/issues/1098) - Throw instead of warn if multiple MobX instances are active
819- [#1122](https://github.com/mobxjs/mobx/issues/1122) - Atom hooks fired to often for observable maps
820- [#1148](https://github.com/mobxjs/mobx/issues/1148) - Disposer of reactions should also cancel all scheduled effects
821- [#1241](https://github.com/mobxjs/mobx/issues/1241) - Make it possible to disable error boundaries, to make it easier to find exceptions
822- [#1263](https://github.com/mobxjs/mobx/issues/1263) - Remove bower.json
823
824## 3.6.2
825
826- Fixed accidental dependency on the `node` typings. Fixes [#1387](https://github.com/mobxjs/mobx/issues/1387) / [#1362](https://github.com/mobxjs/mobx/issues/1387)
827
828## 3.6.1
829
830- Fixed [#1358](https://github.com/mobxjs/mobx/pull/1359): Deep comparison failing on IE11. By [le0nik](https://github.com/le0nik) through [#1359](https://github.com/mobxjs/mobx/pull/1359)
831
832## 3.6.0
833
834- Fixed [#1118](https://github.com/mobxjs/mobx/issues/1118), the deepEquals operator build into mobx gave wrong results for non-primitive objects. This affected for example `computed.struct`, or the `compareStructural` of `reaction`
835
836## 3.5.0/1
837
838- Introduced `trace` for easier debugging of reactions / computed values. See the [docs](https://mobx.js.org/best/trace.html) for details.
839- Improved typings of `observableArray.find`, see [#1324](https://github.com/mobxjs/mobx/pull/1324) for details.
840
841## 3.4.1
842
843- Republished 3.4.0, because the package update doesn't seem to distibute consistently through yarn / npm
844
845## 3.4.0
846
847- Improve Flow support by exposing typings regularly. Flow will automatically include them now. In your `.flowconfig` will have to remove the import in the `[libs]` section (as it's done [here](https://github.com/mobxjs/mobx/pull/1254#issuecomment-348926416)). Fixes [#1232](https://github.com/mobxjs/mobx/issues/1232).
848
849## 3.3.3
850
851- Fixed regression bug where observable map contents could not be replaced using another observable map [#1258](https://github.com/mobxjs/mobx/issues/1258)
852- Fixed weird exception abot not being able to read `length` property of a function, see[#1238](https://github.com/mobxjs/mobx/issues/1238) through [#1257](https://github.com/mobxjs/mobx/issues/1238) by @dannsam
853
854## 3.3.2
855
856- Fix bug where custom comparers could be invoked with `undefined` values. Fixes [#1208](https://github.com/mobxjs/mobx/issues/1208)
857- Make typings for observable stricter when using flow [#1194](https://github.com/mobxjs/mobx/issues/1194), [#1231](https://github.com/mobxjs/mobx/issues/1231)
858- Fix a bug where `map.replace` would trigger reactions for unchanged values, fixes [#1243](https://github.com/mobxjs/mobx/issues/1243)
859- Fixed issue where `NaN` was considered unequal to `NaN` when a deep compare was made [#1249](https://github.com/mobxjs/mobx/issues/1249)
860
861## 3.3.1
862
863- Fix bug allowing maps to be modified outside actions when using strict mode, fixes [#940](https://github.com/mobxjs/mobx/issues/940)
864- Fixed [#1139](https://github.com/mobxjs/mobx/issues/1139) properly: `transaction` is no longer deprecated and doesn't disable tracking properties anymore
865- Fixed [#1120](https://github.com/mobxjs/mobx/issues/1139): `isComputed` should return false for non-existing properties
866
867## 3.3.0
868
869- Undeprecated `transaction`, see [#1139](https://github.com/mobxjs/mobx/issues/1139)
870- Fixed typings of reaction [#1136](https://github.com/mobxjs/mobx/issues/1136)
871- It is now possible to re-define a computed property [#1121](https://github.com/mobxjs/mobx/issues/1121)
872- Print an helpful error message when using `@action` on a getter [#971](https://github.com/mobxjs/mobx/issues/971)
873- Improved typings of intercept [#1119](https://github.com/mobxjs/mobx/issues/1119)
874- Made code base Prettier [#1103](https://github.com/mobxjs/mobx/issues/1103)
875- react-native will now by default use the es module build as well.
876- Added support for Weex, see [#1163](https://github.com/mobxjs/mobx/pull/1163/)
877- Added workaround for Firefox issue causing MobX to crash, see [#614](https://github.com/mobxjs/mobx/issues/614)
878
879## 3.2.2
880
881- Fixes a bug (or a known limitation) described in [#1092](https://github.com/mobxjs/mobx/issue/1092/). It is now possible to have different observable administration on different levels of the prototype chain. By @guillaumeleclerc
882- Fixed a build issue when using mobx in a project that was using rollup, fixes [#1099](https://github.com/mobxjs/mobx/issue/1099/) by @rossipedia
883- Fixed typings of `useStrict`, by @rickbeerendonk
884
885## 3.2.1
886
887- Introduced customizable value comperators to reactions and computed values. `reaction` and `computed` now support an additional option, `equals`, which takes a comparision function. See [#951](https://github.com/mobxjs/mobx/pull/951/) by @jamiewinder. Fixes #802 and #943. See the updated [`computed` docs](https://mobx.js.org/refguide/computed-decorator.html) for more details.
888
889## 3.2.0
890
891- MobX will warn again when there are multiple instances of MobX loaded, as this lead to often to confusing bugs if the project setup was not properly. The signal mobx that multiple instances are loaded on purpose, use `mobx.extras.runInSandbox`. See [#1082](https://github.com/mobxjs/mobx/issues/1082) for details.
892
893## 3.1.17
894
895- Improved typings of `IObservableArray.intercept`: use more restrictive types for `change` parameter of `handler`, by @bvanreeven
896- Fixed [#1072](https://github.com/mobxjs/mobx/issues/1072), fields without a default value could not be observed yet when using TypeScript
897
898## 3.1.16
899
900- Restored `default` export (and added warning), which broke code that was importing mobx like `import mobx from "mobx"`. Use `import * as mobx from "mobx"` or use named importes instead. By @andykog, see #1043, #1050
901- Fixed several typos in exceptions and documentation
902
903## 3.1.15
904
905- Fixed issue where `array.remove` did not work correctly in combination with `extras.interceptReads`
906
907## 3.1.14
908
909- Fixed 3.1.12 / 3.1.13 module packing. See #1039; `module` target is now transpiled to ES5 as well
910
911## 3.1.13 (Unpublished: Uglify chokes on it in CRA)
912
913- Fixed build issue with webpack 2, see #1040
914
915## 3.1.12 (Unpublished: wasn't being bundled correctly by all bundlers)
916
917- Added support for ES modules. See #1027 by @rossipedia
918- Improved flow typings. See #1019 by @fb55
919- Introduced experimental feature `extras.interceptReads(observable: ObservableMap | ObservableArray | ObservableObject | ObservableBox, property?: string, handler: value => value): Disposer` that can be used to intercept _reads_ from observable objects, to transform values on the fly when a value is read. One can achieve similar things with this as with proxying reads. See #1036
920
921## 3.1.11
922
923- Using rollup as bundler, instead of custom hacked build scripts, by @rossipedia, see #1023
924
925## 3.1.10
926
927- Fixed flow typings for `when`, by @jamsea
928- Add flow typings for `map.replace`, by @leader22
929- Added `observableArray.findIndex`, by @leader22
930- Improved typings of `autorun` / `autorunAsync` to better support async / await, by @capaj
931- Fixed typings of `action.bound`, see #803
932
933## 3.1.9
934
935- Introduced explicit `.get(index)` and `.set(index, value)` methods on observable arrays, for issues that have trouble handling many property descriptors on objects. See also #734
936- Made sure it is safe to call `onBecomeObserved` twice in row, fixes #874, #898
937- Fixed typings of `IReactionDisposer`
938
939## 3.1.8
940
941- Fixed edge case where `autorun` was not triggered again if a computed value was invalidated by the reaction itself, see [#916](https://github.com/mobxjs/mobx/issues/916), by @andykog
942- Added support for primtive keys in `createTransformer`, See #920 by @dnakov
943- Improved typings of `isArrayLike`, see #904, by @mohsen1
944
945## 3.1.7
946
947- Reverted ES2015 module changes, as they broke with webpack 2 (will be re-released later)
948
949## 3.1.6 (Unpublished)
950
951- Expose ES2015 modules to be used with advanced bundlers, by @mohsen1, fixes #868
952- Improved typings of `IObservableArray.intercept`: remove superflous type parameter, by @bvanreeven
953- Improved typings of map changes, by @hediet
954
955## 3.1.5
956
957- Improved typings of map changes, see #847, by @hediet
958- Fixed issue with `reaction` if `fireImmediately` was combined with `delay` option, see #837, by @SaboteurSpk
959
960## 3.1.4
961
962- Observable maps initialized from ES6 didn't deeply convert their values to observables. (fixes #869,by @ggarek)
963
964## 3.1.3
965
966- Make sure that `ObservableArray.replace` can handle large arrays by not using splats internally. (See e.g. #859)
967- Exposed `ObservableArray.spliceWithArray`, that unlike a normal splice, doesn't use a variadic argument list so that it is possible to splice in new arrays that are larger then allowed by the callstack.
968
969## 3.1.2
970
971- Fixed incompatiblity issue with `mobx-react@4.1.0`
972
973## 3.1.1 (unpublished)
974
975- Introduced `isBoxedObservable(value)`, fixes #804
976
977## 3.1.0
978
979### Improved strict mode
980
981Strict mode has been relaxed a bit in this release. Also computed values can now better handle creating new observables (in an action if needed). The semantics are now as follows:
982
983- In strict mode, it is not allowed to modify state that is already being _observed_ by some reaction.
984- It is allowed to create and modify observable values in computed blocks, as long as they are not _observed_ yet.
985
986In order words: Observables that are not in use anywhere yet, are not protected by MobX strict mode.
987This is fine as the main goal of strict mode is to avoid kicking of reactions at undesired places.
988Also strict mode enforces batched mutations of observables (through action).
989However, for unobserved observables this is not relevant; they won't kick of reactions at all.
990
991This fixes some uses cases where one now have to jump through hoops like:
992
993- Creating observables in computed properties was fine already, but threw if this was done with the aid of an action. See issue [#798](https://github.com/mobxjs/mobx/issues/798).
994- In strict mode, it was not possible to _update_ observable values without wrapping the code in `runInAction` or `action`. See issue [#563](https://github.com/mobxjs/mobx/issues/563)
995
996Note that the following constructions are still anti patterns, although MobX won't throw anymore on them:
997
998- Changing unobserved, but not just created observables in a computed value
999- Invoke actions in computed values. Use reactions like `autorun` or `reaction` instead.
1000
1001Note that observables that are not in use by a reaction, but that have `.observe` listeners attached, do _not_ count towards being observed.
1002Observe and intercept callbacks are concepts that do not relate to strict mode, actions or transactions.
1003
1004### Other changes
1005
1006- Reactions and observable values now consider `NaN === NaN`, See #805 by @andykog
1007- Merged #783: extract error messages to seperate file, so that they can be optimized in production builds (not yet done), by @reisel, #GoodnessSquad
1008- Improved typings of actions, see #796 by @mattiamanzati
1009
1010## 3.0.2
1011
1012- Fixed issue where MobX failed on environments where `Map` is not defined, #779 by @dirtyrolf
1013- MobX can now be compiled on windows as well! #772 by @madarauchiha #GoodnessSquad
1014- Added documentation on how Flow typings can be used, #766 by @wietsevenema
1015- Added support for `Symbol.toPrimitive()` and `valueOf()`, see #773 by @eladnava #GoodnessSquad
1016- Supressed an exception that was thrown when using the Chrome Developer tools to inspect arrays, see #752
1017
1018Re-introduced _structural comparison_. Seems we couldn't part from it yet :). So the following things have been added:
1019
1020- `struct` option to `reaction` (alias for `compareStructural`, to get more consistency in naming)
1021- `observable.struct`, as alias for `observable.deep.struct`
1022- `observable.deep.struct`: Only stores a new value and notify observers if the new value is not structurally the same as the previous value. Beware of cycles! Converts new values automatically to observables (like `observable.deep`)
1023- `observable.ref.struct`: Only stores a new value and notify observers if the new value is not structurally the same as the previous value. Beware of cycles! Doesn't convert the new value into observables.
1024- `extras.deepEquals`: Check if two data structures are deeply equal. supports observable and non observable data structures.
1025
1026## 3.0.1
1027
1028- `toString()` of observable arrays now behaves like normal arrays (by @capaj, see #759)
1029- Improved flow types of `toJS`by @jamsea (#758)
1030
1031## 3.0.0
1032
1033The changelog of MobX 3 might look quite overwhelming, but migrating to MobX 3 should be pretty straight forward nonetheless.
1034The api has now become more layered, and the api is more uniform and modifiers are cleaned up.
1035In practice, you should check your usage of modifiers (`asFlat`, `asMap` etc.). Besides that the migration should be pretty painless.
1036Please report if this isn't the case!
1037Note that no changes to the runtime algorithm where made, almost all changes evolve in making the creation of observables more uniform, and removing deprecated stuff.
1038
1039## `observable` api has been redesigned
1040
1041The api to create observables has been redesigned.
1042By default, it keeps the automatic conversion behavior from MobX 2.
1043However, one can now have more fine grained control on how / which observables are constructed.
1044Modifiers still exists, but they are more regular, and there should be less need for them.
1045
1046### `observable(plainObject)` will no longer enhance objects, but clone instead
1047
1048When passing a plain object to `observable`, MobX used to modify that object inplace and give it observable capabilities.
1049This also happened when assigning a plain object to an observable array etc.
1050However, this behavior has changed for a few reasons
1051
10521. Both arrays and maps create new data structure, however, `observable(object)` didn't
10532. It resulted in unnecessary and confusing side effects. If you passed an object you received from some api to a function that added it, for example, to an observable collection. Suddenly your object would be modified as side effect of passing it down to that function. This was often confusing for beginners and could lead to subtle bugs.
10543. If MobX in the future uses Proxies behind the scenes, this would need to change as well
1055
1056If you want, you can still enhance existing plainObjects, but simply using `extendObservable(data, data)`. This was actually the old implementation, which has now changed to `extendObservable({}, data)`.
1057
1058As always, it is best practice not to have transportation objects etc lingering around; there should be only one source of truth, and that is the data that is in your observable state.
1059If you already adhered to this rule, this change won't impact you.
1060
1061See [#649](https://github.com/mobxjs/mobx/issues/649)
1062
1063### Factories per observable type
1064
1065There are now explicit methods to create an observable of a specific type.
1066
1067- `observable.object(props, name?)` creates a new observable object, by cloning the give props and making them observable
1068- `observable.array(initialValues, name?)`. Take a guess..
1069- `observable.map(initialValues, name?)`
1070- `observable.box(initialValue, name?)`. Creates a [boxed](http://mobxjs.github.io/mobx/refguide/boxed.html) value, which can be read from / written to using `.get()` and `.set(newValue)`
1071- `observable(value)`, as-is, based on the type of `value`, uses any of the above four functions to create a new observable.
1072
1073### Shallow factories per type
1074
1075The standard observable factories create observable structures that will try to turn any plain javascript value (arrays, objects or Maps) into observables.
1076Allthough this is fine in most cases, in some cases you might want to disable this autoconversion.
1077For example when storing objects from external libraries.
1078In MobX 2 you needed to use `asFlat` or `asReference` modifiers for this.
1079In MobX 3, there are factories to directly create non-converting data structures:
1080
1081- `observable.shallowObject(props, name?)`
1082- `observable.shallowArray(initialValues, name?)`
1083- `observable.shallowMap(initialValues, name?)`
1084- `observable.shallowBox(initialValue, name?)`
1085
1086So for example, `observable.shallowArray([todo1, todo2])` will create an observable array, but it won't try to convert the todos inside the array into observables as well.
1087
1088### Shallow properties
1089
1090The `@observable` decorator can still be used to introduce observable properties. And like in MobX 2, it will automatically convert its values.
1091
1092However, sometimes you want to create an observable property that does not convert its _value_ into an observable automatically.
1093Previously that could be written as `@observable x = asReference(value)`.
1094
1095### Structurally comparison of observables have been removed
1096
1097This was not for a technical reason, but they just seemed hardly used.
1098Structural comparision for computed properties and reactions is still possible.
1099Feel free to file an issue, including use case, to re-introduce this feature if you think you really need it.
1100However, we noticed that in practice people rarely use it. And in cases where it is used `reference` / `shallow` is often a better fit (when using immutable data for example).
1101
1102### Modifiers
1103
1104Modifiers can be used in combination `@observable`, `extendObservable` and `observable.object` to change the autoconversion rules of specific properties.
1105
1106The following modifiers are available:
1107
1108- `observable.deep`: This is the default modifier, used by any observable. It converts any assigned, non-primitive value into an observable value if it isn't one yet.
1109- `observable.ref`: Disables automatic observable conversion, just creates an observable reference instead.
1110- `observable.shallow`: Can only used in combination with collections. Turns any assigned collection into an collection, which is shallowly observable (instead of deep)
1111
1112Modifiers can be used as decorator:
1113
1114```javascript
1115class TaskStore {
1116 @observable.shallow tasks = []
1117}
1118```
1119
1120Or as property modifier in combination with `observable.object` / `observable.extendObservable`.
1121Note that modifiers always 'stick' to the property. So they will remain in effect even if a new value is assigned.
1122
1123```javascript
1124const taskStore = observable({
1125 tasks: observable.shallow([])
1126})
1127```
1128
1129See [modifiers](http://mobxjs.github.io/mobx/refguide/modifiers.html)
1130
1131### `computed` api has been simplified
1132
1133Using `computed` to create boxed observables has been simplified, and `computed` can now be invoked as follows:
1134
1135- `computed(expr)`
1136- `computed(expr, setter)`
1137- `computed(expr, options)`, where options is an object that can specify one or more of the following fields: `name`, `setter`, `compareStructural` or `context` (the "this").
1138
1139Computed can also be used as a decorator:
1140
1141- `@computed`
1142- `@computed.struct` when you want to compareStructural (previously was `@computed({asStructure: true})`)
1143
1144### `reaction` api has been simplified
1145
1146The signature of `reaction` is now `reaction(dataFunc, effectFunc, options?)`, where the following options are accepted:
1147
1148- `context`: The `this` to be used in the functions
1149- `fireImmediately`
1150- `delay`: Number in milliseconds that can be used to debounce the effect function.
1151- `compareStructural`: `false` by default. If `true`, the return value of the _data_ function is structurally compared to its previous return value, and the _effect_ function will only be invoked if there is a structural change in the output.
1152- `name`: String
1153
1154### Bound actions
1155
1156It is now possible to create actions and bind them in one go using `action.bound`. See [#699](https://github.com/mobxjs/mobx/issues/699).
1157This means that now the following is possible:
1158
1159```javascript
1160class Ticker {
1161 @observable tick = 0
1162
1163 @action.bound
1164 increment() {
1165 this.tick++ // 'this' will always be correct
1166 }
1167}
1168
1169const ticker = new Ticker()
1170setInterval(ticker.increment, 1000)
1171```
1172
1173### Improve error handling
1174
1175Error handling in MobX has been made more consistent. In MobX 2 there was a best-effort recovery attempt if a derivation throws, but MobX 3 introduced
1176more consistent behavior:
1177
1178- Computed values that throw, store the exception and throw it to the next consumer(s). They keep tracking their data, so they are able to recover from exceptions in next re-runs.
1179- Reactions (like `autorun`, `when`, `reaction`, `render()` of `observer` components) will always catch their exceptions, and just log the error. They will keep tracking their data, so they are able to recover in next re-runs.
1180- The disposer of a reaction exposes an `onError(handler)` method, which makes it possible to attach custom error handling logic to an reaction (that overrides the default logging behavior).
1181- `extras.onReactionError(handler)` can be used to register a global onError handler for reactions (will fire after spy "error" event). This can be useful in tests etc.
1182
1183See [#731](https://github.com/mobxjs/mobx/issues/731)
1184
1185### Removed error handling, improved error recovery
1186
1187MobX always printed a warning when an exception was thrown from a computed value, reaction or react component: `[mobx] An uncaught exception occurred while calculating....`.
1188This warning was often confusing for people because they either had the impression that this was a mobx exception, while it actually is just informing about an exception that happened in userland code.
1189And sometimes, the actual exception was silently caught somewhere else.
1190MobX now does not print any warnings anymore, and just makes sure its internal state is still stable.
1191Not throwing or handling an exception is now entirely the responsibility of the user.
1192
1193Throwing an exception doesn't revert the causing mutation, but it does reset tracking information, which makes it possible to recover from exceptions by changing the state in such a way that a next run of the derivation doesn't throw.
1194
1195### Flow-Types Support 🎉🎉🎉
1196
1197Flow typings have been added by [A-gambit](https://github.com/A-gambit).
1198Add flow types for methods and interfaces of observable variables:
1199
1200```js
1201const observableValue: IObservableValue<number> = observable(1)
1202const observableArray: IObservableArray<number> = observable([1, 2, 3])
1203
1204const sum: IComputedValue<number> = computed(() => {
1205 return observableArray.reduce((a: number, b: number): number => a + b, 0)
1206})
1207```
1208
1209See [#640](https://github.com/mobxjs/mobx/issues/640)
1210
1211### MobX will no longer share global state by default
1212
1213For historical reasons (at Mendix), MobX had a feature that it would warn if different versions of the MobX package are being loaded into the same javascript runtime multiple times.
1214This is because multiple instances by default try to share their state.
1215This allows reactions from one package to react to observables created by another package,
1216even when both packages where shipped with their own (embedded) version of MobX (!).
1217
1218Obviously this is a nasty default as it breaks package isolation and might actually start to throw errors unintentionally when MobX is loaded multiple times in the same runtime by completely unrelated packages.
1219So this sharing behavior is now by default turned off.
1220Sharing MobX should be achieved by means of proper bundling, de-duplication of packages or using peer dependencies / externals if needed.
1221This is similar to packages like React, which will also bail out if you try to load it multiple times.
1222
1223If you still want to use the old behavior, this can be achieved by running `mobx.extras.shareGlobalState()` on _all_ packages that want to share state with each other.
1224Since this behavior is probably not used outside Mendix, it has been deprecated immediately, so if you rely on this feature, please report in #621, so that it can be undeprecated if there is no more elegant solution.
1225
1226See [#621](https://github.com/mobxjs/mobx/issues/621)
1227
1228### Using the @action decorator inside individual objects
1229
1230Don't use the `@action` decorator on an individual object that you pass to `observable()` or `extendObservable()`. If you have code that looks like `observable({ @action f: () => {})`, you should change it to `observable({ f: action(() => {})`.
1231
1232Whether or not this was ever a good idea is debatable, but it stopped working in this version. If you're using classes, it's a non-issue.
1233
1234### Other changes
1235
1236- **Breaking change:** The arguments to `observe` listeners for computed and boxed observables have changed and are now consistent with the other apis. Instead of invoking the callback with `(newValue: T, oldValue: T)` they are now invoked with a single change object: `(change: {newValue: T, oldValue: T, object, type: "update"})`
1237- Using transaction is now deprecated, use `action` or `runInAction` instead. Transactions now will enter an `untracked` block as well, just as actions, which removes the conceptual difference.
1238- Upgraded to typescript 2
1239- It is now possible to pass ES6 Maps to `observable` / observable maps. The map will be converted to an observable map (if keys are string like)
1240- Made `action` more debug friendly, it should now be easier to step through
1241- ObservableMap now has an additional method, `.replace(data)`, which is a combination of `clear()` and `merge(data)`.
1242- Passing a function to `observable` will now create a boxed observable refering to that function
1243- Fixed #603: exceptions in transaction breaks future reactions
1244- Fixed #698: createTransformer should support default arguments
1245- Transactions are no longer reported grouped in spy events. If you want to group events, use actions instead.
1246- Normalized `spy` events further. Computed values and actions now report `object` instead of `target` for the scope they have been applied to.
1247- The following deprecated methods have been removed:
1248 - `transaction`
1249 - `autorunUntil`
1250 - `trackTransitions`
1251 - `fastArray`
1252 - `SimpleEventEmitter`
1253 - `ObservableMap.toJs` (use `toJS`)
1254 - `toJSlegacy`
1255 - `toJSON` (use `toJS`)
1256 - invoking `observe` and `inject` with plain javascript objects
1257
1258---
1259
1260## 2.7.0
1261
1262### Automatic inference of computed properties has been deprecated.
1263
1264A deprecation message will now be printed if creating computed properties while relying on automatical inferrence of argumentless functions as computed values. In other words, when using `observable` or `extendObservable` in the following manner:
1265
1266```javascript
1267const x = observable({
1268 computedProp: function() {
1269 return someComputation
1270 }
1271})
1272
1273// Due to automatic inferrence now available as computed property:
1274x.computedProp
1275// And not !
1276x.computedProp()
1277```
1278
1279Instead, to create a computed property, use:
1280
1281```javascript
1282observable({
1283 get computedProp() {
1284 return someComputation
1285 }
1286})
1287```
1288
1289or alternatively:
1290
1291```javascript
1292observable({
1293 computedProp: computed(function() {
1294 return someComputation
1295 })
1296})
1297```
1298
1299This change should avoid confusing experiences when trying to create methods that don't take arguments.
1300The current behavior will be kept as-is in the MobX 2.\* range,
1301but from MobX 3 onward the argumentless functions will no longer be turned
1302automatically into computed values; they will be treated the same as function with arguments.
1303An observable _reference_ to the function will be made and the function itself will be preserved.
1304See for more details [#532](https://github.com/mobxjs/mobx/issues/532)
1305
1306N.B. If you want to introduce actions on an observable that modify its state, using `action` is still the recommended approach:
1307
1308```javascript
1309observable({
1310 counter: 0,
1311 increment: action(function() {
1312 this.counter++
1313 })
1314})
1315```
1316
1317By the way, if you have code such as:
1318
1319```
1320observable({
1321 @computed get someProp() { ... }
1322});
1323```
1324
1325That code will no longer work. Rather, reactions will fail silently. Remove `@computed`.
1326Note, this only applies when using observable in this way; it doesn't apply when using
1327`@observable` on a property within a class declaration.
1328
1329### Misc
1330
1331- Fixed #701: `toJS` sometimes failing to convert objects decorated with `@observable` (cause: `isObservable` sometimes returned false on these object)
1332- Fixed typings for `when` / `autorun` / `reaction`; they all return a disposer function.
1333
1334## 2.6.5
1335
1336- Added `move` operation to observable array, see [#697](https://github.com/mobxjs/mobx/pull/697)
1337
1338## 2.6.4
1339
1340- Fixed potential clean up issue if an exception was thrown from an intercept handler
1341- Improved typings of `asStructure` (by @nidu, see #687)
1342- Added support for `computed(asStructure(() => expr))` (by @yotambarzilay, see #685)
1343
1344## 2.6.3
1345
1346- Fixed #603: exceptions in transaction breaks future reactions
1347- Improved typings of `toJS`
1348- Introduced `setReactionScheduler`. Internal api used by mobx-react@4 to be notified when reactions will be run
1349
1350## 2.6.2
1351
1352- Changes related to `toJS` as mentioned in version `2.6.0` where not actually shipped. This has been fixed, so see release notes below.
1353
1354## 2.6.1
1355
1356- Introduced convenience `isArrayLike`: returns whether the argument is either a JS- or observable array. By @dslmeinte
1357- Improved readme. By @DavidLGoldberg
1358- Improved assertion message, by @ncammarate (See [#618](https://github.com/mobxjs/mobx/pull/618))
1359- Added HashNode badge, by @sandeeppanda92
1360
1361## 2.6.0
1362
1363_Marked as minor release as the behavior of `toJS` has been changed, which might be interpreted both as bug-fix or as breaking change, depending of how you interpreted the docs_
1364
1365- Fixed [#566](https://github.com/mobxjs/mobx/pull/566): Fixed incorrect behavior of `toJS`: `toJS` will now only recurse into observable object, not all objects. The new behavior is now aligned with what is suggested in the docs, but as a result the semantics changed a bit. `toJSlegacy` will be around for a while implementing the old behavior. See [#589](See https://github.com/mobxjs/mobx/pull/589) for more details.
1366- Fixed [#571](https://github.com/mobxjs/mobx/pull/571): Don't use `instanceof` operator. Should fix issues if MobX is included multiple times in the same bundle.
1367- Fixed [#576](https://github.com/mobxjs/mobx/pull/576): disallow passing actions directly to `autorun`; as they won't be tracked by @jeffijoe
1368- Extending observable objects with other observable (objects) is now explicitly forbidden, fixes [#540](https://github.com/mobxjs/mobx/pull/540).
1369
1370## 2.5.2
1371
1372- Introduced `isComputed`
1373- Observable objects can now have a type: `IObservableObject`, see [#484](https://github.com/mobxjs/mobx/pull/484) by @spiffytech
1374- Restored 2.4 behavior of boxed observables inside observable objects, see [#558](https://github.com/mobxjs/mobx/issues/558)
1375
1376## 2.5.1
1377
1378- Computed properties can now be created by using getter / setter functions. This is the idiomatic way to introduce computed properties from now on:
1379
1380```javascript
1381const box = observable({
1382 length: 2,
1383 get squared() {
1384 return this.length * this.length
1385 },
1386 set squared(value) {
1387 this.length = Math.sqrt(value)
1388 }
1389})
1390```
1391
1392## 2.5.0
1393
1394- Core derivation algorithm has received some majore improvements by @asterius1! See below. Pr #452, 489
1395- Introduced setters for computed properties, use `computed(expr, setter)` or `@computed get name() { return expr } set name (value) { action }`. `computed` can now be used as modifier in `observable` / `extendObservable`, #421, #463 (see below for example)
1396- Introduced `isStrictModeEnabled()`, deprecated `useStrict()` without arguments, see #464
1397- Fixed #505, accessing an observable property throws before it is initialized
1398
1399MobX is now able track and memoize computed values while an (trans)action is running.
1400Before 2.5, accessing a computed value during a transaction always resulted in a recomputation each time the computed value was accessed, because one of the upstream observables (might) have changed.
1401In 2.5, MobX actively tracks whether one of the observables has changed and won't recompute computed values unnecessary.
1402This means that computed values are now always memoized for the duration of the current action.
1403In specific cases, this might signficantly speed up actions that extensively make decisions based on computed values.
1404
1405Example:
1406
1407```javascript
1408class Square {
1409 @observable length = 2
1410 @computed get squared() {
1411 return this.length * this.length
1412 }
1413 // mobx now supports setters for computed values
1414 set squared(surfaceSize) {
1415 this.length = Math.sqrt(surfaceSize)
1416 }
1417
1418 // core changes make actions more efficient if extensively using computed values:
1419 @action stuff() {
1420 this.length = 3
1421 console.log(this.squared) // recomputes in both 2.5 and before
1422 console.log(this.squared) // no longer recomputes
1423 this.length = 4
1424 console.log(this.squared) // recomputes in both 2.5 and before
1425 // after the action, before 2.5 squared would compute another time (if in use by a reaction), that is no longer the case
1426 }
1427}
1428```
1429
1430ES5 example for setters:
1431
1432```javascript
1433function Square() {
1434 extendObservable(this, {
1435 length: 2,
1436 squared: computed(
1437 function() {
1438 return this.squared * this.squared
1439 },
1440 function(surfaceSize) {
1441 this.length = Math.sqrt(surfaceSize)
1442 }
1443 )
1444 })
1445}
1446```
1447
1448## 2.4.4
1449
1450- Fixed #503: map.delete returns boolean
1451- Fix return type of `runInAction`, #499 by @Strate
1452- Fixed enumerability of observable array methods, see #496.
1453- Use TypeScript typeguards, #487 by @Strate
1454- Added overloads to `action` for better type inference, #500 by @Strate
1455- Fixed #502: `extendObservable` fails on objects created with `Object.create(null)`
1456- Implemented #480 / #488: better typings for `asMap`, by @Strate
1457
1458## 2.4.3
1459
1460- Objects with a `null` prototype are now considered plain objects as well
1461- Improved error message for non-converging cyclic reactions
1462- Fixed potential HMR issue
1463
1464## 2.4.2
1465
1466- Improved error message when wrongly using `@computed`, by @bb (#450)
1467- `observableArray.slice` now automatically converts observable arrays to plain arrays, fixes #460
1468- Improved error message when an uncaught exception is thrown by a MobX tracked function
1469
1470## 2.4.1
1471
1472- `@action` decorated methods are now configurable. Fixes #441
1473- The `onBecomeObserved` event handler is now triggered when an atom is observed, instead of when it is bound as dependency. Fixes #427 and makes atoms easier to extend.
1474- if `useStrict()` is invoked without arguments, it now returns the current value of strict mode.
1475- the current reaction is now always passed as first argument to the callbacks of `autorun`, `autorunAsync`, `when` and `reaction`. This allows reactions to be immediately disposed during the first run. See #438, by @andykog
1476
1477## 2.4.0
1478
1479- _Note: the internal version of MobX has been bumped. This version has no breaking api changes, but if you have MobX loaded multiple times in your project, they all have to be upgraded to `2.4.0`. MobX will report this when starting._
1480- Made dependency tracking and binding significant faster. Should result in huge performance improvements when working with large collections.
1481- Fixed typescript decorator issue, #423, #425? (by @bb)
1482
1483## 2.3.7
1484
1485- Fixed issue where computed values were tracked and accidentally kept alive during actions
1486
1487## 2.3.6
1488
1489- Fixed #406: Observable maps doesn't work with empty initial value in Safari
1490- Implemented #357, #348: ObservableMap and ObservableArray now support iterators. Use [`@@iterator()` or iterall](https://github.com/leebyron/iterall) in ES5 environments.
1491
1492## 2.3.5
1493
1494- Fixed #364: Observable arrays not reacting properly to index assignments under iOS safari (mobile) 9.1.1 By @andykog
1495- Fixed #387: Typings of boxed values
1496- Added warning when reading array entries out of bounds. See #381
1497
1498## 2.3.4
1499
1500- Fixed #360: Removed expensive cycle detection (cycles are still detected, but a bit later)
1501- Fixed #377: `toJS` serialization of Dates and Regexes preserves the original values
1502- Fixed #379: `@action` decorated methods can now be inherited / overriden
1503
1504## 2.3.3
1505
1506- Fixed #186: Log a warning instead of an error if an exception is thrown in a derivation. Fixes issue where React Native would produce unusable error screens (because it shows the first logged error)
1507- Fixed #333: Fixed some interoperability issues in combination with `Reflect` / `InversifyJS` decorators. @andykog
1508- Fixed #333: `@observable` class properties are now _owned_ by their instance again, meaning they will show up in `Object.keys()` and `.hasOwnProperty` @andykog
1509
1510## 2.3.2
1511
1512- Fixed #328: Fixed exception when inspecting observable in `onBecomeObserved`
1513- Fixed #341: `array.find` now returns `undefined` instead of `null` when nothing was found, behavior now matches the docs. (By @hellectronic)
1514
1515## 2.3.1
1516
1517- Fixed #327: spy not working with runInAction
1518
1519## 2.3.0
1520
1521### Introduced `whyRun`:
1522
1523Usage:
1524
1525- `whyRun()`
1526- `whyRun(Reaction object / ComputedValue object / disposer function)`
1527- `whyRun(object, "computed property name")`
1528
1529`whyRun` is a small utility that can be used inside computed value or reaction (`autorun`, `reaction` or the `render` method of an `observer` React component)
1530and prints why the derivation is currently running, and under which circumstances it will run again.
1531This should help to get a deeper understanding when and why MobX runs stuff, and prevent some beginner mistakes.
1532
1533This feature can probably be improved based on your feedback, so feel free to file issues with suggestions!
1534
1535### Semantic changes:
1536
1537- `@observable` is now always defined on the class prototypes and not in the instances. This means that `@observable` properties are enumerable, but won't appear if `Object.keys` or `hasOwnProperty` is used on a class _instance_.
1538- Updated semantics of `reaction` as discussed in `#278`. The expression now needs to return a value and the side effect won't be triggered if the result didn't change. `asStructure` is supported in these cases. In contrast to MobX 2.2, effects will no longer be run if the output of the expression didn't change.
1539
1540### Enhancements
1541
1542- Introduces `isAction(fn)` #290
1543- If an (argumentless) action is passed to `observable` / `extendObservable`, it will not be converted into a computed property.
1544- Fixed #285: class instances are now also supported by `toJS`. Also members defined on prototypes which are enumerable are converted.
1545- Map keys are now always coerced to strings. Fixes #308
1546- `when`, `autorun` and `autorunAsync` now accept custom debug names (see #293, by @jamiewinder)
1547- Fixed #286: autoruns no longer stop working if an action throws an exception
1548- Implemented `runInAction`, can be used to create on the fly actions (especially useful in combination with `async/await`, see #299
1549- Improved performance and reduced mem usage of decorators signficantly (by defining the properties on the prototype if possible), and removed subtle differences between the implementation and behavior in babel and typescript.
1550- Updated logo as per #244. Tnx @osenvosem!
1551
1552# 2.2.2:
1553
1554- Fixed issue #267: exception when `useStrict(true)` was invoked in combination with `@observable` attributes when using Babel
1555- Fixed issue #269: @action in combination with typescript targeting ES6 and reflect.ts
1556- Improved compatibility with `JSON.stringify`, removed incorrect deprecation message
1557- Improved some error messages
1558
1559# 2.2.1
1560
1561- Fixed issue where typescript threw a compile error when using `@action` without params on a field
1562- Fixed issue where context was accidentally shared between class instances when using `@action` on a field
1563
1564# 2.2.0
1565
1566See the [release announcement](https://medium.com/@mweststrate/45cdc73c7c8d) for the full details of this release:
1567
1568Introduced:
1569
1570- `action` / `@action`
1571- `intercept`
1572- `spy`
1573- `reaction`
1574- `useStrict`
1575- improved debug names
1576- `toJSON` was renamed to `toJS`
1577- `observable(asMap())` is the new idiomatic way to create maps
1578- the effect of `when` is now untracked, similar to `reaction.
1579- `extras.trackTransations` is deprecated, use `spy` instead
1580- `untracked` has been undeprecated
1581- introduced / documented: `getAtom`, `getDebugName`, `isSpyEnabled`, `spyReport`, `spyReportStart`, `spyReportEnd`
1582- deprecated `extras.SimpleEventEmitter`
1583- array splice events now also report the `added` collection and `removedCount`
1584
1585# 2.1.7
1586
1587- Fixed a false negative in cycle detection, as reported in #236
1588
1589# 2.1.6
1590
1591- Fixed #236, #237 call stack issues when working with large arrays
1592
1593# 2.1.5
1594
1595- Fix #222 (by @andykog) run `observe` callback of computed properties in untracked mode.
1596
1597# 2.1.4
1598
1599- Fixed #201 (see also #160), another iOS enumerability issue... By @luosong
1600
1601# 2.1.3
1602
1603- Fixed #191, when using babel, complex field initializers where shared. By @andykog
1604- Added `lib/mobx.umd.min.js` for minified cdn builds, see #85
1605
1606# 2.1.2
1607
1608- Improved debug names of objects created using a constructor
1609- Fixed(?) some issues with iOS7 as reported in #60 by @bstst
1610
1611# 2.1.1
1612
1613- Fixed issue where `autorun`s created inside `autorun`s were not always kicked off. (`mobx-react`'s `observer` was not affected). Please upgrade if you often use autorun.
1614- Fixed typings of `mobx.map`, a list of entries is also acceptable.
1615- (Experimental) Improved error recovery a bit further
1616
1617# 2.1.0
1618
1619- MobX is now chatty again when an exception occurs inside a autorun / computed value / React.render. Previously this was considered to be the responsibility of the surrounding code. But if exceptions were eaten this would be really tricky to debug.
1620- (Experimental) MobX will now do a poor attempt to recover from exceptions that occured in autorun / computed value / React.render.
1621
1622# 2.0.6
1623
1624- `resetGlobalState` is now part of the `mobx.extras` namespace, as it is useful for test setup, to restore inconsistent state after test failures.
1625- `resetGlobalState` now also resets the caches of `createTransformer`, see #163.
1626
1627# 2.0.5
1628
1629- WIP on bower support
1630
1631# 2.0.4
1632
1633- `$transformId` property on transformed objects should be non-enumerable. Fixes #170.
1634
1635# 2.0.3
1636
1637- Always peek if inspecting a stale, computed value. Fixes #165.
1638
1639# 2.0.2
1640
1641- Fixed issue where changing an object property was tracked, which could lead to unending loops in `autorunAsync`.
1642
1643# 2.0.1
1644
1645- Undeprecated `observable(scalar)` (see 143)
1646- `expr` no longer prints incorrect deprecated messages (see 143)
1647- Requires `mobx` twice no longer fails.
1648
1649# 2.0.0
1650
1651## A new name...
1652
1653Welcome to ~Mobservable~ MobX 2! First of all, there is the name change.
1654The new name is shorter and funnier and it has the right emphasis: MobX is about reactive programming.
1655Not about observability of data structures, which is just a technical necessity.
1656MobX now has its own [mobxjs](https://github.com/mobxjs) organization on GitHub. Just report an issue if you want to join.
1657
1658All MobX 2.0 two compatible packages and repos have been renamed. So `mobx-react`, `mobx-react-devtools` etc.
1659For the 1.0 versions, use the old `mobservable` based names.
1660
1661## Migrating from Mobservable 1.x to MobX 2.0
1662
1663Migrating from Mobservable should be pretty straight-forward as the public api is largely the same.
1664However there are some conceptual changes which justifies a Major version bump as it might alter the behavior of MobX in edge cases.
1665Besides that, MobX is just a large collection of minor improvements over Mobservable.
1666Make sure to remove your old `mobservable` dependencies when installing the new `mobx` dependencies!
1667
1668## `autorun`s are now allowed to cause cycles!
1669
1670`autorun` is now allowed to have cycles. In Mobservable 1 an exception was thrown as soon as an autorun modified a variable which it was reading as well.
1671In MobX 2 these situations are now allowed and the autorun will trigger itself to be fired again immediately after the current execution.
1672This is fine as long as the autorun terminates within a reasonable amount of iterations (100).
1673This should avoid the need for work-arounds involving `setTimeout` etc.
1674Note that computed values (created using `observable(func)` are still not allowed to have cycles.
1675
1676## [Breaking] `observable(scalar)` returns an object instead of a function and has been deprecated.
1677
1678Creating an observable from a primitive or a reference no longer returns a getter/setter function, but a method with a `.get` and `.set` method.
1679This is less confusing, easier to debug and more efficient.
1680
1681So to read or write from an observable scalar use:
1682
1683```javascript
1684const temperature = observable(27)
1685temperature.set(15) // previously: temperature(15)
1686temperature.get() // previously: temperature()
1687```
1688
1689`observable(scalar)` has been deprecated to make the api smaller and the syntax more uniform. In practice having observable objects, arrays and decorators seems to suffice in 99% of the cases. Deprecating this functionality means that people have simply less concepts to learn. Probably creating observable scalars will continue to work for a long time, as it is important to the internals of MobX and very convenient for testing.
1690
1691## Introduced `@computed`
1692
1693MobX introduced the `@computed` decorator for ES6 class properties with getter functions.
1694It does technically the same as `@observable` for getter properties. But having a separate decorator makes it easier to communicate about the code.
1695`@observable` is for mutable state properties, `@computed` is for derived values.
1696
1697`@computed` can now also be parameterized. `@computed({asStructure: true})` makes sure that the result of a derivation is compared structurally instead of referentially with its preview value. This makes sure that observers of the computation don't re-evaluate if new structures are returned that are structurally equal to the original ones. This is very useful when working with point, vector or color structures for example. It behaves the same as the `asStructure` modifier for observable values.
1698
1699`@computed` properties are no longer enumerable.
1700
1701## MobX is now extensible!
1702
1703The core algorithm of MobX has been largely rewritten to improve the clarity, extensibility, performance and stability of the source code.
1704It is now possible to define your own custom observable data sources by using the `Atom` class.
1705It is also possible to create your own reactive functions using the `Reaction` class. `autorun`, `autorunAsync` and `@observer` have now all been implemented using the concept of Reactions.
1706So feel free to write your own reactive [constructions](http://mobxjs.github.io/mobx/refguide/extending.html)!
1707
1708## Mobservable now fails fast
1709
1710In Mobservable 1 exceptions would be caught and sometimes re-thrown after logging them.
1711This was confusing and not all derivations were able to recover from these exceptions.
1712In MobX 2 it is no longer allowed for a computed function or `autorun` to throw an exception.
1713
1714## Improved build
1715
1716- MobX is roughly 20% faster
1717- MobX is smaller: 75KB -> 60KB unminified, and 54KB -> 30KB minified.
1718- Distributable builds are no longer available in the git repository, use unpkg instead:
1719- Commonjs build: https://unpkg.com/mobx@^2.0.0/lib/mobx.js
1720- Minified commonjs build: https://unpkg.com/mobx@^2.0.0/lib/mobx.min.js
1721- UMD build: https://unpkg.com/mobx@^2.0.0/lib/mobx.umd.js
1722- To use the minified build, require / import the lib from `"mobx/lib/mobx.min.js"` (or set up an alias in your webpack configuration if applicable)
1723
1724## Other changes
1725
1726- Improved debug names of all observables. This is especially visible when using `mobx-react-devtools` or `extras.trackTransitions`.
1727- Renamed `extras.SimpleEventEmitter` to `SimpleEventEmitter`
1728- Removed already deprecated methods: `isReactive`, `makeReactive`, `observeUntil`, `observeAsync`
1729- Removed `extras.getDNode`
1730- Invoking `ObservableArray.peek` is no longer registered as listener
1731- Deprecated `untracked`. It wasn't documented and nobody seems to miss it.
1732
1733# 1.2.5
1734
1735- Map no longer throws when `.has`, `.get` or `.delete` is invoked with an invalid key (#116)
1736- Files are now compiled without sourcemap to avoid issues when loading mobservable in a debugger when `src/` folder is not available.
1737
1738# 1.2.4
1739
1740- Fixed: observable arrays didn't properly apply modifiers if created using `asFlat([])` or `fastArray([])`
1741- Don't try to make frozen objects observable (by @andykog)
1742- `observableArray.reverse` no longer mutates the arry but just returns a sorted copy
1743- Updated tests to use babel6
1744
1745# 1.2.3
1746
1747- observableArray.sort no longer mutates the array being sorted but returns a sorted clone instead (#90)
1748- removed an incorrect internal state assumption (#97)
1749
1750# 1.2.2
1751
1752- Add bower support
1753
1754# 1.2.1
1755
1756- Computed value now yields consistent results when being inspected while in transaction
1757
1758# 1.2.0
1759
1760- Implemented #67: Reactive graph transformations. See: http://mobxjs.github.io/mobservable/refguide/create-transformer.html
1761
1762# 1.1.8
1763
1764- Implemented #59, `isObservable` and `observe` now support a property name as second param to observe individual values on maps and objects.
1765
1766# 1.1.7
1767
1768- Fixed #77: package consumers with --noImplicitAny should be able to build
1769
1770# 1.1.6
1771
1772- Introduced `mobservable.fastArray(array)`, in addition to `mobservable.observable(array)`. Which is much faster when adding items but doesn't support enumerability (`for (var idx in ar) ..` loops).
1773- Introduced `observableArray.peek()`, for fast access to the array values. Should be used read-only.
1774
1775# 1.1.5
1776
1777- Fixed 71: transactions should not influence running computations
1778
1779# 1.1.4
1780
1781- Fixed #65; illegal state exception when using a transaction inside a reactive function. Credits: @kmalakoff
1782
1783# 1.1.3
1784
1785- Fixed #61; if autorun was created during a transaction, postpone execution until the end of the transaction
1786
1787# 1.1.2
1788
1789- Fixed exception when autorunUntil finished immediately
1790
1791# 1.1.1
1792
1793- `toJSON` now serializes object trees with cycles as well. If you know the object tree is acyclic, pass in `false` as second parameter for a performance gain.
1794
1795# 1.1.0
1796
1797- Exposed `ObservableMap` type
1798- Introduced `mobservable.untracked(block)`
1799- Introduced `mobservable.autorunAsync(block, delay)`
1800
1801# 1.0.9
1802
1803Removed accidental log message
1804
1805# 1.0.7 / 1.0.8
1806
1807Fixed inconsistency when using `transaction` and `@observer`, which sometimes caused stale values to be displayed.
1808
1809# 1.0.6
1810
1811Fix incompatibility issue with systemjs bundler (see PR 52)
1812
1813# 1.0.4/5
1814
1815- `map.size` is now a property instead of a function
1816- `map()` now accepts an array as entries to construct the new map
1817- introduced `isObservableObject`, `isObservableArray` and `isObservableMap`
1818- introduced `observe`, to observe observable arrays, objects and maps, similarly to Object.observe and Array.observe
1819
1820# 1.0.3
1821
1822- `extendObservable` now supports passing in multiple object properties
1823
1824# 1.0.2
1825
1826- added `mobservable.map()`, which creates a new map similarly to ES6 maps, yet observable. Until properly documentation, see the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).
1827
1828# 1.0.1
1829
1830- Stricter argument checking for several apis.
1831
1832# 1.0
1833
1834## Renames
1835
1836- `isReactive` -> `isObservable`
1837- `makeReactive` -> `observable`
1838- `extendReactive` -> `extendObservable`
1839- `observe` -> `autorun`
1840- `observeUntil` -> `autorunUntil`
1841- `observeAsync` -> `autorunAsync`
1842- `reactiveComponent` -> `observer` (in `mobservable-react` package)
1843
1844## Breaking changes
1845
1846- dropped the `strict` and `logLevel` settings of mobservable. View functions are by default run in `strict` mode, `autorun` (formerly: `observe`) functions in `non-strict` mode (strict indicates that it is allowed to change other observable values during the computation of a view funtion).
1847 Use `extras.withStrict(boolean, block)` if you want to deviate from the default behavior.
1848- `observable` (formerly `makeReactive`) no longer accepts an options object. The modifiers `asReference`, `asStructure` and `asFlat` can be used instead.
1849- dropped the `default` export of observable
1850- Removed all earlier deprecated functions
1851
1852## Bugfixes / improvements
1853
1854- `mobservable` now ships with TypeScript 1.6 compliant module typings, no external typings file is required anymore.
1855- `mobservable-react` supports React Native as well through the import `"mobservable-react/native"`.
1856- Improved debugger support
1857- `for (var key in observablearray)` now lists the correct keys
1858- `@observable` now works correct on classes that are transpiled by either TypeScript or Babel (Not all constructions where supported in Babel earlier)
1859- Simplified error handling, mobservable will no longer catch errors in views, which makes the stack traces easier to debug.
1860- Removed the initial 'welcom to mobservable' logline that was printed during start-up.
1861
1862# 0.7.1
1863
1864- Backported Babel support for the @observable decorator from the 1.0 branch. The decorator should now behave the same when compiled with either Typescript or Babeljs.
1865
1866# 0.7.0
1867
1868- Introduced `strict` mode (see issues [#30](), [#31]())
1869- Renamed `sideEffect` to `observe`
1870- Renamed `when` to `observeUntil`
1871- Introduced `observeAsync`.
1872- Fixed issue where changing the `logLevel` was not picked up.
1873- Improved typings.
1874- Introduces `asStructure` (see [#8]()) and `asFlat`.
1875- Assigning a plain object to a reactive structure no longer clones the object, instead, the original object is decorated. (Arrays are still cloned due to Javascript limitations to extend arrays).
1876- Reintroduced `expr(func)` as shorthand for `makeReactive(func)()`, which is useful to create temporarily views inside views
1877- Deprecated the options object that could be passed to `makeReactive`.
1878- Deprecated the options object that could be passed to `makeReactive`:
1879 - A `thisArg` can be passed as second param.
1880 - A name (for debugging) can be passed as second or third param
1881 - The `as` modifier is no longer needed, use `asReference` (instead of `as:'reference'`) or `asFlat` (instead of `recurse:false`).
1882
1883# 0.6.10
1884
1885- Fixed issue where @observable did not properly create a stand-alone view
1886
1887# 0.6.9
1888
1889- Fixed bug where views where sometimes not triggered again if the dependency tree changed to much.
1890
1891# 0.6.8
1892
1893- Introduced `when`, which, given a reactive predicate, observes it until it returns true.
1894- Renamed `sideEffect -> observe`
1895
1896# 0.6.7:
1897
1898- Improved logging
1899
1900# 0.6.6:
1901
1902- Deprecated observable array `.values()` and `.clone()`
1903- Deprecated observeUntilInvalid; use sideEffect instead
1904- Renamed mobservable.toJson to mobservable.toJSON
1905
1906# 0.6.5:
1907
1908- It is no longer possible to create impure views; views that alter other reactive values.
1909- Update links to the new documentation.
1910
1911# 0.6.4:
1912
1913- 2nd argument of sideEffect is now the scope, instead of an options object which hadn't any useful properties
1914
1915# 0.6.3
1916
1917- Deprecated: reactiveComponent, reactiveComponent from the separate package mobservable-react should be used instead
1918- Store the trackingstack globally, so that multiple instances of mobservable can run together
1919
1920# 0.6.2
1921
1922- Deprecated: @observable on functions (use getter functions instead)
1923- Introduced: `getDependencyTree`, `getObserverTree` and `trackTransitions`
1924- Minor performance improvements