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