UNPKG

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