From 5aa622f619b459aca92f5a22c2bb68e05fb52a8e Mon Sep 17 00:00:00 2001 From: Tyler Williams Date: Thu, 21 Sep 2023 15:23:00 -0600 Subject: [PATCH 1/4] chore: remove packages/mst-middlewares directory --- packages/mst-middlewares/.gitignore | 9 - packages/mst-middlewares/README.md | 478 ----- .../__snapshots__/redux.test.ts.snap | 1843 ----------------- .../__tests__/action-logger.test.ts | 83 - .../mst-middlewares/__tests__/atomic.test.ts | 168 -- .../mst-middlewares/__tests__/custom.test.ts | 230 -- .../mst-middlewares/__tests__/redux.test.ts | 339 --- .../__tests__/simple-action-logger.test.ts | 39 - .../__tests__/time-traveller.test.ts | 102 - .../mst-middlewares/__tests__/tsconfig.json | 12 - .../mst-middlewares/__tests__/tslint.json | 3 - .../__tests__/undo-manager.test.ts | 570 ----- packages/mst-middlewares/jest.config.js | 15 - packages/mst-middlewares/package.json | 59 - packages/mst-middlewares/rollup.config.js | 26 - packages/mst-middlewares/src/action-logger.ts | 12 - packages/mst-middlewares/src/atomic.ts | 40 - packages/mst-middlewares/src/index.ts | 6 - packages/mst-middlewares/src/redux.ts | 385 ---- .../src/simple-action-logger.ts | 10 - .../mst-middlewares/src/time-traveller.ts | 77 - packages/mst-middlewares/src/undo-manager.ts | 224 -- packages/mst-middlewares/tsconfig.json | 7 - packages/mst-middlewares/tslint.json | 3 - 24 files changed, 4740 deletions(-) delete mode 100644 packages/mst-middlewares/.gitignore delete mode 100644 packages/mst-middlewares/README.md delete mode 100644 packages/mst-middlewares/__tests__/__snapshots__/redux.test.ts.snap delete mode 100644 packages/mst-middlewares/__tests__/action-logger.test.ts delete mode 100644 packages/mst-middlewares/__tests__/atomic.test.ts delete mode 100644 packages/mst-middlewares/__tests__/custom.test.ts delete mode 100644 packages/mst-middlewares/__tests__/redux.test.ts delete mode 100644 packages/mst-middlewares/__tests__/simple-action-logger.test.ts delete mode 100644 packages/mst-middlewares/__tests__/time-traveller.test.ts delete mode 100644 packages/mst-middlewares/__tests__/tsconfig.json delete mode 100644 packages/mst-middlewares/__tests__/tslint.json delete mode 100644 packages/mst-middlewares/__tests__/undo-manager.test.ts delete mode 100644 packages/mst-middlewares/jest.config.js delete mode 100644 packages/mst-middlewares/package.json delete mode 100644 packages/mst-middlewares/rollup.config.js delete mode 100644 packages/mst-middlewares/src/action-logger.ts delete mode 100644 packages/mst-middlewares/src/atomic.ts delete mode 100644 packages/mst-middlewares/src/index.ts delete mode 100644 packages/mst-middlewares/src/redux.ts delete mode 100644 packages/mst-middlewares/src/simple-action-logger.ts delete mode 100644 packages/mst-middlewares/src/time-traveller.ts delete mode 100644 packages/mst-middlewares/src/undo-manager.ts delete mode 100644 packages/mst-middlewares/tsconfig.json delete mode 100644 packages/mst-middlewares/tslint.json diff --git a/packages/mst-middlewares/.gitignore b/packages/mst-middlewares/.gitignore deleted file mode 100644 index 896b284bd..000000000 --- a/packages/mst-middlewares/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -node_modules -*.log -lib -dist -coverage -.nyc_output -.idea -package-lock.json -/junit.xml diff --git a/packages/mst-middlewares/README.md b/packages/mst-middlewares/README.md deleted file mode 100644 index cc22c521b..000000000 --- a/packages/mst-middlewares/README.md +++ /dev/null @@ -1,478 +0,0 @@ -# Prebuilt middlewares - -The MST package ships with some prebuilt middlewares, which serves mainly as examples on how to write your own middleware. -The source of each middleware can be found in this github directory, you are encouraged to read them! - -The middlewares are bundled separately to keep the core package small, and can be included using: - -```javascript -import { MiddlewareName } from "mst-middlewares" -``` - -The middlewares serve as example and are supported on a best effort bases. The goal of these middlewares is that if they are critical to your system, you can simply copy paste them and further tailor them towards your specific needs. - -For the exact description of all middleware events offered by MST, see the [api docs](../../docs/middleware.md) - -# Contributing - -Feel free to contribute to these middlewares and improve them on your experience. -The middlewares must be written in TypeScript. -Any additional test for your middleware should be written inside the test folder - ---- - -# simple-action-logger - -This is the most basic of middlewares: It logs all _direct_ action invocations. Example: - -```javascript -import { simpleActionLogger } from "mst-middlewares" - -// .. type definitions ... - -const store = Store.create({ - todos: [{ title: "test " }] -}) - -mst.addMiddleware(store, simpleActionLogger) - -store.todos[0].setTitle("hello world") - -// Prints: -// [MST] /todos/0/setTitle -``` - -For a more sophisticated logger, see [action-logger](#action-logger) which also logs process invocations and continuations - ---- - -# action-logger - -This is a little more sophisticated middlewares: It logs all _direct_ action invocations and also every flow that spawns, returns or throws. Example: - -```javascript -import { actionLogger } from "mst-middlewares" - -// .. type definitions ... - -const store = Store.create({ - todos: [{ title: "test " }] -}) - -mst.addMiddleware(store, actionLogger) - -store.todos[0].setTitle("hello world") -``` - -This will print something like `[MST] - - -``` -[MST] #5 action - /todos/0/setTitle -[MST] #5 flow_spawn - /todos/0/setTitle -[MST] #5 flow_spawn - /todos/0/helper2 -[MST] #5 flow_return - /todos/0/helper2 -[MST] #5 flow_return - /todos/0/setTitle -``` - -The number (`"#5"`) indicates the id of the original action invocation that lead directly or indirectly to the flow being spawned. -For more details on the meaning of the action types see the [middleware docs](https://github.com/mobxjs/mobx-state-tree/blob/master/docs/middleware.md). - ---- - -# atomic - -This middleware rolls back if a synchronous or asynchronous action process fails. - -The exception itself is not eaten, but any modifications that are made during the sync/async action will be rollback, by reverse applying any pending patches. Can be connected to a model by using either `addMiddleware` or `decorate` - -Example: - -```javascript -import { types, addMiddleware, flow } from "mobx-state-tree" -import { atomic } from "mst-middlewares" - -const TestModel = types - .model({ - z: 1 - }) - // example with addMiddleware - .actions((self) => { - addMiddleware(self, atomic) - - return { - inc: flow(function* (x) { - yield delay(2) - self.z += x - yield delay(2) - self.z += x - throw "Oops" - }) - } - }) - // example with decorate - .actions((self) => { - return { - inc: decorate( - atomic, - flow(function* (x) { - yield delay(2) - self.z += x - yield delay(2) - self.z += x - throw "Oops" - }) - ) - } - }) - -const m = TestModel.create() -m.inc(3).catch((error) => { - t.is(error, "Oops") - t.is(m.z, 1) // Not 7! The change was rolled back -}) -``` - ---- - -# TimeTraveller - -This built in model can be used as stand alone store or as part of your state tree and adds time travelling capabilities. -It records all emitted snapshots by a tree and exposes the following methods / views: - -- `canUndo: boolean` -- `canRedo: boolean` -- `undo()` -- `redo()` -- `history`: array with all recorded states - -The state of the TimeTraveller itself is stored in a Mobx state tree, meaning that you can freely snapshot your state including its history. This means that it is possible to store your app state including the undo stack in for example local storage. (but beware that stringify-ing will not benefit from structural sharing). - -Usage inside a state tree: - -```javascript -import { TimeTraveller } from "mst-middlewares" - -export const Store = types.model({ - todos: types.array(Todo), - history: types.optional(TimeTraveller, { targetPath: "../todos" }) -}) - -const store = Store.create() - -// later: -if (store.history.canUndo) store.history.undo() -// etc -``` - -Note that the `targetPath` is a path relative to the `TimeTraveller` instance that will indicate which part of the tree will be snapshotted. Please make sure the targetPath doesn't point to a parent of the time traveller, as that would start recording it's own history..... In other words, `targetPath: "../"` -> Boom💥 - -To instantiate the `TimeTraveller` as a stand-alone state tree, pass in the the store through context: - -```javascript -import { TimeTraveller } from "mst-middlewares" - -export const Store = types.model({ - todos: types.array(Todo) -}) - -const store = Store.create() -const timeTraveller = TimeTraveller.create({}, { targetStore: store }) - -// later: -if (timeTraveller.canUndo) timeTraveller.undo() -// etc -``` - ---- - -# UndoManager - -The `UndoManager` is the more fine grained `TimeTraveller`. -Because it records patches instead of snapshots, it is better at dealing with concurrent and asynchronous processes. -The differences to the `TimeTraveller` make it useful to implement end-user undo / redo. - -For an in-depth explanation why undo / redo should be patch, not snapshot, based, check out the second half of the React Next talk: -[MobX-state-tree, React but for data](https://www.youtube.com/watch?v=xfC_xEA8Z1M&index=6&list=PLMYVq3z1QxSqq6D7jxVdqttOX7H_Brq8Z) - -Differences to the `TimeTraveller`: - -1. It records patches for actions / processes, not snapshots. It's therefore using less memory. -2. `undo` / `redo` applies all inverted patches / patches for a recorded action / process instead of snapshots. -3. An undo state is only comitted to the history if the action / process is finished. Ongoing processes can't be undone. -4. Failing processes do not add an undo state. -5. Multiple concurrent processes only undo their own changes and don't touch the changes caused by other actions - unlike snapshots would. -6. Can be used declaratively within the models. - -API: - -- `history: { patches: [], inversePatches [] }[]` -- `canUndo: boolean` true if there is at least one undo level available -- `canRedo: boolean` true if there is at least one redo level available -- `undoLevels: number` number of undo levels available -- `redoLevels: number` number of redo levels available -- `undo()` undo the last operation -- `redo()` redo the last operation -- `withoutUndo(() => fn)` patches for actions / processes within the fn are not recorded. -- `withoutUndoFlow(fn*)` patches the fn\* are not recorded. -- `startGroup(() => fn)` can be used to start a group, all patches within a group are saved as one history entry. -- `stopGroup()` can be used to stop the recording of patches for the grouped history entry. -- `clear({ undo?: true, redo: true }?)` clear the history. - -Setup and API usage examples: - -The setup is very similar to the one of the `TimeTraveller`. -The `UndoManager` automatically records all the actions within the tree it is attached to. - -If you want the history to be a part of your store: - -```javascript -import { UndoManager } from "mst-middlewares" - -export const Store = types - .model({ - todos: types.array(Todo), - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - // you could create your undoManger anywhere but before your first needed action within the undoManager - setUndoManager(self) - - return { - addTodo(todo) { - self.todos.push(todo) - } - // to use the undoManager to wrap the afterCreate action - // of the StoreModel it's necessary to set it within the store model like above - // afterCreate: () => undoManager.withoutUndo(() => { action() }) - } - }) - -export let undoManager = {} -export const setUndoManager = (targetStore) => { - undoManager = targetStore.history -} -const store = Store.create() -``` - -To record the changes into a separate tree: - -```javascript -import { UndoManager } from "mst-middlewares" - -export const Store = types - .model({ - todos: types.array(Todo) - }) - .actions((self) => { - // you could create your undoManger anywhere but before your first needed action within the undoManager - setUndoManager(self) - - return { - addTodo(todo) { - self.todos.push(todo) - } - // to use the undoManager to wrap the afterCreate action - // of the StoreModel it's necessary to set it within the store model like above - // afterCreate: () => undoManager.withoutUndo(() => { action() }) - } - }) - -export let undoManager = {} -export const setUndoManager = (targetStore) => { - undoManager = UndoManager.create({}, { targetStore }) -} -const store = Store.create() -``` - -If you want a limited history of actions to be recorded, for example to keep track of the last 10 actions only, you must provide a `maxHistoryLength` value through [environment data](../../README.md#dependency-injection). - -```js -// with history in your store -const store = Store.create({}, { maxHistoryLength: 10 }) - -// with history in a separate store -export const setUndoManager = (targetStore) => { - undoManager = UndoManager.create({}, { targetStore, maxHistoryLength: 10 }) -} -``` - -If you want to record changes in lifecycle hooks as well, you must provide an `includeHooks` flag: - -```js -import { UndoManager } from "mst-middlewares" - -export const Store = types - .model({ - todos: types.array(Todo) - }) - .actions((self) => { - setUndoManager(self) - - return { - afterCreate() { - self.todos.push({ title: "New Todo" }) - }, - addTodo(todo) { - self.todos.push(todo) - } - } - }) - -export let undoManager = {} -export const setUndoManager = (targetStore) => { - undoManager = UndoManager.create({}, { targetStore, includeHooks: true }) -} -const store = Store.create() -``` - -Undo/ Redo: - -```js -import { undoManager } from "../Store" - -// if the undoManger is created within another tree -const undo = () => undoManager.canUndo && undoManager.undo() -const redo = () => undoManager.canRedo && undoManager.redo() -``` - -WithoutUndo - within a react component: - -```js -import {undoManger} from '../Store' - -... - -setPersonName = () => { - // the action setPersonName won't be saved onto the history, you could add more than one action. - undoManger.withoutUndo(() => store.setPersonName('firstName', 'lastName')) -} - -render() { - return ( -
- SetPersonName -
- ) -} - -... -``` - -WithoutUndo - declarative: - -```javascript -import { types } from "mobx-state-tree" -import { UndoManager } from "mst-middlewares" - -const PersonModel = types - .model("PersonModel", { - firstName: types.string, - lastName: types.string - }) - .actions((self) => { - return { - // setPersonName won't be recorded anymore in general - setPersonName: (firstName, lastName) => - undoManager.withoutUndo(() => { - self.firstName = firstName - self.lastName = lastName - }) - } - }) - -const StoreModel = types - .model("StoreModel", { - persons: types.map(PersonModel) - }) - .actions((self) => { - setUndoManager(self) - - return { - addPerson(firstName, lastName) { - persons.put({ firstName, lastName }) - } - } - }) - -export let undoManager = {} -export const setUndoManager = (targetStore) => { - undoManager = UndoManager.create({}, { targetStore }) -} -export const Store = StoreModel.create({}) -``` - -WithoutUndoFlow - declarative: - -```js -import {undoManager} from './Store/' - -... - -.actions(self => { - function updateBooks(json) { - self.books.values().forEach(book => (book.isAvailable = false)) - json.forEach(bookJson => { - self.books.put(bookJson) - self.books.get(bookJson.id).isAvailable = true - }) - } - - function* loadBooks() { - try { - const json = yield self.shop.fetch("/books.json") - updateBooks(json) - } catch (err) { - console.error("Failed to load books ", err) - } - } - - return { - loadBooks: () => undoManager.withoutUndoFlow(loadBooks)() - // same as: undoManager.withoutUndo(() => flow(loadBooks))() - } -}) -``` - -StartGroup, StopGroup - within a react component: - -```js -import {undoManager} from '../Store' -... -handleStop = (mousePosition, { dx, dy }) => { - this.stopTrackingDrag(); - undoManager.stopGroup(); -} - -handleDrag = (mousePosition, { dx, dy }) => { - const { view, parentNode } = this.props; - // only one history entry will be created for the whole dragging - // therefore all patches will be merged to one history entry while the group is active - undoManager.startGroup(() => - parentNode.moveSelectedNodes({ dx: dx / view.zoom, dy: dy / view.zoom }) - ); -} -... -``` - ---- - -# redux - -The Redux 'middleware' is not literally middleware, but provides two useful methods for Redux interoperability: - -## asReduxStore - -`asReduxStore(mstStore, middlewares?)` creates a tiny proxy around a MST tree that conforms to the redux store api. -This makes it possible to use MST inside a redux application. - -See the [redux-todomvc example](https://github.com/coolsoftwaretyler/mst-example-redux-todomvc/blob/main/src/index.js#L20) for more details. - -## connectReduxDevtools - -`connectReduxDevtools(remoteDevDependency, mstStore, options?)` connects a MST tree to the Redux devtools. Pass in the `remoteDev` dependency to set up the connect (only one at a time). See this [example](https://github.com/coolsoftwaretyler/mst-example-redux-todomvc/blob/main/src/index.js#L21) for a setup example. - -The options object is optional and has the following options: - -- `logIdempotentActionSteps`: `true` by default due to possible performance penalty because of the internal usage of onPatch. When set to `false` it will skip reporting of actions and flow action "steps" that do not end up in an actual change in the model (except when an error is thrown), thus reducing the amount of noise in the logs. -- `logChildActions`: `false` by default. When set to `true` it will report actions that are executed inside a root actions. When set to `false` it will not. -- `logArgsNearName`: `true` by default. When `true` it will log the arguments near the action name (truncated if too long), when `false` it won't. diff --git a/packages/mst-middlewares/__tests__/__snapshots__/redux.test.ts.snap b/packages/mst-middlewares/__tests__/__snapshots__/redux.test.ts.snap deleted file mode 100644 index f5cc061f5..000000000 --- a/packages/mst-middlewares/__tests__/__snapshots__/redux.test.ts.snap +++ /dev/null @@ -1,1843 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`#1065 - flows in root afterCreate shouldn't crash 1`] = `Array []`; - -exports[`#1065 - flows in root afterCreate shouldn't crash 2`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "Root/SubModel", - "type": "[root/sub] *unknownAction*() (?)", - }, - Object { - "sub": Object { - "num": 1, - }, - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "Root/SubModel", - "type": "[root/sub] *unknownAction*() (?)", - }, - Object { - "sub": Object { - "num": 2, - }, - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) applySnapshot(m, { x: "snapshotX" }) 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "x": "snapshotX", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] @APPLY_SNAPSHOT({\\"x\\":\\"snapshotX\\"})", - }, - Object { - "array": Array [], - "x": "snapshotX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) concurrent [m.setYAsync() / m.setXAsync()] 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.addtoArray({ a: "otherA" }), m.array[0].setA() 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "a": "otherA", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] addtoArray({\\"a\\":\\"otherA\\"})", - }, - Object { - "array": Array [ - Object { - "a": "otherA", - }, - ], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel/SubModel[]/SubModel", - "type": "[root/array/0] setA()", - }, - Object { - "array": Array [ - Object { - "a": "setA", - }, - ], - "x": "", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setX() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXAsyncWithEmptyFirstPart() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncWithEmptyFirstPart +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXThrow() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXThrow() -error thrown-", - }, - Object { - "array": Array [], - "x": "setXThrow", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXY() -> m.setX(), m.setY() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXY()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "setY", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXYAsync() -> m.setXAsync(), m.setYAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (2)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (3)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXYAsyncThrowAsync() -> m.setXYAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: false) m.setXYAsyncThrowSync() -> m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) applySnapshot(m, { x: "snapshotX" }) 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "x": "snapshotX", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] @APPLY_SNAPSHOT({\\"x\\":\\"snapshotX\\"})", - }, - Object { - "array": Array [], - "x": "snapshotX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) concurrent [m.setYAsync() / m.setXAsync()] 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.addtoArray({ a: "otherA" }), m.array[0].setA() 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "a": "otherA", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] addtoArray({\\"a\\":\\"otherA\\"})", - }, - Object { - "array": Array [ - Object { - "a": "otherA", - }, - ], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel/SubModel[]/SubModel", - "type": "[root/array/0] setA()", - }, - Object { - "array": Array [ - Object { - "a": "setA", - }, - ], - "x": "", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setX() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXAsyncWithEmptyFirstPart() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncWithEmptyFirstPart +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXThrow() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXThrow() -error thrown-", - }, - Object { - "array": Array [], - "x": "setXThrow", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXY() -> m.setX(), m.setY() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXY() >>> [root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXY() >>> [root] setY()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "setY", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXYAsync() -> m.setXAsync(), m.setYAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (0) >>> [root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (1) >>> [root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (2) >>> [root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (3) >>> [root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXYAsyncThrowAsync() -> m.setXYAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowAsync() (0) >>> [root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowAsync() (1) >>> [root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (2) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: false, logChildActions: true) m.setXYAsyncThrowSync() -> m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowSync() (0) >>> [root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowSync() (1) >>> [root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (2) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) applySnapshot(m, { x: "snapshotX" }) 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "x": "snapshotX", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] @APPLY_SNAPSHOT({\\"x\\":\\"snapshotX\\"})", - }, - Object { - "array": Array [], - "x": "snapshotX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) concurrent [m.setYAsync() / m.setXAsync()] 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.addtoArray({ a: "otherA" }), m.array[0].setA() 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "a": "otherA", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] addtoArray({\\"a\\":\\"otherA\\"})", - }, - Object { - "array": Array [ - Object { - "a": "otherA", - }, - ], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel/SubModel[]/SubModel", - "type": "[root/array/0] setA()", - }, - Object { - "array": Array [ - Object { - "a": "setA", - }, - ], - "x": "", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setX() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXAsyncWithEmptyFirstPart() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncWithEmptyFirstPart +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXThrow() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXThrow() -error thrown-", - }, - Object { - "array": Array [], - "x": "setXThrow", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXY() -> m.setX(), m.setY() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXY()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "setY", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXYAsync() -> m.setXAsync(), m.setYAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (2)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (3)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (4)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (5)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (6)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXYAsyncThrowAsync() -> m.setXYAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (2)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (3) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: false) m.setXYAsyncThrowSync() -> m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (2)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (3) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) applySnapshot(m, { x: "snapshotX" }) 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Array [], - ], - "targetTypePath": "TestModel >>> TestModel/SubModel[]", - "type": "[root] @APPLY_SNAPSHOT({\\"x\\":\\"snapshotX\\"}) >>> [root/array] @APPLY_SNAPSHOT([])", - }, - Object { - "array": Array [], - "x": "snapshotX", - "y": "", - }, - ], - Array [ - Object { - "args": Array [ - Object { - "x": "snapshotX", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] @APPLY_SNAPSHOT({\\"x\\":\\"snapshotX\\"})", - }, - Object { - "array": Array [], - "x": "snapshotX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) concurrent [m.setYAsync() / m.setXAsync()] 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.addtoArray({ a: "otherA" }), m.array[0].setA() 1`] = ` -Array [ - Array [ - Object { - "args": Array [ - Object { - "a": "otherA", - }, - ], - "targetTypePath": "TestModel", - "type": "[root] addtoArray({\\"a\\":\\"otherA\\"})", - }, - Object { - "array": Array [ - Object { - "a": "otherA", - }, - ], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel/SubModel[]/SubModel", - "type": "[root/array/0] setA()", - }, - Object { - "array": Array [ - Object { - "a": "setA", - }, - ], - "x": "", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setX() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXAsyncWithEmptyFirstPart() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (0)", - }, - Object { - "array": Array [], - "x": "", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXAsyncWithEmptyFirstPart() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncWithEmptyFirstPart +20", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXThrow() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXThrow() -error thrown-", - }, - Object { - "array": Array [], - "x": "setXThrow", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXY() -> m.setX(), m.setY() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXY() >>> [root] setX()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXY() >>> [root] setY()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "setY", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXY()", - }, - Object { - "array": Array [], - "x": "setX", - "y": "setY", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXYAsync() -> m.setXAsync(), m.setYAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (0) >>> [root] setXAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (2) >>> [root] setXAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (3) >>> [root] setYAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (4)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +0", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsync() (5) >>> [root] setYAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsync() (6)", - }, - Object { - "array": Array [], - "x": "setXAsync +20", - "y": "setYAsync +50", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXYAsyncThrowAsync() -> m.setXYAsyncThrowAsync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowAsync() (0) >>> [root] setXAsyncThrowAsync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowAsync() (2) >>> [root] setXAsyncThrowAsync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowAsync() (3) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowAsync +0", - "y": "", - }, - ], -] -`; - -exports[`(logIdempotentActionSteps: true, logChildActions: true) m.setXYAsyncThrowSync() -> m.setXAsyncThrowSync() 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowSync() (0) >>> [root] setXAsyncThrowSync() (0)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (1)", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel >>> TestModel", - "type": "[root] setXYAsyncThrowSync() (2) >>> [root] setXAsyncThrowSync() (1) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], - Array [ - Object { - "args": Array [], - "targetTypePath": "TestModel", - "type": "[root] setXYAsyncThrowSync() (3) -error thrown-", - }, - Object { - "array": Array [], - "x": "setXAsyncThrowSync +0", - "y": "", - }, - ], -] -`; - -exports[`bourquep 1`] = ` -Array [ - Array [ - Object { - "args": Array [], - "targetTypePath": "SchoolYearConfigurationModel/Map ContentDefinitionModel)>/ContentDefinition", - "type": "[root/contents/one] toggleState()", - }, - Object { - "contents": Object { - "one": Object { - "id": "200", - "state": 2, - }, - }, - "id": "100", - }, - ], -] -`; diff --git a/packages/mst-middlewares/__tests__/action-logger.test.ts b/packages/mst-middlewares/__tests__/action-logger.test.ts deleted file mode 100644 index 1087b8eb6..000000000 --- a/packages/mst-middlewares/__tests__/action-logger.test.ts +++ /dev/null @@ -1,83 +0,0 @@ -import * as mst from "mobx-state-tree" -import { flow } from "mobx-state-tree" -import { actionLogger } from "../src" - -let log: jest.Mock -beforeAll(() => { - log = console.log = jest.fn() -}) - -beforeEach(() => { - log.mockClear() -}) - -test("it logs", () => { - const Todo = mst.types - .model({ - title: "" - }) - .actions((self) => ({ - helper() {}, - setTitle(newTitle: string) { - ;(self as any).helper() // should not be logged - self.title = newTitle - } - })) - - const Store = mst.types.model({ - todos: mst.types.array(Todo) - }) - - const store = Store.create({ - todos: [{ title: "test " }] - }) - mst.addMiddleware(store, actionLogger) - - store.todos[0].setTitle("hello world") - - expect(log).toHaveBeenCalledTimes(1) - expect(log.mock.calls[0][0]).toBe("[MST] #1 action - /todos/0/setTitle") -}) - -test("it logs flows", async () => { - const Todo = mst.types - .model({ - title: "" - }) - .actions((self) => ({ - helper() {}, - helper2: flow(function* helper2() { - return Promise.resolve(3) - }) - })) - .actions((self) => ({ - setTitle: flow(function* setTitle(newTitle: string) { - self.helper() // should not be logged - yield self.helper2() // should be logged - self.title = newTitle - return - }) - })) - - const Store = mst.types.model({ - todos: mst.types.array(Todo) - }) - - const store = Store.create({ - todos: [{ title: "test " }] - }) - mst.addMiddleware(store, actionLogger) - - await store.todos[0].setTitle("hello world") - const expectedLog = [ - "[MST] #3 action - /todos/0/setTitle", - "[MST] #3 flow_spawn - /todos/0/setTitle", - "[MST] #3 flow_spawn - /todos/0/helper2", - "[MST] #3 flow_return - /todos/0/helper2", - "[MST] #3 flow_return - /todos/0/setTitle" - ] - expect(log).toHaveBeenCalledTimes(expectedLog.length) - log.mock.calls.forEach((c, idx) => { - expect(c[0]).toBe(expectedLog[idx]) - }) -}) diff --git a/packages/mst-middlewares/__tests__/atomic.test.ts b/packages/mst-middlewares/__tests__/atomic.test.ts deleted file mode 100644 index 3ad42d971..000000000 --- a/packages/mst-middlewares/__tests__/atomic.test.ts +++ /dev/null @@ -1,168 +0,0 @@ -import atomic from "../src/atomic" -import { types, addMiddleware, flow, decorate } from "mobx-state-tree" - -const TestModel = types - .model({ - a: 1, - b: 1 - }) - .actions((self) => { - addMiddleware(self, atomic) - return { - incA(x: number) { - self.a += x - this.incB(x) - return self.a - }, - incB(x: number) { - self.b += x - return self.b - }, - throwingFn(x: number) { - this.incA(x) - throw "Oops" - }, - - incProcessA: flow(function* (x: number) { - yield Promise.resolve() - self.a += x - yield Promise.resolve() - self.a += x - yield (self as any).incProcessB(x) - return self.a - }), - incProcessB: flow(function* (x: number) { - yield Promise.resolve() - self.b += x - yield Promise.resolve() - self.b += x - return self.a - }), - throwingProcess: flow(function* (x: number) { - yield (self as any).incProcessA(x) - throw "Oops" - }) - } - }) - -test("should run action normally", () => { - const m = TestModel.create() - expect(m.incA(3)).toBe(4) - expect(m.a).toBe(4) - expect(m.b).toBe(4) -}) - -test("should rollback on action failure", () => { - const m = TestModel.create() - expect(() => { - m.throwingFn(3) - }).toThrow(/Oops/) - expect(m.a).toBe(1) - expect(m.b).toBe(1) -}) - -test("should run async action normally on action failure", async () => { - const m = TestModel.create() - const value = await m.incProcessA(3) - expect(value).toBe(7) - expect(m.a).toBe(7) - expect(m.b).toBe(7) -}) - -test("should rollback on async action failure", async () => { - const m = TestModel.create() - try { - await m.throwingProcess(3) - } catch (e) { - expect(e).toBe("Oops") - expect(m.a).toBe(1) - expect(m.b).toBe(1) - } -}) - -test("decorate atomic should work", () => { - const T = types - .model({ - a: 0 - }) - .actions((self) => ({ - inc(x: number) { - self.a += x - }, - atomicInc: decorate(atomic, (x: number, _throw: boolean) => { - self.a += x - ;(self as any).inc(x) - if (_throw) { - throw "Oops" - } - return self.a - }), - nonAtomicInc(x: number, _throw: boolean) { - self.a += x - ;(self as any).inc(x) - if (_throw) { - throw "Oops" - } - return self.a - } - })) - - const t = T.create() - expect(t.atomicInc(1, false)).toBe(2) - expect(t.nonAtomicInc(-1, false)).toBe(0) - - expect(t.a).toBe(0) - expect(() => t.atomicInc(1, true)).toThrow("Oops") - expect(t.a).toBe(0) - - expect(() => t.nonAtomicInc(1, true)).toThrow("Oops") - expect(t.a).toBe(2) -}) - -test("#1250", async () => { - const M = types - .model({ - x: 0, - y: 0 - }) - .actions((self) => ({ - setX: decorate( - atomic, - flow(function* () { - self.x = 10 - yield new Promise((resolve) => setTimeout(resolve, 1000)) - // trigger an undo through atomic - throw new Error() - }) - ), - - setY() { - self.y = 10 - } - })) - - const model = M.create({}) - - expect(model.x).toBe(0) - expect(model.y).toBe(0) - const p = model.setX() - expect(model.x).toBe(10) - expect(model.y).toBe(0) - - await new Promise((r) => - setTimeout(() => { - model.setY() - r() - }, 500) - ) - expect(model.x).toBe(10) - expect(model.y).toBe(10) - - try { - await p - fail("should have failed") - } catch (e) { - expect(model.x).toBe(0) - expect(model.y).toBe(10) - } -}) diff --git a/packages/mst-middlewares/__tests__/custom.test.ts b/packages/mst-middlewares/__tests__/custom.test.ts deleted file mode 100644 index 5af2c7d56..000000000 --- a/packages/mst-middlewares/__tests__/custom.test.ts +++ /dev/null @@ -1,230 +0,0 @@ -import { decorate, types, addMiddleware, flow, destroy, IMiddlewareHandler } from "mobx-state-tree" - -let error: any = null - -const omitNextAbort: IMiddlewareHandler = (call, next) => { - // omit next() / abort() -} -const nextAndAbort: IMiddlewareHandler = (call, next, abort) => { - abort("someValue") - next(call) -} - -const abortString: IMiddlewareHandler = (call, next, abort) => { - abort("someValue") -} -const abortNumeric: IMiddlewareHandler = (call, next, abort) => { - abort(5) -} -const abortPromise: IMiddlewareHandler = (call, next, abort) => { - abort(Promise.resolve(5)) -} -const nextNoAlter: IMiddlewareHandler = (call, next, abort) => { - next(call) -} -const nextAlter: IMiddlewareHandler = (call, next, abort) => { - next(call, (value) => value + 1) -} -const nextAlter2: IMiddlewareHandler = (call, next, abort) => { - next(call, (value) => value + 2) -} -const alterArguments: IMiddlewareHandler = (call, next, abort) => { - next({ ...call, args: [call.args[0].toUpperCase()] }) -} -const alterArguments2: IMiddlewareHandler = (call, next, abort) => { - // cut last char - next({ ...call, args: [call.args[0].slice(0, -1)] }) -} -const nextAlterAsync: IMiddlewareHandler = (call, next, abort) => { - next(call, async (value) => (await value) + 2) -} - -const noHooksMiddleware: IMiddlewareHandler = (call, next, abort) => { - // throwing errors will lead to the aborting of further middlewares - // => don't throw here but set a global var instead - if (call.name === "beforeDestroy") error = Error("hook in middleware") - next(call) -} -const shouldNeverBeInvoked: IMiddlewareHandler = (call, next, abort) => { - error = Error("customMiddleware called even though the queue was aborted") - next(call) -} - -function delay(time: number) { - return new Promise((resolve) => { - setTimeout(resolve, time) - }) -} - -const TestModel = types - .model("Test1", { - z: 1 - }) - .postProcessSnapshot((snapshot) => { - return snapshot - }) - .actions((self) => { - return { - asyncInc: flow(function* (x: number) { - yield delay(2) - self.z += x - yield delay(2) - return self.z - }), - asyncIncSuccess: flow(function* (x: number) { - yield (self as any).asyncAbortedPromise() // will return a string instead of a promise. - self.z += x - return self.z - }), - asyncIncFailing: flow(function* (x: number) { - yield (self as any).asyncAbortedString() // will return a string instead of a promise. - self.z += x - return self.z - }), - asyncAbortedString: decorate( - abortString, - flow(function* (x: number) { - // this will fail since "Only promises can be yielded" within flows. - yield delay(2) - return 205 - }) - ), - asyncAbortedPromise: decorate( - abortPromise, - flow(function* (x: number) { - yield delay(2) - return 205 - }) - ), - inc(x: number) { - self.z += x - return self.z - }, - addName(name: string) { - return name - }, - beforeDestroy() {} - } - }) - -test("next() middleware queue ", () => { - const m = TestModel.create() - addMiddleware(m, nextNoAlter) // no alterations - const valueFromMiddleware: any = m.inc(1) - expect(valueFromMiddleware).toBe(2) -}) - -test("next() middleware queue and alter the call arguments", () => { - const m = TestModel.create() - addMiddleware(m, alterArguments) - addMiddleware(m, alterArguments2) - const valueFromMiddleware: any = m.addName("Freddy") - expect(valueFromMiddleware).toBe("FREDD") -}) - -test("next() middleware queue and alter the action value", () => { - const m = TestModel.create() - addMiddleware(m, nextAlter) // contains the manipulation + 1 - addMiddleware(m, nextAlter2) // contains another manipulation + 2 - const valueFromMiddleware: any = m.inc(1) // value should be 2(inc) + all the maniuplations = 5 - expect(valueFromMiddleware).toBe(5) -}) - -test("next() middleware queue and alter the async action value", async () => { - const m = TestModel.create() - addMiddleware(m, nextAlterAsync) // contains another manipulation + 2 - const valueFromMiddleware: any = await m.asyncInc(1) // value should be 2(inc) + all the maniuplations = 5 - expect(valueFromMiddleware).toBe(4) -}) - -test("abort() middleware queue", () => { - error = null - const m = TestModel.create() - addMiddleware(m, abortString) // contains abort() - addMiddleware(m, shouldNeverBeInvoked) // would contain next() - should never be invoked - - const valueFromMiddleware: any = m.inc(1) // the return value should be the one from the aborting middleware - expect(valueFromMiddleware).toBe("someValue") - expect(error).toBe(null) // make sure the cutomMiddleware4 was never invoked -}) - -test("abort() middleware queue and alter the abort value", () => { - const m = TestModel.create() - addMiddleware(m, nextAlter) // contains the manipulation - addMiddleware(m, abortNumeric) // does abort with numeric - - const valueFromMiddleware: any = m.inc(1) - expect(valueFromMiddleware).toBe(6) -}) - -test("next() middleware queue and alter the async action value", async () => { - const m = TestModel.create() - addMiddleware(m, nextAlterAsync) // + 2 - addMiddleware(m, abortPromise) // => 5 - const valueFromMiddleware: any = await m.asyncInc(1) // => 7 - expect(valueFromMiddleware).toBe(7) -}) - -test("abort() within nested async actions with string", async () => { - const m = TestModel.create() - try { - const valueFromMiddleware: any = await m.asyncIncFailing(1) // contains 2 delays - } catch (e) { - // TODO: once we'd change flow to be able to yield more than just a promise - // this test must be changed. - expect(e).toBeTruthy() - } -}) - -test("abort() within nested async actions with promise", async () => { - const m = TestModel.create() - const valueFromMiddleware: any = await m.asyncIncSuccess(1) // should only abort inner. - expect(valueFromMiddleware).toBe(2) -}) - -test("middleware should be invoked on hooks", () => { - error = null - const m = TestModel.create() - addMiddleware(m, noHooksMiddleware) - m.inc(1) - destroy(m) - expect(error).toBeTruthy() -}) - -test("middleware should not be invoked on hooks", () => { - error = null - const m = TestModel.create() - addMiddleware(m, noHooksMiddleware, false) - m.inc(1) - destroy(m) - expect(error).toBeFalsy() -}) - -// These tests will leave MST in a bad state since they're throwing. Leave the at the bottom. -if (process.env.NODE_ENV === "development") { - test("next()/ abort() omitted within middleware", () => { - const m = TestModel.create() - addMiddleware(m, omitNextAbort) - let thrownError: any = null - try { - m.inc(1) - } catch (e) { - thrownError = e - } - expect(thrownError).toBeTruthy() - }) -} - -if (process.env.NODE_ENV === "development") { - test("abort() and next() invoked within middleware", () => { - const m = TestModel.create() - addMiddleware(m, nextAndAbort) - let thrownError: any = null - try { - m.inc(1) - } catch (e) { - thrownError = e - } - expect(thrownError).toBeTruthy() - }) -} diff --git a/packages/mst-middlewares/__tests__/redux.test.ts b/packages/mst-middlewares/__tests__/redux.test.ts deleted file mode 100644 index 5a61bb1ba..000000000 --- a/packages/mst-middlewares/__tests__/redux.test.ts +++ /dev/null @@ -1,339 +0,0 @@ -import { types, flow, SnapshotOrInstance, cast, applySnapshot } from "mobx-state-tree" -import { connectReduxDevtools } from "mst-middlewares/src" - -jest.useRealTimers() - -const waitAsync = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)) -const waitAsyncReject = async (ms: number) => { - await waitAsync(ms) - throw new Error("thrown") -} - -test("waitAsync helper works", async () => { - await waitAsync(10) -}) - -test("waitAsyncReject helper works", async () => { - try { - await waitAsyncReject(10) - throw fail("should have failed") - } catch { - // do nothing - } -}) - -const M2 = types - .model("SubModel", { - a: "" - }) - .actions((self) => ({ - setA() { - self.a = "setA" - } - })) - -const M = types - .model("TestModel", { - x: "uninitializedX", - y: "", - array: types.array(M2) - }) - .actions((self) => ({ - afterCreate() { - self.x = "" - }, - - addtoArray(val: SnapshotOrInstance) { - self.array.push(cast(val)) - }, - setX() { - self.x = "setX" - }, - setXThrow() { - self.x = "setXThrow" - throw new Error("bye") - }, - setXAsync: flow(function* () { - self.x = "setXAsync +0" - yield waitAsync(20) - self.x = "setXAsync +20" - }), - setXAsyncWithEmptyFirstPart: flow(function* () { - yield waitAsync(20) - self.x = "setXAsyncWithEmptyFirstPart +20" - }), - setXAsyncThrowSync: flow(function* () { - self.x = "setXAsyncThrowSync +0" - yield waitAsync(20) - throw new Error("setXAsyncThrowSync +20") - }), - setXAsyncThrowAsync: flow(function* () { - self.x = "setXAsyncThrowAsync +0" - yield waitAsyncReject(20) - }), - - setY() { - self.y = "setY" - }, - setYThrow() { - self.y = "setYThrow" - throw new Error("bye2") - }, - setYAsync: flow(function* setYAsync2() { - self.y = "setYAsync +0" - yield waitAsync(50) - self.y = "setYAsync +50" - }), - setYAsyncThrowSync: flow(function* () { - self.y = "setYAsyncThrowSync +0" - yield waitAsync(50) - throw new Error("setYAsyncThrowSync +50") - }), - setYAsyncThrowAsync: flow(function* () { - self.y = "setYAsyncThrowAsync +0" - yield waitAsyncReject(50) - }), - setXY() { - this.setX() - this.setY() - } - })) - .actions((self) => ({ - setXYAsync: flow(function* () { - yield self.setXAsync() - yield self.setYAsync() - }), - setXYAsyncThrowSync: flow(function* () { - yield self.setXAsyncThrowSync() - }), - setXYAsyncThrowAsync: flow(function* () { - yield self.setXAsyncThrowAsync() - }) - })) - -let m = M.create() -function mockDevTools() { - return { init: jest.fn(), subscribe: jest.fn(), send: jest.fn() } -} -let devTools = mockDevTools() - -function initTest(logIdempotentActionSteps: boolean, logChildActions: boolean) { - devTools = mockDevTools() - - const devToolsManager = { - connectViaExtension: () => devTools, - extractState: jest.fn() - } - - m = M.create() - connectReduxDevtools(devToolsManager, m, { logIdempotentActionSteps, logChildActions }) -} - -function addStandardTests() { - test("m.setX()", () => { - m.setX() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXThrow()", () => { - expect(() => m.setXThrow()).toThrow() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXAsync()", async () => { - await m.setXAsync() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXAsyncThrowSync()", async () => { - try { - await m.setXAsyncThrowSync() - throw fail("should have thrown") - } catch {} - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXAsyncThrowAsync()", async () => { - try { - await m.setXAsyncThrowAsync() - throw fail("should have thrown") - } catch {} - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("concurrent [m.setYAsync() / m.setXAsync()]", async () => { - // expected order is y0, x0, x1, y1 due to timeouts - const b = m.setYAsync() - const a = m.setXAsync() - await Promise.all([b, a]) - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXY() -> m.setX(), m.setY()", () => { - m.setXY() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXYAsync() -> m.setXAsync(), m.setYAsync()", async () => { - await m.setXYAsync() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXYAsyncThrowSync() -> m.setXAsyncThrowSync()", async () => { - try { - await m.setXYAsyncThrowSync() - throw fail("should have thrown") - } catch {} - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXYAsyncThrowAsync() -> m.setXYAsyncThrowAsync()", async () => { - try { - await m.setXYAsyncThrowAsync() - throw fail("should have thrown") - } catch {} - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test("m.setXAsyncWithEmptyFirstPart()", async () => { - await m.setXAsyncWithEmptyFirstPart() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test('m.addtoArray({ a: "otherA" }), m.array[0].setA()', () => { - m.addtoArray({ a: "otherA" }) - m.array[0]!.setA() - expect(devTools.send.mock.calls).toMatchSnapshot() - }) - - test('applySnapshot(m, { x: "snapshotX" })', () => { - applySnapshot(m, { x: "snapshotX" }) - expect(devTools.send.mock.calls).toMatchSnapshot() - }) -} - -for (const logIdempotentActionSteps of [false, true]) { - for (const logChildActions of [true, false]) { - describe(`(logIdempotentActionSteps: ${logIdempotentActionSteps}, logChildActions: ${logChildActions})`, () => { - beforeEach(() => { - initTest(logIdempotentActionSteps, logChildActions) - }) - - addStandardTests() - }) - } -} - -test("bourquep", () => { - enum ContentState { - Active, - Cancelled, - Completed - } - - const ContentStateEnumDef = types.custom({ - name: "ContentStateEnumDef", - fromSnapshot(value: number): ContentState { - let cs = ContentState as any - return cs[cs[value]] - }, - toSnapshot(value: ContentState): number { - return value - }, - isTargetType(value: number): value is ContentState { - return value in ContentState - }, - getValidationMessage(value: number): string { - if (value in ContentState) { - return "" - } - return value + " is not a real value of ContentState." - } - }) - - const SchoolYearConfigurationModel = types.model("SchoolYearConfigurationModel", { - id: types.identifier, - contents: types.map(types.late(() => ContentDefinitionModel)) - }) - - const ContentDefinitionModel = types - .model("ContentDefinition", { - id: types.identifier, - state: types.optional(ContentStateEnumDef, 0) - }) - - .actions((self) => { - const _actions = { - toggleState() { - if (self.state === ContentState.Cancelled) { - return - } - - let newState = - self.state === ContentState.Active - ? ContentState.Completed - : ContentState.Active - self.state = newState - } - } - - return _actions - }) - - const store = SchoolYearConfigurationModel.create({ - id: "100", - contents: { one: { id: "200" } } - }) - - devTools = mockDevTools() - const devToolsManager = { connectViaExtension: () => devTools, extractState: jest.fn() } - connectReduxDevtools(devToolsManager, store, { - logIdempotentActionSteps: false, - logChildActions: false - }) - - store.contents.get("one")!.toggleState() - expect(devTools.send.mock.calls).toMatchSnapshot() -}) - -test("#1065 - flows in root afterCreate shouldn't crash", async () => { - const SubModel = types - .model("SubModel", { - num: 0 - }) - .actions((self) => { - return { - someFlow: flow(function* () { - yield waitAsync(50) - self.num++ - yield waitAsync(50) - self.num++ - }) - } - }) - - const Root = types - .model("Root", { - sub: types.optional(SubModel, {}) - }) - .actions((self) => { - return { - afterCreate: () => { - self.sub.someFlow() - } - } - }) - - const store = Root.create({}) - - devTools = mockDevTools() - const devToolsManager = { connectViaExtension: () => devTools, extractState: jest.fn() } - connectReduxDevtools(devToolsManager, store, { - logIdempotentActionSteps: false, - logChildActions: false - }) - - expect(devTools.send.mock.calls).toMatchSnapshot() - await waitAsync(200) - expect(devTools.send.mock.calls).toMatchSnapshot() -}) diff --git a/packages/mst-middlewares/__tests__/simple-action-logger.test.ts b/packages/mst-middlewares/__tests__/simple-action-logger.test.ts deleted file mode 100644 index cc32279d8..000000000 --- a/packages/mst-middlewares/__tests__/simple-action-logger.test.ts +++ /dev/null @@ -1,39 +0,0 @@ -import * as mst from "mobx-state-tree" -import { simpleActionLogger } from "../src" - -let log: jest.Mock -beforeAll(() => { - log = console.log = jest.fn() -}) - -beforeEach(() => { - log.mockClear() -}) - -test("it logs", () => { - const Todo = mst.types - .model({ - title: "" - }) - .actions((self) => ({ - helper() {}, - setTitle(newTitle: string) { - ;(self as any).helper() // should not be logged - self.title = newTitle - } - })) - - const Store = mst.types.model({ - todos: mst.types.array(Todo) - }) - - const store = Store.create({ - todos: [{ title: "test " }] - }) - mst.addMiddleware(store, simpleActionLogger) - - store.todos[0].setTitle("hello world") - - expect(log).toHaveBeenCalledTimes(1) - expect(log.mock.calls[0][0]).toBe("[MST] /todos/0/setTitle") -}) diff --git a/packages/mst-middlewares/__tests__/time-traveller.test.ts b/packages/mst-middlewares/__tests__/time-traveller.test.ts deleted file mode 100644 index 436c9b0a4..000000000 --- a/packages/mst-middlewares/__tests__/time-traveller.test.ts +++ /dev/null @@ -1,102 +0,0 @@ -import { TimeTraveller } from "../src" -import { types, clone } from "mobx-state-tree" - -const TestModel = types - .model({ - x: 1 - }) - .actions((self) => ({ - inc() { - self.x += 1 - } - })) - -test("it can time travel", () => { - const m = TestModel.create() - const tt = TimeTraveller.create({}, { targetStore: m }) - - expect(tt.canUndo).toBe(false) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(1) - - m.inc() - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(2) - - m.inc() - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(3) - - tt.undo() - expect(m.x).toBe(2) - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(true) - - tt.undo() - expect(m.x).toBe(1) - expect(tt.canUndo).toBe(false) - expect(tt.canRedo).toBe(true) - - tt.redo() - expect(m.x).toBe(2) - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(true) - - // resets 'future' - m.inc() - expect(m.x).toBe(3) - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(false) -}) - -test("it can time travel same store and persist state", () => { - const W = types.model({ - model: types.optional(TestModel, {}), - traveler: types.optional(TimeTraveller, { targetPath: "../model" }) - }) - const w = W.create() - const m = w.model - const tt = w.traveler - - expect(tt.canUndo).toBe(false) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(1) - - m.inc() - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(2) - - m.inc() - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(false) - expect(m.x).toBe(3) - - tt.undo() - expect(m.x).toBe(2) - expect(tt.canUndo).toBe(true) - expect(tt.canRedo).toBe(true) - - // Clone of the store should inherit the same state! - const w2 = clone(w) - const m2 = w2.model - const tt2 = w2.traveler - - tt2.undo() - expect(m2.x).toBe(1) - expect(tt2.canUndo).toBe(false) - expect(tt2.canRedo).toBe(true) - - tt2.redo() - expect(m2.x).toBe(2) - expect(tt2.canUndo).toBe(true) - expect(tt2.canRedo).toBe(true) - - // resets 'future' - m2.inc() - expect(m2.x).toBe(3) - expect(tt2.canUndo).toBe(true) - expect(tt2.canRedo).toBe(false) -}) diff --git a/packages/mst-middlewares/__tests__/tsconfig.json b/packages/mst-middlewares/__tests__/tsconfig.json deleted file mode 100644 index 17a7b2c31..000000000 --- a/packages/mst-middlewares/__tests__/tsconfig.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "extends": "../tsconfig.json", - "compilerOptions": { - "rootDir": "../", - "module": "commonjs", - "lib": ["es2017", "dom"], - "target": "es6", - "sourceMap": false, - "noEmit": true - }, - "include": ["**/*.ts"] -} diff --git a/packages/mst-middlewares/__tests__/tslint.json b/packages/mst-middlewares/__tests__/tslint.json deleted file mode 100644 index 55f072963..000000000 --- a/packages/mst-middlewares/__tests__/tslint.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "../../../tslint.json" -} diff --git a/packages/mst-middlewares/__tests__/undo-manager.test.ts b/packages/mst-middlewares/__tests__/undo-manager.test.ts deleted file mode 100644 index 4426927a6..000000000 --- a/packages/mst-middlewares/__tests__/undo-manager.test.ts +++ /dev/null @@ -1,570 +0,0 @@ -import { UndoManager } from "../src" -import { types, clone, getSnapshot, flow, Instance } from "mobx-state-tree" -import { configure } from "mobx" - -let undoManager: any = {} -const setUndoManagerSameTree = (targetStore: any) => { - undoManager = targetStore.history -} -const setUndoManagerDifferentTree = (targetStore: any, includeHooks?: boolean) => { - undoManager = UndoManager.create({}, { targetStore, includeHooks }) -} - -const canTimeTravel = (store: any) => { - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(1) - - store.inc() - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(2) - - store.inc() - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(3) - - undoManager.undo() - expect(store.x).toBe(2) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(true) - - undoManager.undo() - expect(store.x).toBe(1) - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(true) - - undoManager.redo() - expect(store.x).toBe(2) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(true) - - // resets 'future' - store.inc() - expect(store.x).toBe(3) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) -} - -test("same tree - can time travel", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryOnTreeStoreModel.create() - canTimeTravel(store) -}) - -test("different tree - can time travel", () => { - const HistoryDifferentTreeStoreModel = types - .model({ - x: 1 - }) - .actions((self) => { - setUndoManagerDifferentTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryDifferentTreeStoreModel.create() - canTimeTravel(store) -}) - -test("same tree - can time travel and persist state", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryOnTreeStoreModel.create() - - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(1) - - store.inc() - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(2) - - store.inc() - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(3) - - undoManager.undo() - expect(store.x).toBe(2) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(true) - - // Clone of the store should inherit the same state! - const store2 = clone(store) - const undoManager2 = store2.history - - undoManager2.undo() - expect(store2.x).toBe(1) - expect(undoManager2.canUndo).toBe(false) - expect(undoManager2.canRedo).toBe(true) - - undoManager2.redo() - expect(store2.x).toBe(2) - expect(undoManager2.canUndo).toBe(true) - expect(undoManager2.canRedo).toBe(true) - - // resets 'future' - store2.inc() - expect(store2.x).toBe(3) - expect(undoManager2.canUndo).toBe(true) - expect(undoManager2.canRedo).toBe(false) -}) - -test("can time travel with Mutable object", () => { - const MutableUnion: any = types.union( - types.string, - types.boolean, - types.number, - types.map(types.late(() => MutableUnion)), - types.array(types.late(() => MutableUnion)) - ) - const MutableStoreModel = types - .model({ - mutable: MutableUnion - }) - .actions((self) => { - setUndoManagerDifferentTree(self) - return { - setProp(k: string, v: any) { - ;(self.mutable as any).set(k, v) - } - } - }) - const store = MutableStoreModel.create({ mutable: {} }) - const mutable = store.mutable - - expect(getSnapshot(mutable)).toEqual({}) - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(false) - expect(undoManager.history.length).toBe(0) - - store.setProp("foo", 1) - expect(getSnapshot(mutable)).toEqual({ foo: 1 }) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(undoManager.history.length).toBe(1) - - store.setProp("foo", {}) - expect(getSnapshot(mutable)).toEqual({ foo: {} }) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(false) - expect(undoManager.history.length).toBe(2) - - undoManager.undo() - expect(getSnapshot(mutable)).toEqual({ foo: 1 }) - expect(undoManager.canUndo).toBe(true) - expect(undoManager.canRedo).toBe(true) - expect(undoManager.history.length).toBe(2) - - undoManager.undo() - expect(getSnapshot(mutable)).toEqual({}) - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(true) - expect(undoManager.history.length).toBe(2) -}) - -const withoutUndo = (store: any) => { - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(1) - - undoManager.withoutUndo(() => store.inc()) - expect(undoManager.canUndo).toBe(false) - expect(undoManager.canRedo).toBe(false) - expect(store.x).toBe(2) -} - -test("same tree - withoutUndo", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryOnTreeStoreModel.create() - withoutUndo(store) -}) - -test("different tree - withoutUndo", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1 - }) - .actions((self) => { - setUndoManagerDifferentTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryOnTreeStoreModel.create() - withoutUndo(store) -}) - -test("same tree - withoutUndo declaratively", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc: () => - undoManager.withoutUndo(() => { - self.x += 1 - }) - } - }) - - const store = HistoryOnTreeStoreModel.create() - withoutUndo(store) -}) - -test("same tree - maxHistoryLength", async () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x += 1 - } - } - }) - const store = HistoryOnTreeStoreModel.create({}, { maxHistoryLength: 2 }) - - expect(undoManager.history.length).toBe(0) - - store.inc() - expect(store.x).toBe(2) - expect(undoManager.history.length).toBe(1) - - store.inc() - expect(store.x).toBe(3) - expect(undoManager.history.length).toBe(2) - - store.inc() - expect(store.x).toBe(4) - expect(undoManager.history.length).toBe(2) - - store.inc() - expect(store.x).toBe(5) - expect(undoManager.history.length).toBe(2) -}) - -test("same tree - withoutUndoFlow declaratively", async () => { - // because async would allow overwriting the history within later tests - // we need a another _undoManager - let _undoManager: any = {} - const _setUndoManagerSameTree = (targetStore: any) => { - _undoManager = targetStore.history - } - - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - y: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - _setUndoManagerSameTree(self) - - return { - loadPosition2: flow(function* (n: number) { - yield Promise.resolve() - self.y = n - }), - loadPosition: _undoManager.withoutUndoFlow(function* () { - yield Promise.resolve() - self.x = 4 - yield (self as any).loadPosition2(2) - - return { x: self.x, y: self.y } - }) - } - }) - const store = HistoryOnTreeStoreModel.create() - - expect(_undoManager.canUndo).toBe(false) - expect(_undoManager.canRedo).toBe(false) - expect(store.x).toBe(1) - expect(store.y).toBe(1) - - const value = await store.loadPosition() - expect(store.x).toBe(4) - expect(store.y).toBe(2) - expect(value.x).toBe(4) - expect(value.y).toBe(2) - expect(_undoManager.canUndo).toBe(false) - expect(_undoManager.canRedo).toBe(false) -}) - -test("same tree - group", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - numbers: types.optional(types.array(types.number), []), - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x += 1 - }, - addNumber(n: number) { - self.numbers.push(n) - } - } - }) - const store = HistoryOnTreeStoreModel.create() - - expect(undoManager.undoLevels).toBe(0) - expect(undoManager.redoLevels).toBe(0) - expect(store.x).toBe(1) - - undoManager.startGroup(() => { - store.inc() - store.inc() - store.inc() - }) - expect(store.x).toBe(4) - expect(undoManager.undoLevels).toBe(0) // nothing to undo until stopGroup - expect(undoManager.redoLevels).toBe(0) // nothing to redo yet - - // an action outside start group, but before stopGroup should also be part of the group - store.inc() - expect(store.x).toBe(5) - expect(undoManager.undoLevels).toBe(0) // nothing to undo until stopGroup - expect(undoManager.redoLevels).toBe(0) // nothing to redo yet - - undoManager.stopGroup() - expect(store.x).toBe(5) - expect(undoManager.undoLevels).toBe(1) // incs can be undone now - expect(undoManager.redoLevels).toBe(0) // nothing to redo yet - expect(undoManager.history.length).toBe(1) - expect(undoManager.history[0].patches).toEqual([ - { op: "replace", path: "/x", value: 2 }, - { op: "replace", path: "/x", value: 3 }, - { op: "replace", path: "/x", value: 4 }, - { op: "replace", path: "/x", value: 5 } - ]) - undoManager.undo() - expect(undoManager.undoLevels).toBe(0) // incs undone - expect(undoManager.redoLevels).toBe(1) // incs can be redone - expect(store.x).toBe(1) - - undoManager.startGroup(() => { - store.addNumber(1) - store.addNumber(2) - }) - expect(store.numbers.length).toBe(2) - expect(undoManager.undoLevels).toBe(0) // nothing to undo until stopGroup - expect(undoManager.redoLevels).toBe(1) // incs can be redone - undoManager.stopGroup() - expect(undoManager.undoLevels).toBe(1) // addNumbers can be undone - expect(undoManager.redoLevels).toBe(0) // incs redo is now lost - undoManager.undo() - expect(undoManager.undoLevels).toBe(0) // addNumbers undone - expect(undoManager.redoLevels).toBe(1) // addNumbers can be redone - expect(store.numbers.length).toBe(0) -}) - -describe("same tree - clean", () => { - const HistoryOnTreeStoreModel = types - .model({ - x: 1, - history: types.optional(UndoManager, {}) - }) - .actions((self) => { - setUndoManagerSameTree(self) - return { - inc() { - self.x++ - } - } - }) - - let store: Instance - beforeEach(() => { - store = HistoryOnTreeStoreModel.create() - store.inc() - store.inc() - store.history.undo() - expect(undoManager.undoLevels).toBe(1) - expect(undoManager.redoLevels).toBe(1) - }) - - test("clear all", () => { - store.history.clear() - expect(undoManager.undoLevels).toBe(0) - expect(undoManager.redoLevels).toBe(0) - }) - - test("clear redo", () => { - store.history.clearRedo() - expect(undoManager.undoLevels).toBe(1) - expect(undoManager.redoLevels).toBe(0) - }) - - test("clear undo", () => { - store.history.clearUndo() - expect(undoManager.undoLevels).toBe(0) - expect(undoManager.redoLevels).toBe(1) - }) -}) - -test("#1195 - withoutUndo() used inside an action should NOT affect all patches within that action", () => { - configure({ - useProxies: "never" - }) - - let _undoManager: any - - const store = types - .model(`Person`, { - name: types.string, - age: types.number - }) - .actions((self) => { - _undoManager = UndoManager.create({}, { targetStore: self }) - - return { - setName(name: string) { - _undoManager.withoutUndo(() => { - self.name = name - }) - }, - - setAge(age: number) { - self.age = age - }, - - setInfo(name: string, age: number) { - this.setName(name) // name changes should not be undo-ed - this.setAge(age) // but age changes should - } - } - }) - - const person = store.create({ name: `Jon`, age: 20 }) - - person.setInfo(`Bob`, 50) - expect(person.name).toBe("Bob") - expect(person.age).toBe(50) - - expect(_undoManager.history.length).toBe(1) - expect(_undoManager.history[0]).toEqual({ - inversePatches: [{ op: "replace", path: "/age", value: 20 }], - patches: [{ op: "replace", path: "/age", value: 50 }] - }) - - _undoManager.undo() - // only age should be undone - expect(person.name).toBe("Bob") - expect(person.age).toBe(20) -}) - -describe("includeHooks flag", () => { - test("does not record hooks by default", () => { - const HistoryDifferentTreeStoreModel = types - .model({ - x: 1, - y: 1 - }) - .actions((self) => { - setUndoManagerDifferentTree(self) - return { - afterCreate() { - self.y = 2 - }, - inc() { - self.x += 1 - } - } - }) - - const store = HistoryDifferentTreeStoreModel.create() - store.inc() - - expect(undoManager.history).toHaveLength(1) - expect(undoManager.history[0]).toEqual({ - inversePatches: [{ op: "replace", path: "/x", value: 1 }], - patches: [{ op: "replace", path: "/x", value: 2 }] - }) - }) - - test("record hooks in the root store", () => { - const HistoryDifferentTreeStoreModel = types - .model({ - x: 1, - y: 1 - }) - .actions((self) => { - setUndoManagerDifferentTree(self, true) - return { - afterCreate() { - self.y = 2 - }, - inc() { - self.x += 1 - } - } - }) - - const store = HistoryDifferentTreeStoreModel.create() - store.inc() - - expect(undoManager.history).toHaveLength(2) - expect(undoManager.history).toEqual([ - { - inversePatches: [{ op: "replace", path: "/y", value: 1 }], - patches: [{ op: "replace", path: "/y", value: 2 }] - }, - { - inversePatches: [{ op: "replace", path: "/x", value: 1 }], - patches: [{ op: "replace", path: "/x", value: 2 }] - } - ]) - }) -}) diff --git a/packages/mst-middlewares/jest.config.js b/packages/mst-middlewares/jest.config.js deleted file mode 100644 index 745b32a4f..000000000 --- a/packages/mst-middlewares/jest.config.js +++ /dev/null @@ -1,15 +0,0 @@ -module.exports = { - displayName: "test", - testEnvironment: "node", - transform: { - "^.+\\.tsx?$": "ts-jest" - }, - testRegex: ".*\\.test\\.tsx?$", - moduleFileExtensions: ["ts", "tsx", "js"], - globals: { - "ts-jest": { - tsConfig: "__tests__/tsconfig.json" - } - }, - reporters: ["default", "jest-junit"] -} diff --git a/packages/mst-middlewares/package.json b/packages/mst-middlewares/package.json deleted file mode 100644 index 8acd74a23..000000000 --- a/packages/mst-middlewares/package.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "name": "mst-middlewares", - "version": "5.2.0", - "description": "The MST package ships with some prebuilt middlewares, which serves mainly as examples on how to write your own middleware. The source of each middleware can be found in this github directory, you are encouraged to read them!", - "main": "dist/mst-middlewares.js", - "umd:main": "dist/mst-middlewares.umd.js", - "module": "dist/mst-middlewares.module.js", - "browser": { - "./dist/mst-middlewares.js": "./dist/mst-middlewares.js", - "./dist/mst-middlewares.module.js": "./dist/mst-middlewares.module.js" - }, - "unpkg": "dist/mst-middlewares.umd.min.js", - "jsnext:main": "dist/mst-middlewares.module.js", - "react-native": "dist/mst-middlewares.module.js", - "typings": "dist/index.d.ts", - "sideEffects": false, - "scripts": { - "clean": "shx rm -rf dist && shx rm -rf lib", - "build": "yarn clean && tsc && cpr lib dist --filter=\\.js$ && rollup -c", - "jest": "jest", - "test": "yarn test:dev && yarn test:prod", - "test:dev": "cross-env NODE_ENV=development JEST_JUNIT_OUTPUT=../../test-results/mst-middlewares/dev.xml yarn jest", - "test:prod": "cross-env NODE_ENV=production JEST_JUNIT_OUTPUT=../../test-results/mst-middlewares/prod.xml yarn jest", - "lint": "tslint -c ./tslint.json 'src/**/*.ts'" - }, - "author": "", - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/mobxjs/mobx-state-tree.git", - "directory": "packages/mst-middlewares" - }, - "devDependencies": { - "@types/jest": "^26.0.3", - "@types/node": "^16.9.2", - "cpr": "^3.0.1", - "cross-env": "^7.0.3", - "jest": "^26.1.0", - "jest-junit": "^11.0.1", - "mobx": "^6.3.3", - "mobx-state-tree": "^5.2.0", - "rollup": "^2.56.3", - "rollup-plugin-commonjs": "^10.1.0", - "rollup-plugin-filesize": "^9.1.1", - "rollup-plugin-node-resolve": "^5.2.0", - "rollup-plugin-replace": "^2.2.0", - "rollup-plugin-terser": "^7.0.2", - "ts-jest": "^26.1.1", - "tslib": "^2.3.1", - "typescript": "3.9.4" - }, - "peerDependencies": { - "mobx-state-tree": "^5.0.0" - }, - "files": [ - "dist/" - ], - "gitHead": "27ec7ac0b0743a367fb01a7f40192f3042bd91f2" -} diff --git a/packages/mst-middlewares/rollup.config.js b/packages/mst-middlewares/rollup.config.js deleted file mode 100644 index b1f4392f2..000000000 --- a/packages/mst-middlewares/rollup.config.js +++ /dev/null @@ -1,26 +0,0 @@ -import { baseConfig } from "../../rollup.base-config" - -const config = (outFile, format, mode) => - baseConfig({ - outFile, - format, - mode, - - input: "./lib/index.js", - globals: { - mobx: "mobx", - "mobx-state-tree": "mobxStateTree" - }, - umdName: "mstMiddlewares", - external: ["mobx", "mobx-state-tree"] - }) - -export default [ - config("mst-middlewares.js", "cjs", "development"), - config("mst-middlewares.min.js", "cjs", "production"), - - config("mst-middlewares.umd.js", "umd", "development"), - config("mst-middlewares.umd.min.js", "umd", "production"), - - config("mst-middlewares.module.js", "es", "development") -] diff --git a/packages/mst-middlewares/src/action-logger.ts b/packages/mst-middlewares/src/action-logger.ts deleted file mode 100644 index 68512fae6..000000000 --- a/packages/mst-middlewares/src/action-logger.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { IMiddlewareEvent, getPath } from "mobx-state-tree" - -export function actionLogger(call: IMiddlewareEvent, next: (call: IMiddlewareEvent) => void) { - const skip = - (call.type === "action" && call.parentId !== 0) || - call.type === "flow_resume" || - call.type === "flow_resume_error" - - if (!skip) - console.log(`[MST] #${call.rootId} ${call.type} - ${getPath(call.context)}/${call.name}`) - next(call) -} diff --git a/packages/mst-middlewares/src/atomic.ts b/packages/mst-middlewares/src/atomic.ts deleted file mode 100644 index 4a8f7e32e..000000000 --- a/packages/mst-middlewares/src/atomic.ts +++ /dev/null @@ -1,40 +0,0 @@ -import { - createActionTrackingMiddleware2, - recordPatches, - IPatchRecorder, - isActionContextThisOrChildOf -} from "mobx-state-tree" - -const atomic = createActionTrackingMiddleware2<{ recorder: IPatchRecorder }>({ - filter(call) { - // only call the methods above for actions that were not being recorded, - // but do not call them for child acions (which inherit a copy of the env) - if (call.env) { - // already recording - return false - } - - return true - }, - onStart(call) { - const recorder = recordPatches(call.tree, (_patch, _inversePatch, actionContext) => { - // only record patches that were generated by this action or children of this action - return !!actionContext && isActionContextThisOrChildOf(actionContext, call.id) - }) - recorder.resume() - call.env = { - recorder - } - }, - onFinish(call, error) { - const recorder = call.env!.recorder - call.env = undefined - recorder.stop() - - if (error !== undefined) { - recorder.undo() - } - } -}) - -export default atomic diff --git a/packages/mst-middlewares/src/index.ts b/packages/mst-middlewares/src/index.ts deleted file mode 100644 index e3bf39a6d..000000000 --- a/packages/mst-middlewares/src/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -export { default as atomic } from "./atomic" -export * from "./redux" -export { default as simpleActionLogger } from "./simple-action-logger" -export { actionLogger } from "./action-logger" -export { default as TimeTraveller } from "./time-traveller" -export { default as UndoManager } from "./undo-manager" diff --git a/packages/mst-middlewares/src/redux.ts b/packages/mst-middlewares/src/redux.ts deleted file mode 100644 index ee1990d3d..000000000 --- a/packages/mst-middlewares/src/redux.ts +++ /dev/null @@ -1,385 +0,0 @@ -import { - IAnyStateTreeNode, - isStateTreeNode, - getSnapshot, - applyAction, - onSnapshot, - getType, - hasParent, - getParent, - onPatch, - addMiddleware, - IMiddlewareEvent, - getPath, - applySnapshot -} from "mobx-state-tree" - -/** - * Creates a tiny proxy around a MST tree that conforms to the redux store api. - * This makes it possible to use MST inside a redux application. - * - * See the [redux-todomvc example](https://github.com/mobxjs/mobx-state-tree/blob/e9e804c8c43e1edde4aabbd52675544e2b3a905b/examples/redux-todomvc/src/index.js#L20) for more details. - * - * @export - * @param {*} model - * @param {...MiddleWare[]} middlewares - * @returns {IReduxStore} - */ -export const asReduxStore = function (model: IAnyStateTreeNode, ...middlewares: any[]) { - if (!isStateTreeNode(model)) throw new Error("Expected model object") - let store = { - getState: () => getSnapshot(model), - dispatch: (action: any) => { - runMiddleWare(action, runners.slice(), (newAction: any) => - applyAction(model, reduxActionToAction(newAction)) - ) - }, - subscribe: (listener: any) => onSnapshot(model, listener) - } - let runners = middlewares.map((mw) => mw(store)) - return store -} - -function reduxActionToAction(action: any) { - const actionArgs = Object.assign({}, action) - delete actionArgs.type - return { - name: action.type, - args: [actionArgs] - } -} - -function runMiddleWare(action: any, runners: any[], next: any) { - function n(retVal: any) { - const f = runners.shift() - if (f) f(n)(retVal) - else next(retVal) - } - n(action) -} - -// devtools - -type ChangesMadeSetter = () => void - -interface ActionContext { - parent?: ActionContext - name: string - targetTypePath: string - id: number - runningAsync: boolean - errored: boolean - errorReported: boolean - step: number | undefined - callArgs: any[] - changesMadeSetter: ChangesMadeSetter | undefined -} - -function getActionContextNameAndTypePath(actionContext: ActionContext, logArgsNearName: boolean) { - let name = actionContext.name - let targetTypePath = actionContext.targetTypePath - - if (logArgsNearName) { - let args = actionContext.callArgs.map((a) => JSON.stringify(a)).join(", ") - - if (args.length > 64) { - args = args.slice(0, 64) + "..." - } - - name += `(${args})` - } - - if (actionContext.runningAsync) { - name += ` (${actionContext.step !== undefined ? actionContext.step : "?"})` - } - - if (actionContext.errored) { - name += ` -error thrown-` - } - - if (actionContext.parent) { - const ret = getActionContextNameAndTypePath(actionContext.parent, logArgsNearName) - if (ret) { - name = `${ret.name} >>> ${name}` - targetTypePath = `${ret.targetTypePath} >>> ${targetTypePath}` - } - } - - return { - name, - targetTypePath - } -} - -function getTypeName(node: IAnyStateTreeNode) { - return getType(node).name || "(UnnamedType)" -} - -function getTargetTypePath(node: IAnyStateTreeNode): string[] { - let current: IAnyStateTreeNode | undefined = node - const names = [] - while (current) { - names.unshift(getTypeName(current)) - current = hasParent(current) ? getParent(current) : undefined - } - return names -} - -/** - * Connects a MST tree to the Redux devtools. - * See this [example](https://github.com/mobxjs/mobx-state-tree/blob/e9e804c8c43e1edde4aabbd52675544e2b3a905b/examples/redux-todomvc/src/index.js#L21) - * for a setup example. - * - * @export - * @param {*} remoteDevDep - * @param {IAnyStateTreeNode} model - * @param {{ - * logIdempotentActionSteps?: boolean - * logChildActions?: boolean - * logArgsNearName?: boolean - * }} [options] - */ -export function connectReduxDevtools( - remoteDevDep: any, - model: IAnyStateTreeNode, - options?: { - logIdempotentActionSteps?: boolean - logChildActions?: boolean - logArgsNearName?: boolean - } -) { - const opts = { - logIdempotentActionSteps: true, - logChildActions: false, - logArgsNearName: true, - ...options - } - - let handlingMonitorAction = 0 - - // Connect to the monitor - const remotedev = remoteDevDep.connectViaExtension({ - name: getType(model).name - }) - - // Subscribe to change state (if need more than just logging) - remotedev.subscribe((message: any) => { - if (message.type === "DISPATCH") { - handleMonitorActions(remotedev, model, message) - } - }) - - const initialState = getSnapshot(model) - remotedev.init(initialState) - - const actionContexts = new Map() - - let changesMadeSetter: ChangesMadeSetter | undefined = undefined - if (!opts.logIdempotentActionSteps) { - onPatch(model, () => { - if (!handlingMonitorAction && changesMadeSetter) { - changesMadeSetter() - } - }) - } - - addMiddleware(model, actionMiddleware, false) - function actionMiddleware(call: IMiddlewareEvent, next: any) { - if (handlingMonitorAction) { - next(call) - return - } - - let context!: ActionContext - - // find the context of the parent action (if any) - for (let i = call.allParentIds.length - 1; i >= 0; i--) { - const parentId = call.allParentIds[i] - const foundContext = actionContexts.get(parentId) - if (foundContext) { - context = foundContext - break - } - } - - // if it is an action we need to create a new action context - // and also if there's no context (e.g. the middleware was connected in the middle of an action with a flow) - if (call.type === "action" || !context) { - const targetTypePath = getTargetTypePath(call.context).join("/") - - const parentContext = context - const path = call.context ? `root${getPath(call.context)}` : "*unknown*" - context = { - // use a space rather than a dot so that the redux devtools move the actions to the next line if there's not enough space - name: `[${path}] ${call.name || "*unknownAction*"}`, - targetTypePath: targetTypePath, - id: call.id, - runningAsync: false, - errored: false, - errorReported: false, - step: call.type === "action" ? 0 : undefined, - callArgs: [], - changesMadeSetter: undefined - } - - if (call.type === "action") { - if (call.args) { - context.callArgs = [...call.args] - } - - // subaction, assign the parent action context - if (call.parentId) { - context.parent = parentContext - } - - actionContexts.set(call.id, context) - } - } - - let changesMade = false - context.changesMadeSetter = () => { - changesMade = true - } - let oldChangesMadeSetter = changesMadeSetter - changesMadeSetter = context.changesMadeSetter - - // capture any errors and rethrow them later (after it is logged) - let errorThrown - try { - next(call) - } catch (e) { - errorThrown = e - context.errored = true - } - - changesMadeSetter = oldChangesMadeSetter - context.changesMadeSetter = undefined - - const changedTheModel = opts.logIdempotentActionSteps ? true : changesMade - - switch (call.type) { - case "flow_spawn": - case "flow_resume": - case "flow_resume_error": // not errored since the promise error might be caught - // when this events come we can be sure that this action is being run async, as well as its parent actions - context.runningAsync = true - let parent = context.parent - while (parent) { - parent.runningAsync = true - parent = parent.parent - } - break - case "flow_throw": - context.errored = true - break - } - - // only log if: - // - it is a sync (never run async code) action - // - a flow_resume - // - a flow_throw that wasn't reported as an error before - // we don't include other kinds since flow_spawn never contain state changes and flow_resume_error might be caught by and handled the parent - const syncAction = call.type === "action" && !context.runningAsync - let log = - syncAction || - call.type === "flow_resume" || - (call.type === "flow_throw" && !context.errorReported) - - // do not log child actions if asked not to, but only for sync actions - if (!opts.logChildActions && context.parent && !context.runningAsync) { - log = false - // give the child action changes to the parent action - if (changesMade && context.parent.changesMadeSetter) { - context.parent.changesMadeSetter() - } - } - - if (log) { - const logStep = (logContext: ActionContext) => { - const sn = getSnapshot(model) - - const names = getActionContextNameAndTypePath(logContext, opts.logArgsNearName!) - - const copy = { - type: names.name, - targetTypePath: names.targetTypePath, - args: logContext.callArgs - } - remotedev.send(copy, sn) - - // we do it over the original context, not the log context, since the original context might throw but the original context might not - if (context.errored) { - context.errorReported = true - } - - // increase the step for logging purposes, as well as any parent steps (since child steps count as a parent step) - if (context.step !== undefined) { - context.step++ - } - - let parent = context.parent - while (parent) { - if (parent.step !== undefined) { - parent.step++ - } - parent = parent.parent - } - } - - // if it is an async subaction we need to log it since it made a change, but we will log it as if it were the root - const logAsRoot = context.parent && !opts.logChildActions - - if (changedTheModel) { - let logContext = context - if (logAsRoot) { - while (logContext.parent) { - logContext = logContext.parent - } - } - - logStep(logContext) - } else if (!logAsRoot && context.errored && !context.errorReported) { - logStep(context) - } - } - - // once the action is totally finished remove it from the context list to avoid mem leaks - if (call.type === "flow_return" || call.type === "flow_throw" || !context!.runningAsync) { - actionContexts.delete(context!.id!) - } - - // rethrow previously captured excepton if needed - if (errorThrown) { - throw errorThrown - } - } - - function handleMonitorActions(remotedev2: any, model2: any, message: any) { - try { - handlingMonitorAction++ - - switch (message.payload.type) { - case "RESET": - applySnapshot(model2, initialState) - return remotedev2.init(initialState) - case "COMMIT": - return remotedev2.init(getSnapshot(model2)) - case "ROLLBACK": - return remotedev2.init(remoteDevDep.extractState(message)) - case "JUMP_TO_STATE": - case "JUMP_TO_ACTION": - applySnapshot(model2, remoteDevDep.extractState(message)) - return - case "IMPORT_STATE": - const nextLiftedState = message.payload.nextLiftedState - const computedStates = nextLiftedState.computedStates - applySnapshot(model2, computedStates[computedStates.length - 1].state) - remotedev2.send(null, nextLiftedState) - return - default: - } - } finally { - handlingMonitorAction-- - } - } -} diff --git a/packages/mst-middlewares/src/simple-action-logger.ts b/packages/mst-middlewares/src/simple-action-logger.ts deleted file mode 100644 index be4c38dc9..000000000 --- a/packages/mst-middlewares/src/simple-action-logger.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { IMiddlewareEvent, getPath } from "mobx-state-tree" - -export default function simpleActionLogger( - call: IMiddlewareEvent, - next: (call: IMiddlewareEvent) => void -) { - if (call.type === "action" && call.parentId === 0) - console.log("[MST] " + getPath(call.context) + "/" + call.name) - return next(call) -} diff --git a/packages/mst-middlewares/src/time-traveller.ts b/packages/mst-middlewares/src/time-traveller.ts deleted file mode 100644 index c02a1ac2b..000000000 --- a/packages/mst-middlewares/src/time-traveller.ts +++ /dev/null @@ -1,77 +0,0 @@ -import { - types, - resolvePath, - getEnv, - onSnapshot, - getSnapshot, - applySnapshot, - IDisposer -} from "mobx-state-tree" -import { IObservableArray } from "mobx" - -const TimeTraveller = types - .model("TimeTraveller", { - history: types.array(types.frozen()), - undoIdx: -1, - targetPath: "" - }) - .views((self) => ({ - get canUndo() { - return self.undoIdx > 0 - }, - get canRedo() { - return self.undoIdx < self.history.length - 1 - } - })) - .actions((self) => { - let targetStore: any - let snapshotDisposer: IDisposer - let skipNextUndoState = false - - return { - addUndoState(todos: any) { - if (skipNextUndoState) { - // skip recording if this state was caused by undo / redo - skipNextUndoState = false - return - } - self.history.splice(self.undoIdx + 1) - self.history.push(todos) - self.undoIdx = self.history.length - 1 - }, - afterCreate() { - targetStore = self.targetPath - ? resolvePath(self, self.targetPath) - : getEnv(self).targetStore - if (!targetStore) - throw new Error( - "Failed to find target store for TimeTraveller. Please provide `targetPath` property, or a `targetStore` in the environment" - ) - // TODO: check if targetStore doesn't contain self - // if (contains(targetStore, self)) throw new Error("TimeTraveller shouldn't be recording itself. Please specify a sibling as taret, not some parent") - // start listening to changes - snapshotDisposer = onSnapshot(targetStore, (snapshot) => - this.addUndoState(snapshot) - ) - // record an initial state if no known - if (self.history.length === 0) { - this.addUndoState(getSnapshot(targetStore)) - } - }, - beforeDestroy() { - snapshotDisposer() - }, - undo() { - self.undoIdx-- - skipNextUndoState = true - applySnapshot(targetStore, self.history[self.undoIdx]) - }, - redo() { - self.undoIdx++ - skipNextUndoState = true - applySnapshot(targetStore, self.history[self.undoIdx]) - } - } - }) - -export default TimeTraveller diff --git a/packages/mst-middlewares/src/undo-manager.ts b/packages/mst-middlewares/src/undo-manager.ts deleted file mode 100644 index 9a681c20b..000000000 --- a/packages/mst-middlewares/src/undo-manager.ts +++ /dev/null @@ -1,224 +0,0 @@ -import { - types, - IJsonPatch, - IAnyStateTreeNode, - recordPatches, - IPatchRecorder, - createActionTrackingMiddleware2, - getEnv, - getRoot, - applyPatch, - flow, - addMiddleware, - addDisposer, - decorate, - isActionContextThisOrChildOf -} from "mobx-state-tree" -import { atomic } from "." - -const Entry = types.model("UndoManagerEntry", { - patches: types.frozen>(), - inversePatches: types.frozen>() -}) - -const UndoManager = types - .model("UndoManager", { - history: types.array(Entry), - undoIdx: 0 - }) - .views((self) => ({ - get undoLevels() { - return self.undoIdx - }, - get redoLevels() { - return self.history.length - self.undoIdx - }, - get canUndo() { - return this.undoLevels > 0 - }, - get canRedo() { - return this.redoLevels > 0 - } - })) - .actions((self) => { - let includeHooks = false - let targetStore: IAnyStateTreeNode - let recordingDisabled = 0 - - interface Context { - recorder: IPatchRecorder - } - - type GroupRecorder = Pick - const groupRecorders: GroupRecorder[] = [] - - const undoRedoMiddleware = createActionTrackingMiddleware2({ - filter(call) { - if (call.env) { - // already recording - return false - } - if (call.context === self) { - // also skip actions over self - return false - } - - return true - }, - onStart(call) { - const recorder = recordPatches( - call.tree, - (_patch, _inversePatch, actionContext) => { - if (recordingDisabled) { - return false - } - // only record patches that were generated by this action or children of this action - return ( - !!actionContext && isActionContextThisOrChildOf(actionContext, call.id) - ) - } - ) - recorder.resume() - call.env = { - recorder - } - }, - onFinish(call, error) { - const recorder = call.env!.recorder - call.env = undefined - recorder.stop() - - if (error === undefined) { - if (groupRecorders.length > 0) { - const groupRecorder = groupRecorders[groupRecorders.length - 1] - groupRecorder.patches = groupRecorder.patches.concat(recorder.patches) - groupRecorder.inversePatches = groupRecorder.inversePatches.concat( - recorder.inversePatches - ) - } else { - ;(self as any).addUndoState(recorder) - } - } else { - recorder.undo() - } - } - }) - - const skipRecording = (fn: () => T): T => { - recordingDisabled++ - try { - return fn() - } finally { - recordingDisabled-- - } - } - - return { - addUndoState(recorder: GroupRecorder) { - this.withoutUndo(() => { - if (recorder.patches.length === 0) { - // skip recording if patches is empty - return - } - self.history.splice(self.undoIdx) - self.history.push({ - patches: recorder.patches, - inversePatches: recorder.inversePatches - }) - const maxLength = getEnv(self).maxHistoryLength || Infinity - self.history.splice(0, self.history.length - maxLength) - self.undoIdx = self.history.length - }) - }, - afterCreate() { - const selfRoot = getRoot(self) - targetStore = getEnv(self).targetStore || selfRoot - if (targetStore === self) { - throw new Error( - "UndoManager should be created as part of a tree, or with `targetStore` in it's environment" - ) - } - - if (typeof getEnv(self).includeHooks === "boolean") { - includeHooks = getEnv(self).includeHooks - } - - addDisposer(self, addMiddleware(targetStore, undoRedoMiddleware, includeHooks)) - }, - undo: decorate(atomic, () => { - skipRecording(() => { - if (!self.canUndo) { - throw new Error("undo not possible, nothing to undo") - } - applyPatch( - getRoot(targetStore), - // n.b: reverse patches back to forth - self.history[self.undoIdx - 1].inversePatches.slice().reverse() - ) - self.undoIdx-- - }) - }), - redo: decorate(atomic, () => { - skipRecording(() => { - if (!self.canRedo) { - throw new Error("redo not possible, nothing to redo") - } - applyPatch(getRoot(targetStore), self.history[self.undoIdx].patches) - self.undoIdx++ - }) - }), - withoutUndo(fn: () => T): T { - return skipRecording(fn) - }, - withoutUndoFlow(generatorFn: () => any) { - return flow(function* __withoutUndoFlow__() { - recordingDisabled++ - try { - return yield* generatorFn() - } finally { - recordingDisabled-- - } - }) - }, - startGroup(fn: () => T): T { - if (groupRecorders.length >= 1) { - throw new Error( - "a previous startGroup is still running, did you forget to call stopGroup?" - ) - } - groupRecorders.push({ - patches: [], - inversePatches: [] - }) - return fn() - }, - stopGroup() { - const groupRecorder = groupRecorders.pop() - if (!groupRecorder) { - throw new Error( - "each call to stopGroup requires a previous call to startGroup, did you forget to call startGroup?" - ) - } - this.addUndoState(groupRecorder) - }, - clear: decorate(atomic, () => { - skipRecording(() => { - self.history.clear() - self.undoIdx = 0 - }) - }), - clearUndo: decorate(atomic, () => { - skipRecording(() => { - self.history.splice(0, self.undoLevels) - self.undoIdx = 0 - }) - }), - clearRedo: decorate(atomic, () => { - skipRecording(() => { - self.history.splice(self.undoIdx, self.redoLevels) - }) - }) - } - }) - -export default UndoManager diff --git a/packages/mst-middlewares/tsconfig.json b/packages/mst-middlewares/tsconfig.json deleted file mode 100644 index 24978c52b..000000000 --- a/packages/mst-middlewares/tsconfig.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "extends": "../../tsconfig.base.json", - "compilerOptions": { - "outDir": "lib/" - }, - "files": ["src/index.ts"] -} diff --git a/packages/mst-middlewares/tslint.json b/packages/mst-middlewares/tslint.json deleted file mode 100644 index 40a18cdec..000000000 --- a/packages/mst-middlewares/tslint.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "../../tslint.json" -} From 6c5f23450f3baddf6485f5adb34f78f82e343171 Mon Sep 17 00:00:00 2001 From: Tyler Williams Date: Thu, 21 Sep 2023 15:30:49 -0600 Subject: [PATCH 2/4] chore: remove mst-middlewares configurations --- .circleci/config.yml | 40 +--------- .size-limit.json | 6 -- package.json | 7 +- yarn.lock | 180 ++++++++----------------------------------- 4 files changed, 36 insertions(+), 197 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 839dca62e..bf591a3ed 100755 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -11,7 +11,7 @@ orbs: node: circleci/node@4.7.0 jobs: - # mobx-state-tree and mst-middlewares build + # mobx-state-tree build build: executor: my-executor steps: @@ -63,32 +63,6 @@ jobs: - store_test_results: path: ./test-results - # mst-middlewares tests - test-mst-middlewares-dev: - executor: my-executor - steps: - - attach_workspace: - at: . - - - run: yarn test:mst-middlewares:dev -i --coverage - - store_test_results: - path: ./test-results - - - persist_to_workspace: - root: . - paths: - - packages/mst-middlewares/coverage/* - - test-mst-middlewares-prod: - executor: my-executor - steps: - - attach_workspace: - at: . - - - run: yarn test:mst-middlewares:prod -i - - store_test_results: - path: ./test-results - test-size: executor: my-executor steps: @@ -130,18 +104,10 @@ workflows: requires: - build - - test-mst-middlewares-dev: - requires: - - build - - test-mst-middlewares-prod: - requires: - - build - - test-size: requires: - build - upload-codecov: - requires: - - test-mst-dev - - test-mst-middlewares-dev + requires: + - test-mst-dev diff --git a/.size-limit.json b/.size-limit.json index 8c15c0cc8..a946b2f84 100644 --- a/.size-limit.json +++ b/.size-limit.json @@ -4,11 +4,5 @@ "limit": "25 KB", "webpack": false, "running": false - }, - { - "path": "packages/mst-middlewares/dist/mst-middlewares.min.js", - "limit": "5 KB", - "webpack": false, - "running": false } ] diff --git a/package.json b/package.json index 0b0a04a04..004e9c52e 100644 --- a/package.json +++ b/package.json @@ -8,9 +8,7 @@ "test:mst:dev": "cd packages/mobx-state-tree && yarn test:dev", "test:mst:prod": "cd packages/mobx-state-tree && yarn test:prod", "test:mst:others": "cd packages/mobx-state-tree && yarn test:others", - "test:mst-middlewares:dev": "cd packages/mst-middlewares && yarn test:dev", - "test:mst-middlewares:prod": "cd packages/mst-middlewares && yarn test:prod", - "test:all": "yarn test && yarn test:mst:dev && yarn test:mst:prod && yarn test:mst:others && yarn test:mst-middlewares:dev && yarn test:mst-middlewares:prod && yarn size && yarn coverage", + "test:all": "yarn test && yarn test:mst:dev && yarn test:mst:prod && yarn test:mst:others && yarn size && yarn coverage", "size": "size-limit", "coverage": "lerna run coverage --stream", "release": "yarn build && lerna publish", @@ -22,8 +20,7 @@ "prepare": "husky install" }, "workspaces": [ - "packages/mobx-state-tree", - "packages/mst-middlewares" + "packages/mobx-state-tree" ], "lint-staged": { "*.{ts,tsx,js,jsx}": [ diff --git a/yarn.lock b/yarn.lock index 409f87787..6f9a81f67 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2335,12 +2335,7 @@ resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.9.tgz#97edc9037ea0c38585320b28964dde3b39e4660d" integrity sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ== -"@types/minimatch@*": - version "3.0.5" - resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.5.tgz#1001cc5e6a3704b83c236027e77f2f58ea010f40" - integrity sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ== - -"@types/minimatch@3.0.3", "@types/minimatch@^3.0.3": +"@types/minimatch@*", "@types/minimatch@3.0.3", "@types/minimatch@^3.0.3": version "3.0.3" resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d" integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA== @@ -3088,16 +3083,11 @@ bl@^4.0.3, bl@^4.1.0: inherits "^2.0.4" readable-stream "^3.4.0" -bluebird@^3.5.1, bluebird@^3.5.3: +bluebird@^3.5.1, bluebird@^3.5.3, bluebird@^3.5.5: version "3.7.2" resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.7.2.tgz#9f229c15be272454ffa973ace0dbee79a1b0c36f" integrity sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg== -bluebird@^3.5.5: - version "3.7.1" - resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.7.1.tgz#df70e302b471d7473489acf26a93d63b53f874de" - integrity sha512-DdmyoGCleJnkbp3nkbxTLJ18rjDsE4yCggEwKNXkeV123sPNfOCYeDoeuOY+F2FrSjO1YXcTU+dsy96KMy+gcg== - bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.1.1, bn.js@^4.4.0: version "4.11.9" resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-4.11.9.tgz#26d556829458f9d1e81fc48952493d0ba3507828" @@ -3331,7 +3321,7 @@ bytes-iec@^3.1.1: resolved "https://registry.yarnpkg.com/bytes-iec/-/bytes-iec-3.1.1.tgz#94cd36bf95c2c22a82002c247df8772d1d591083" integrity sha512-fey6+4jDK7TFtFg/klGSvNKJctyU7n2aQdnM+CO0ruLPbqqMOM8Tio0Pc+deqUeVKX1tL5DQep1zQ7+37aTAsA== -cacache@^12.0.0, cacache@^12.0.3: +cacache@^12.0.0, cacache@^12.0.2, cacache@^12.0.3: version "12.0.4" resolved "https://registry.yarnpkg.com/cacache/-/cacache-12.0.4.tgz#668bcbd105aeb5f1d92fe25570ec9525c8faa40c" integrity sha512-a0tMB40oefvuInr4Cwb3GerbL9xTj1D5yg0T5xrjGCGyfvbxseIXX7BAO/u/hIXdafzOI5JC3wDwHyf24buOAQ== @@ -3352,27 +3342,6 @@ cacache@^12.0.0, cacache@^12.0.3: unique-filename "^1.1.1" y18n "^4.0.0" -cacache@^12.0.2: - version "12.0.3" - resolved "https://registry.yarnpkg.com/cacache/-/cacache-12.0.3.tgz#be99abba4e1bf5df461cd5a2c1071fc432573390" - integrity sha512-kqdmfXEGFepesTuROHMs3MpFLWrPkSSpRqOw80RCflZXy/khxaArvFrQ7uJxSUduzAufc6G0g1VUCOZXxWavPw== - dependencies: - bluebird "^3.5.5" - chownr "^1.1.1" - figgy-pudding "^3.5.1" - glob "^7.1.4" - graceful-fs "^4.1.15" - infer-owner "^1.0.3" - lru-cache "^5.1.1" - mississippi "^3.0.0" - mkdirp "^0.5.1" - move-concurrently "^1.0.1" - promise-inflight "^1.0.1" - rimraf "^2.6.3" - ssri "^6.0.1" - unique-filename "^1.1.1" - y18n "^4.0.0" - cacache@^15.0.0, cacache@^15.0.5, cacache@^15.2.0: version "15.3.0" resolved "https://registry.yarnpkg.com/cacache/-/cacache-15.3.0.tgz#dc85380fb2f556fe3dda4c719bfa0ec875a7f1eb" @@ -4380,20 +4349,13 @@ debug@^2.2.0, debug@^2.3.3: dependencies: ms "2.0.0" -debug@^3.1.0: +debug@^3.1.0, debug@^3.2.6: version "3.2.7" resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.7.tgz#72580b7e9145fb39b6676f9c5e5fb100b934179a" integrity sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ== dependencies: ms "^2.1.1" -debug@^3.2.6: - version "3.2.6" - resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.6.tgz#e83d17de16d8a7efb7717edbe5fb10135eee629b" - integrity sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ== - dependencies: - ms "^2.1.1" - debuglog@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492" @@ -5121,16 +5083,11 @@ fd-slicer@~1.1.0: dependencies: pend "~1.2.0" -figgy-pudding@^3.4.1: +figgy-pudding@^3.4.1, figgy-pudding@^3.5.1: version "3.5.2" resolved "https://registry.yarnpkg.com/figgy-pudding/-/figgy-pudding-3.5.2.tgz#b4eee8148abb01dcf1d1ac34367d59e12fa61d6e" integrity sha512-0btnI/H8f2pavGMN8w40mlSKOfTK2SVJmBfBeVIj3kNw0swwgzyRq0d5TJVOwodFmtvpPeWPN/MCcfuWF0Ezbw== -figgy-pudding@^3.5.1: - version "3.5.1" - resolved "https://registry.yarnpkg.com/figgy-pudding/-/figgy-pudding-3.5.1.tgz#862470112901c727a0e495a80744bd5baa1d6790" - integrity sha512-vNKxJHTEKNThjfrdJwHc7brvM6eVevuO5nTj6ez8ZQ1qbXTvGthucRF7S4vf2cr71QVnT70V34v0S1DyQsti0w== - figures@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/figures/-/figures-2.0.0.tgz#3ab1a2d2a62c8bfb431a0c94cb797a2fce27c962" @@ -5699,12 +5656,7 @@ hmac-drbg@^1.0.0: minimalistic-assert "^1.0.0" minimalistic-crypto-utils "^1.0.1" -hosted-git-info@^2.1.4: - version "2.8.8" - resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.8.tgz#7539bd4bc1e0e0a895815a2e0262420b12858488" - integrity sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg== - -hosted-git-info@^2.7.1: +hosted-git-info@^2.1.4, hosted-git-info@^2.7.1: version "2.8.9" resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.9.tgz#dffc0bf9a21c02209090f2aa69429e1414daf3f9" integrity sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw== @@ -5836,20 +5788,13 @@ iferr@^0.1.5: resolved "https://registry.yarnpkg.com/iferr/-/iferr-0.1.5.tgz#c60eed69e6d8fdb6b3104a1fcbca1c192dc5b501" integrity sha1-xg7taebY/bazEEofy8ocGS3FtQE= -ignore-walk@3.0.4: +ignore-walk@3.0.4, ignore-walk@^3.0.1, ignore-walk@^3.0.3: version "3.0.4" resolved "https://registry.yarnpkg.com/ignore-walk/-/ignore-walk-3.0.4.tgz#c9a09f69b7c7b479a5d74ac1a3c0d4236d2a6335" integrity sha512-PY6Ii8o1jMRA1z4F2hRkH/xN59ox43DavKvD3oDpfurRlOJyAHpifIwpbdv1n4jt4ov0jSpw3kQ4GhJnpBL6WQ== dependencies: minimatch "^3.0.4" -ignore-walk@^3.0.1, ignore-walk@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/ignore-walk/-/ignore-walk-3.0.3.tgz#017e2447184bfeade7c238e4aefdd1e8f95b1e37" - integrity sha512-m7o6xuOaT1aqheYHKf8W6J5pYH85ZI9w077erOzLje3JsB1gkafkAhHHY19dqjulgIZHFm32Cp5uNZgcQqdJKw== - dependencies: - minimatch "^3.0.4" - ignore@^4.0.3: version "4.0.6" resolved "https://registry.yarnpkg.com/ignore/-/ignore-4.0.6.tgz#750e3db5862087b4737ebac8207ffd1ef27b25fc" @@ -6809,7 +6754,7 @@ jquery@^3.4.1: resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== -js-yaml@3.14.1: +js-yaml@3.14.1, js-yaml@^3.13.1: version "3.14.1" resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== @@ -6817,14 +6762,6 @@ js-yaml@3.14.1: argparse "^1.0.7" esprima "^4.0.0" -js-yaml@^3.13.1: - version "3.14.0" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.0.tgz#a7a34170f26a21bb162424d8adacb4113a69e482" - integrity sha512-/4IbIeHcD9VMHFqDR/gQ7EdZdLimOvW2DdcxFjdyyZ9NsbS+ccrXqVWDtab/lRl5AlUqmpBx8EhPaWR+OtY17A== - dependencies: - argparse "^1.0.7" - esprima "^4.0.0" - jsbn@~0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513" @@ -7765,18 +7702,18 @@ mkdirp-promise@^5.0.1: dependencies: mkdirp "*" -mkdirp@*, mkdirp@1.x, mkdirp@^1.0.3, mkdirp@^1.0.4: - version "1.0.4" - resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e" - integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== - -mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@^0.5.3, mkdirp@^0.5.5, mkdirp@~0.5.1: +mkdirp@*, mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@^0.5.3, mkdirp@^0.5.5, mkdirp@~0.5.1: version "0.5.5" resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.5.tgz#d91cefd62d1436ca0f41620e251288d420099def" integrity sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ== dependencies: minimist "^1.2.5" +mkdirp@1.x, mkdirp@^1.0.3, mkdirp@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + mobx@^6.3.0, mobx@^6.3.3: version "6.3.3" resolved "https://registry.yarnpkg.com/mobx/-/mobx-6.3.3.tgz#a3006c56243b1c7ea4ee671a66f963b9f43cf1af" @@ -7914,16 +7851,11 @@ node-fetch-npm@^2.0.2: json-parse-better-errors "^1.0.0" safe-buffer "^5.1.1" -node-fetch@2.6.1, node-fetch@^2.6.1: +node-fetch@2.6.1, node-fetch@^2.5.0, node-fetch@^2.6.1: version "2.6.1" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052" integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw== -node-fetch@^2.5.0: - version "2.6.2" - resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.2.tgz#986996818b73785e47b1965cc34eb093a1d464d0" - integrity sha512-aLoxToI6RfZ+0NOjmWAgn9+LEd30YCkJKFSyWacNZdEKTit/ZMcKjGkTRo8uWEsnIb/hfKecNPEbln02PdWbcA== - node-gyp@^5.0.2: version "5.0.5" resolved "https://registry.yarnpkg.com/node-gyp/-/node-gyp-5.0.5.tgz#f6cf1da246eb8c42b097d7cd4d6c3ce23a4163af" @@ -8145,15 +8077,7 @@ npm-package-arg@^8.0.0, npm-package-arg@^8.0.1, npm-package-arg@^8.1.0, npm-pack semver "^7.3.4" validate-npm-package-name "^3.0.0" -npm-packlist@^1.1.6: - version "1.4.6" - resolved "https://registry.yarnpkg.com/npm-packlist/-/npm-packlist-1.4.6.tgz#53ba3ed11f8523079f1457376dd379ee4ea42ff4" - integrity sha512-u65uQdb+qwtGvEJh/DgQgW1Xg7sqeNbmxYyrvlNznaVTjV3E5P6F/EFjM+BVHXl7JJlsdG8A64M0XI8FI/IOlg== - dependencies: - ignore-walk "^3.0.1" - npm-bundled "^1.0.1" - -npm-packlist@^1.4.4: +npm-packlist@^1.1.6, npm-packlist@^1.4.4: version "1.4.8" resolved "https://registry.yarnpkg.com/npm-packlist/-/npm-packlist-1.4.8.tgz#56ee6cc135b9f98ad3d51c1c95da22bbb9b2ef3e" integrity sha512-5+AZgwru5IevF5ZdnFglB5wNlHG1AOOuw28WhUq8/8emhBmLv6jX5by4WJCh7lW0uSYZYS6DXqIsyZVIXRZU9A== @@ -9237,16 +9161,11 @@ pumpify@^1.3.3: inherits "^2.0.3" pump "^2.0.0" -punycode@1.3.2, punycode@^1.2.4: +punycode@1.3.2, punycode@^1.2.4, punycode@^1.3.2: version "1.3.2" resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.3.2.tgz#9653a036fb7c1ee42342f2325cceefea3926c48d" integrity sha1-llOgNvt8HuQjQvIyXM7v6jkmxI0= -punycode@^1.3.2: - version "1.4.1" - resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.4.1.tgz#c0d5a63b2718800ad8e1eb0fa5269c84dd41845e" - integrity sha1-wNWmOycYgArY4esPpSachN1BhF4= - punycode@^2.1.0, punycode@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" @@ -9358,7 +9277,7 @@ read-package-json-fast@^2.0.1: json-parse-even-better-errors "^2.3.0" npm-normalize-package-bin "^1.0.1" -"read-package-json@1 || 2", read-package-json@^2.0.13: +"read-package-json@1 || 2", read-package-json@^2.0.0, read-package-json@^2.0.13: version "2.1.2" resolved "https://registry.yarnpkg.com/read-package-json/-/read-package-json-2.1.2.tgz#6992b2b66c7177259feb8eaac73c3acd28b9222a" integrity sha512-D1KmuLQr6ZSJS0tW8hf3WGpRlwszJOXZ3E8Yd/DNRaM5d+1wVRZdHlpGBLAuovjr28LbWvjpWkBHMxpRGGjzNA== @@ -9368,18 +9287,6 @@ read-package-json-fast@^2.0.1: normalize-package-data "^2.0.0" npm-normalize-package-bin "^1.0.0" -read-package-json@^2.0.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/read-package-json/-/read-package-json-2.1.0.tgz#e3d42e6c35ea5ae820d9a03ab0c7291217fc51d5" - integrity sha512-KLhu8M1ZZNkMcrq1+0UJbR8Dii8KZUqB0Sha4mOx/bknfKI/fyrQVrG/YIt2UOtG667sD8+ee4EXMM91W9dC+A== - dependencies: - glob "^7.1.1" - json-parse-better-errors "^1.0.1" - normalize-package-data "^2.0.0" - slash "^1.0.0" - optionalDependencies: - graceful-fs "^4.1.2" - read-package-json@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/read-package-json/-/read-package-json-3.0.1.tgz#c7108f0b9390257b08c21e3004d2404c806744b9" @@ -9469,7 +9376,7 @@ read@1, read@~1.0.1: dependencies: mute-stream "~0.0.4" -"readable-stream@1 || 2", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.6, readable-stream@^2.1.5, readable-stream@^2.2.2, readable-stream@^2.3.3, readable-stream@^2.3.6, readable-stream@~2.3.6: +"readable-stream@1 || 2", "readable-stream@2 || 3", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.6, readable-stream@^2.1.5, readable-stream@^2.2.2, readable-stream@^2.3.3, readable-stream@^2.3.6, readable-stream@~2.3.6: version "2.3.7" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.7.tgz#1eca1cf711aef814c04f62252a36a62f6cb23b57" integrity sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw== @@ -9482,7 +9389,7 @@ read@1, read@~1.0.1: string_decoder "~1.1.1" util-deprecate "~1.0.1" -"readable-stream@2 || 3", readable-stream@3, readable-stream@^3.0.0, readable-stream@^3.0.2, readable-stream@^3.1.1, readable-stream@^3.4.0: +readable-stream@3, readable-stream@^3.0.0, readable-stream@^3.0.2, readable-stream@^3.1.1, readable-stream@^3.4.0: version "3.6.0" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198" integrity sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA== @@ -9841,16 +9748,16 @@ rxjs@^6.4.0, rxjs@^6.6.0, rxjs@^6.6.7: dependencies: tslib "^1.9.0" -safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1: - version "5.1.2" - resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" - integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== - -safe-buffer@^5.2.0, safe-buffer@^5.2.1: +safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@^5.2.0, safe-buffer@^5.2.1: version "5.2.1" resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== +safe-buffer@~5.1.0, safe-buffer@~5.1.1: + version "5.1.2" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + safe-regex@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/safe-regex/-/safe-regex-1.1.0.tgz#40a3669f3b077d1e943d44629e157dd48023bf2e" @@ -10338,20 +10245,13 @@ sshpk@^1.7.0: safer-buffer "^2.0.2" tweetnacl "~0.14.0" -ssri@^6.0.0: +ssri@^6.0.0, ssri@^6.0.1: version "6.0.2" resolved "https://registry.yarnpkg.com/ssri/-/ssri-6.0.2.tgz#157939134f20464e7301ddba3e90ffa8f7728ac5" integrity sha512-cepbSq/neFK7xB6A50KHN0xHDotYzq58wWCa5LeWqnPrHG8GzfEjO/4O8kpmcGW+oaxkvhEJCWgbgNk4/ZV93Q== dependencies: figgy-pudding "^3.5.1" -ssri@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/ssri/-/ssri-6.0.1.tgz#2a3c41b28dd45b62b63676ecb74001265ae9edd8" - integrity sha512-3Wge10hNcT1Kur4PDFwEieXSCMCJs/7WvSACcrMYrNp+b8kDL1/0wJch5Ni2WrtwEa2IO8OsVfeKIciKCDx/QA== - dependencies: - figgy-pudding "^3.5.1" - ssri@^8.0.0, ssri@^8.0.1: version "8.0.1" resolved "https://registry.yarnpkg.com/ssri/-/ssri-8.0.1.tgz#638e4e439e2ffbd2cd289776d5ca457c4f51a2af" @@ -10436,7 +10336,7 @@ string-length@^4.0.1: char-regex "^1.0.2" strip-ansi "^6.0.0" -string-width@^1.0.1, "string-width@^1.0.2 || 2": +string-width@^1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3" integrity sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M= @@ -10445,7 +10345,7 @@ string-width@^1.0.1, "string-width@^1.0.2 || 2": is-fullwidth-code-point "^1.0.0" strip-ansi "^3.0.0" -string-width@^2.1.0: +"string-width@^1.0.2 || 2", string-width@^2.1.0: version "2.1.1" resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.1.tgz#ab93f27a8dc13d28cac815c462143a6d9012ae9e" integrity sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw== @@ -10678,20 +10578,7 @@ tar-stream@^2.0.0: inherits "^2.0.3" readable-stream "^3.1.1" -tar@^4, tar@^4.4.12: - version "4.4.13" - resolved "https://registry.yarnpkg.com/tar/-/tar-4.4.13.tgz#43b364bc52888d555298637b10d60790254ab525" - integrity sha512-w2VwSrBoHa5BsSyH+KxEqeQBAllHhccyMFVHtGtdMpF4W7IRWfZjFiQceJPChOeTsSDVUpER2T8FA93pr0L+QA== - dependencies: - chownr "^1.1.1" - fs-minipass "^1.2.5" - minipass "^2.8.6" - minizlib "^1.2.1" - mkdirp "^0.5.0" - safe-buffer "^5.1.2" - yallist "^3.0.3" - -tar@^4.4.10, tar@^4.4.8: +tar@^4, tar@^4.4.10, tar@^4.4.12, tar@^4.4.8: version "4.4.19" resolved "https://registry.yarnpkg.com/tar/-/tar-4.4.19.tgz#2e4d7263df26f2b914dee10c825ab132123742f3" integrity sha512-a20gEsvHnWe0ygBY8JbxoM4w3SJdhc7ZAuxkLqh+nvNQN2IOt0B5lLgM490X5Hl8FF0dl0tOf2ewFYAlIFgzVA== @@ -11162,16 +11049,11 @@ typescript@3.7.x: resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.7.tgz#c931733e2ec10dda56b855b379cc488a72a81199" integrity sha512-MmQdgo/XenfZPvVLtKZOq9jQQvzaUAUpcKW8Z43x9B2fOm4S5g//tPtMweZUIP+SoBqrVPEIm+dJeQ9dfO0QdA== -typescript@3.9.4: +typescript@3.9.4, typescript@^3.5.3: version "3.9.4" resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.4.tgz#5aa0a54904b51b96dfd67870ce2db70251802f10" integrity sha512-9OL+r0KVHqsYVH7K18IBR9hhC82YwLNlpSZfQDupGcfg8goB9p/s/9Okcy+ztnTeHR2U68xq21/igW9xpoGTgA== -typescript@^3.5.3: - version "3.9.10" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8" - integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q== - typescript@^4.4.3: version "4.4.3" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324" From 707cb5de16671cab4b2ccec2ffedf09d0c151852 Mon Sep 17 00:00:00 2001 From: Tyler Williams Date: Thu, 21 Sep 2023 15:31:53 -0600 Subject: [PATCH 3/4] chore: update docs to point at new middleware repo --- docs/concepts/middleware.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/concepts/middleware.md b/docs/concepts/middleware.md index 721f1c2a4..6a58f68b5 100644 --- a/docs/concepts/middleware.md +++ b/docs/concepts/middleware.md @@ -12,7 +12,7 @@ The order in which middlewares are invoked is inside-out: This means that the middlewares are invoked in the order you attach them. The value returned by the action invoked/ the aborted value gets passed through the middleware chain and can be manipulated. -MST ships with a small set of [pre-built / example middlewares](https://github.com/mobxjs/mobx-state-tree/blob/master/packages/mst-middlewares/README.md). +The community has created a small set of [pre-built / example middlewares](https://github.com/coolsoftwaretyler/mst-middlewares). Play around with a simple example of middleware in action with [this CodeSandbox](https://codesandbox.io/s/vjoql07ool). @@ -39,7 +39,7 @@ const disposer = addMiddleware(store, (call, next, abort) => { // if there is no middleware left to run // the value returned from the next can be manipulated - next(call, value => value + 1) + next(call, (value) => value + 1) }) ``` From 2007250d2f5adf75ae20584958c0b1c3d56cb199 Mon Sep 17 00:00:00 2001 From: Tyler Williams Date: Thu, 21 Sep 2023 15:32:23 -0600 Subject: [PATCH 4/4] chore: run build-docs --- docs/API/index.md | 412 +++++++++--------- docs/API/interfaces/customtypeoptions.md | 10 +- docs/API/interfaces/functionwithflag.md | 4 +- docs/API/interfaces/iactioncontext.md | 12 +- docs/API/interfaces/iactionrecorder.md | 10 +- .../iactiontrackingmiddleware2call.md | 4 +- .../iactiontrackingmiddleware2hooks.md | 6 +- .../iactiontrackingmiddlewarehooks.md | 12 +- docs/API/interfaces/ianycomplextype.md | 12 +- docs/API/interfaces/ianymodeltype.md | 30 +- docs/API/interfaces/ianytype.md | 12 +- docs/API/interfaces/ihooks.md | 8 +- docs/API/interfaces/ijsonpatch.md | 6 +- docs/API/interfaces/imiddlewareevent.md | 22 +- docs/API/interfaces/imodelreflectiondata.md | 12 +- .../imodelreflectionpropertiesdata.md | 4 +- docs/API/interfaces/imodeltype.md | 30 +- docs/API/interfaces/ipatchrecorder.md | 16 +- docs/API/interfaces/ireversiblejsonpatch.md | 8 +- docs/API/interfaces/iserializedactioncall.md | 6 +- docs/API/interfaces/isimpletype.md | 12 +- docs/API/interfaces/isnapshotprocessor.md | 12 +- docs/API/interfaces/isnapshotprocessors.md | 4 +- docs/API/interfaces/itype.md | 12 +- .../API/interfaces/ivalidationcontextentry.md | 4 +- docs/API/interfaces/ivalidationerror.md | 6 +- docs/API/interfaces/referenceoptionsgetset.md | 4 +- .../referenceoptionsoninvalidated.md | 2 +- docs/API/interfaces/unionoptions.md | 4 +- 29 files changed, 348 insertions(+), 348 deletions(-) diff --git a/docs/API/index.md b/docs/API/index.md index 8c2f558d5..7085dda6d 100644 --- a/docs/API/index.md +++ b/docs/API/index.md @@ -177,7 +177,7 @@ sidebar_label: "Globals" Ƭ **IDisposer**: *function* -*Defined in [packages/mobx-state-tree/src/utils.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/utils.ts#L41)* +*Defined in [packages/mobx-state-tree/src/utils.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/utils.ts#L41)* A generic disposer. @@ -191,7 +191,7 @@ ___ Ƭ **IHooksGetter**: *function* -*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/Hook.ts#L19)* +*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/Hook.ts#L19)* #### Type declaration: @@ -209,7 +209,7 @@ ___ Ƭ **IMiddlewareEventType**: *"action" | "flow_spawn" | "flow_resume" | "flow_resume_error" | "flow_return" | "flow_throw"* -*Defined in [packages/mobx-state-tree/src/core/action.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L16)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L16)* ___ @@ -217,7 +217,7 @@ ___ Ƭ **IMiddlewareHandler**: *function* -*Defined in [packages/mobx-state-tree/src/core/action.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L54)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L54)* #### Type declaration: @@ -254,7 +254,7 @@ ___ Ƭ **ITypeDispatcher**: *function* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L27)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L27)* #### Type declaration: @@ -272,7 +272,7 @@ ___ Ƭ **IValidationContext**: *[IValidationContextEntry](interfaces/ivalidationcontextentry.md)[]* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L23)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L23)* Array of validation context entries @@ -282,7 +282,7 @@ ___ Ƭ **IValidationResult**: *[IValidationError](interfaces/ivalidationerror.md)[]* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L36)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L36)* Type validation result, which is an array of type validation errors @@ -292,7 +292,7 @@ ___ Ƭ **Instance**: *T extends object ? T["Type"] : T* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:230](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L230)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:230](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L230)* The instance representation of a given type. @@ -302,7 +302,7 @@ ___ Ƭ **LivelinessMode**: *"warn" | "error" | "ignore"* -*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L7)* +*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L7)* Defines what MST should do when running into reads / writes to objects that have died. - `"warn"`: Print a warning (default). @@ -315,7 +315,7 @@ ___ Ƭ **OnReferenceInvalidated**: *function* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L43)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L43)* #### Type declaration: @@ -333,7 +333,7 @@ ___ Ƭ **OnReferenceInvalidatedEvent**: *object* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L34)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L34)* #### Type declaration: @@ -343,7 +343,7 @@ ___ Ƭ **ReferenceIdentifier**: *string | number* -*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L142)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L142)* Valid types for identifiers. @@ -353,7 +353,7 @@ ___ Ƭ **ReferenceOptions**: *[ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› | [ReferenceOptionsOnInvalidated](interfaces/referenceoptionsoninvalidated.md)‹IT› | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & [ReferenceOptionsOnInvalidated](interfaces/referenceoptionsoninvalidated.md)‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:473](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L473)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:473](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L473)* ___ @@ -361,7 +361,7 @@ ___ Ƭ **SnapshotIn**: *T extends object ? T["CreationType"] : T extends IStateTreeNode ? IT["CreationType"] : T* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:235](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L235)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:235](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L235)* The input (creation) snapshot representation of a given type. @@ -371,7 +371,7 @@ ___ Ƭ **SnapshotOrInstance**: *[SnapshotIn](index.md#snapshotin)‹T› | [Instance](index.md#instance)‹T›* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:276](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L276)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:276](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L276)* A type which is equivalent to the union of SnapshotIn and Instance types of a given typeof TYPE or typeof VARIABLE. For primitives it defaults to the primitive itself. @@ -404,7 +404,7 @@ ___ Ƭ **SnapshotOut**: *T extends object ? T["SnapshotType"] : T extends IStateTreeNode ? IT["SnapshotType"] : T* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:244](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L244)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:244](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L244)* The output snapshot representation of a given type. @@ -414,7 +414,7 @@ The output snapshot representation of a given type. • **DatePrimitive**: *[IType](interfaces/itype.md)‹number | Date, number, Date›* = _DatePrimitive -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L215)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L215)* `types.Date` - Creates a type that can only contain a javascript Date value. @@ -437,7 +437,7 @@ ___ (v) => typeof v === "boolean" ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:169](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L169)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:169](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L169)* `types.boolean` - Creates a type that can only contain a boolean value. This type is used for boolean values by default @@ -460,7 +460,7 @@ ___ (v) => isFinite(v) ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:150](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L150)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:150](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L150)* `types.finite` - Creates a type that can only contain an finite value. @@ -482,7 +482,7 @@ ___ (v) => isFloat(v) ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:132](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L132)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:132](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L132)* `types.float` - Creates a type that can only contain an float value. @@ -500,7 +500,7 @@ ___ • **identifier**: *[ISimpleType](interfaces/isimpletype.md)‹string›* = new IdentifierType() -*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:110](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L110)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:110](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L110)* `types.identifier` - Identifiers are used to make references, lifecycle events and reconciling works. Inside a state tree, for each type can exist only one instance for each given identifier. @@ -524,7 +524,7 @@ ___ • **identifierNumber**: *[ISimpleType](interfaces/isimpletype.md)‹number›* = new IdentifierNumberType() -*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:125](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L125)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:125](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L125)* `types.identifierNumber` - Similar to `types.identifier`. This one will serialize from / to a number when applying snapshots @@ -548,7 +548,7 @@ ___ (v) => isInteger(v) ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:114](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L114)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:114](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L114)* `types.integer` - Creates a type that can only contain an integer value. @@ -570,7 +570,7 @@ ___ (v) => v === null ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L178)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L178)* `types.null` - The type of the value `null` @@ -584,7 +584,7 @@ ___ (v) => typeof v === "number" ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L96)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L96)* `types.number` - Creates a type that can only contain a numeric value. This type is used for numeric values by default @@ -607,7 +607,7 @@ ___ (v) => typeof v === "string" ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L77)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L77)* `types.string` - Creates a type that can only contain a string value. This type is used for string values by default @@ -630,7 +630,7 @@ ___ (v) => v === undefined ) -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L187)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L187)* `types.undefined` - The type of the value `undefined` @@ -640,7 +640,7 @@ ___ ▸ **addDisposer**(`target`: IAnyStateTreeNode, `disposer`: [IDisposer](index.md#idisposer)): *[IDisposer](index.md#idisposer)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:752](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L752)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:752](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L752)* Use this utility to register a function that should be called whenever the targeted state tree node is destroyed. This is a useful alternative to managing @@ -682,7 +682,7 @@ ___ ▸ **addMiddleware**(`target`: IAnyStateTreeNode, `handler`: [IMiddlewareHandler](index.md#imiddlewarehandler), `includeHooks`: boolean): *[IDisposer](index.md#idisposer)* -*Defined in [packages/mobx-state-tree/src/core/action.ts:163](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L163)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:163](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L163)* Middleware can be used to intercept any action is invoked on the subtree where it is attached. If a tree is protected (by default), this means that any mutation of the tree will pass through your middleware. @@ -707,7 +707,7 @@ ___ ▸ **applyAction**(`target`: IAnyStateTreeNode, `actions`: [ISerializedActionCall](interfaces/iserializedactioncall.md) | [ISerializedActionCall](interfaces/iserializedactioncall.md)[]): *void* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L89)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L89)* Applies an action or a series of actions in a single MobX transaction. Does not return any value @@ -728,7 +728,7 @@ ___ ▸ **applyPatch**(`target`: IAnyStateTreeNode, `patch`: [IJsonPatch](interfaces/ijsonpatch.md) | ReadonlyArray‹[IJsonPatch](interfaces/ijsonpatch.md)›): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:125](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L125)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:125](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L125)* Applies a JSON-patch to the given model instance or bails out if the patch couldn't be applied See [patches](https://github.com/mobxjs/mobx-state-tree#patches) for more details. @@ -750,7 +750,7 @@ ___ ▸ **applySnapshot**<**C**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹C, any, any››, `snapshot`: C): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:322](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L322)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:322](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L322)* Applies a snapshot to a given model instances. Patch and snapshot listeners will be invoked as usual. @@ -773,7 +773,7 @@ ___ ▸ **array**<**IT**>(`subtype`: IT): *IArrayType‹IT›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/array.ts:337](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/array.ts#L337)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/array.ts:337](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/array.ts#L337)* `types.array` - Creates an index based collection type who's children are all of a uniform declared type. @@ -813,7 +813,7 @@ ___ ▸ **cast**<**O**>(`snapshotOrInstance`: O): *O* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:881](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L881)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:881](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L881)* Casts a node snapshot or instance type to an instance type so it can be assigned to a type instance. Note that this is just a cast for the type system, this is, it won't actually convert a snapshot to an instance, @@ -856,7 +856,7 @@ The same object cast as an instance ▸ **cast**<**O**>(`snapshotOrInstance`: TypeOfValue["CreationType"] | TypeOfValue["SnapshotType"] | TypeOfValue["Type"]): *O* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:884](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L884)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:884](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L884)* Casts a node snapshot or instance type to an instance type so it can be assigned to a type instance. Note that this is just a cast for the type system, this is, it won't actually convert a snapshot to an instance, @@ -903,7 +903,7 @@ ___ ▸ **castFlowReturn**<**T**>(`val`: T): *T* -*Defined in [packages/mobx-state-tree/src/core/flow.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/flow.ts#L34)* +*Defined in [packages/mobx-state-tree/src/core/flow.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/flow.ts#L34)* **`deprecated`** Not needed since TS3.6. Used for TypeScript to make flows that return a promise return the actual promise result. @@ -926,7 +926,7 @@ ___ ▸ **castToReferenceSnapshot**<**I**>(`instance`: I): *Extract extends never ? I : ReferenceIdentifier* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:984](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L984)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:984](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L984)* Casts a node instance type to a reference snapshot type so it can be assigned to a reference snapshot (e.g. to be used inside a create call). Note that this is just a cast for the type system, this is, it won't actually convert an instance to a reference snapshot, @@ -972,7 +972,7 @@ ___ ▸ **castToSnapshot**<**I**>(`snapshotOrInstance`: I): *Extract extends never ? I : TypeOfValue["CreationType"]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:950](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L950)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:950](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L950)* Casts a node instance type to a snapshot type so it can be assigned to a type snapshot (e.g. to be used inside a create call). Note that this is just a cast for the type system, this is, it won't actually convert an instance to a snapshot, @@ -1017,7 +1017,7 @@ ___ ▸ **clone**<**T**>(`source`: T, `keepEnvironment`: boolean | any): *T* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:667](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L667)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:667](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L667)* Returns a deep copy of the given state tree node as new tree. Shorthand for `snapshot(x) = getType(x).create(getSnapshot(x))` @@ -1043,7 +1043,7 @@ ___ ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *[IModelType](interfaces/imodeltype.md)‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:772](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L772)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:772](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L772)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1081,7 +1081,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *[IModelType](interfaces/imodeltype.md)‹PA & PB, OA & OB, _CustomJoin‹FCA, FCB›, _CustomJoin‹FSA, FSB››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:774](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L774)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:774](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L774)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1118,7 +1118,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:776](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L776)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:776](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L776)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1165,7 +1165,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC, OA & OB & OC, _CustomJoin‹FCA, _CustomJoin‹FCB, FCC››, _CustomJoin‹FSA, _CustomJoin‹FSB, FSC›››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:778](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L778)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:778](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L778)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1211,7 +1211,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:780](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L780)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:780](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L780)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1267,7 +1267,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD, OA & OB & OC & OD, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, FCD›››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, FSD››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:782](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L782)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:782](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L782)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1322,7 +1322,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:784](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L784)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:784](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L784)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1387,7 +1387,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE, OA & OB & OC & OD & OE, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, FCE››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, FSE›››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:786](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L786)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:786](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L786)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1451,7 +1451,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:790](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L790)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:790](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L790)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1525,7 +1525,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF, OA & OB & OC & OD & OE & OF, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, FCF›››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, FSF››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:793](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L793)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:793](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L793)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1598,7 +1598,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:796](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L796)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:796](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L796)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1681,7 +1681,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG, OA & OB & OC & OD & OE & OF & OG, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, FCG››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, FSG›››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:799](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L799)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:799](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L799)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1763,7 +1763,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:802](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L802)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:802](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L802)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1855,7 +1855,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG & PH, OA & OB & OC & OD & OE & OF & OG & OH, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, FCH›››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, FSH››››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L805)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L805)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -1946,7 +1946,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`name`: string, `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, _CustomJoin‹FCH, FCI››››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, _CustomJoin‹FSH, FSI›››››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:808](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L808)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:808](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L808)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -2047,7 +2047,7 @@ Name | Type | ▸ **compose**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *[IModelType](interfaces/imodeltype.md)‹PA & PB & PC & PD & PE & PF & PG & PH & PI, OA & OB & OC & OD & OE & OF & OG & OH & OI, _CustomJoin‹FCA, _CustomJoin‹FCB, _CustomJoin‹FCC, _CustomJoin‹FCD, _CustomJoin‹FCE, _CustomJoin‹FCF, _CustomJoin‹FCG, _CustomJoin‹FCH, FCI››››››››, _CustomJoin‹FSA, _CustomJoin‹FSB, _CustomJoin‹FSC, _CustomJoin‹FSD, _CustomJoin‹FSE, _CustomJoin‹FSF, _CustomJoin‹FSG, _CustomJoin‹FSH, FSI›››››››››* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:811](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L811)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:811](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L811)* `types.compose` - Composes a new model from one or more existing model types. This method can be invoked in two forms: @@ -2151,7 +2151,7 @@ ___ ▸ **createActionTrackingMiddleware**<**T**>(`hooks`: [IActionTrackingMiddlewareHooks](interfaces/iactiontrackingmiddlewarehooks.md)‹T›): *[IMiddlewareHandler](index.md#imiddlewarehandler)* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L28)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L28)* Note: Consider migrating to `createActionTrackingMiddleware2`, it is easier to use. @@ -2181,7 +2181,7 @@ ___ ▸ **createActionTrackingMiddleware2**<**TEnv**>(`middlewareHooks`: [IActionTrackingMiddleware2Hooks](interfaces/iactiontrackingmiddleware2hooks.md)‹TEnv›): *[IMiddlewareHandler](index.md#imiddlewarehandler)* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L74)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L74)* Convenience utility to create action based middleware that supports async processes more easily. The flow is like this: @@ -2220,7 +2220,7 @@ ___ ▸ **custom**<**S**, **T**>(`options`: [CustomTypeOptions](interfaces/customtypeoptions.md)‹S, T›): *[IType](interfaces/itype.md)‹S | T, S, T›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L74)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:74](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L74)* `types.custom` - Creates a custom type. Custom types can be used for arbitrary immutable values, that have a serializable representation. For example, to create your own Date representation, Decimal type etc. @@ -2284,7 +2284,7 @@ ___ ▸ **decorate**<**T**>(`handler`: [IMiddlewareHandler](index.md#imiddlewarehandler), `fn`: T, `includeHooks`: boolean): *T* -*Defined in [packages/mobx-state-tree/src/core/action.ts:202](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L202)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:202](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L202)* Binds middleware to a specific action. @@ -2325,7 +2325,7 @@ ___ ▸ **destroy**(`target`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:699](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L699)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:699](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L699)* Removes a model element from the state tree, and mark it as end-of-life; the element should not be used anymore @@ -2343,7 +2343,7 @@ ___ ▸ **detach**<**T**>(`target`: T): *T* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:688](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L688)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:688](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L688)* Removes a model element from the state tree, and let it live on as a new state tree @@ -2365,7 +2365,7 @@ ___ ▸ **enumeration**<**T**>(`options`: T): *[ISimpleType](interfaces/isimpletype.md)‹UnionStringArray‹T››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/enumeration.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/enumeration.ts#L11)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/enumeration.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/enumeration.ts#L11)* `types.enumeration` - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals) @@ -2391,7 +2391,7 @@ Name | Type | Description | ▸ **enumeration**<**T**>(`name`: string, `options`: T[]): *[ISimpleType](interfaces/isimpletype.md)‹UnionStringArray‹T[]››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/enumeration.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/enumeration.ts#L14)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/enumeration.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/enumeration.ts#L14)* `types.enumeration` - Can be used to create an string based enumeration. (note: this methods is just sugar for a union of string literals) @@ -2422,7 +2422,7 @@ ___ ▸ **escapeJsonPath**(`path`: string): *string* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L77)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:77](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L77)* Escape slashes and backslashes. @@ -2442,7 +2442,7 @@ ___ ▸ **flow**<**R**, **Args**>(`generator`: function): *function* -*Defined in [packages/mobx-state-tree/src/core/flow.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/flow.ts#L21)* +*Defined in [packages/mobx-state-tree/src/core/flow.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/flow.ts#L21)* See [asynchronous actions](concepts/async-actions.md). @@ -2482,7 +2482,7 @@ ___ ▸ **frozen**<**C**>(`subType`: [IType](interfaces/itype.md)‹C, any, any›): *[IType](interfaces/itype.md)‹C, C, C›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L58)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L58)* `types.frozen` - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. @@ -2534,7 +2534,7 @@ Name | Type | ▸ **frozen**<**T**>(`defaultValue`: T): *[IType](interfaces/itype.md)‹T | undefined | null, T, T›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L59)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L59)* `types.frozen` - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. @@ -2586,7 +2586,7 @@ Name | Type | ▸ **frozen**<**T**>(): *[IType](interfaces/itype.md)‹T, T, T›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L60)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L60)* `types.frozen` - Frozen can be used to store any value that is serializable in itself (that is valid JSON). Frozen values need to be immutable or treated as if immutable. They need be serializable as well. @@ -2636,7 +2636,7 @@ ___ ▸ **getChildType**(`object`: IAnyStateTreeNode, `propertyName?`: undefined | string): *[IAnyType](interfaces/ianytype.md)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:69](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L69)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:69](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L69)* Returns the _declared_ type of the given sub property of an object, array or map. In the case of arrays and maps the property name is optional and will be ignored. @@ -2664,7 +2664,7 @@ ___ ▸ **getEnv**<**T**>(`target`: IAnyStateTreeNode): *T* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:774](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L774)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:774](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L774)* Returns the environment of the current state tree. For more info on environments, see [Dependency injection](https://github.com/mobxjs/mobx-state-tree#dependency-injection) @@ -2692,7 +2692,7 @@ ___ ▸ **getIdentifier**(`target`: IAnyStateTreeNode): *string | null* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:550](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L550)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:550](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L550)* Returns the identifier of the target node. This is the *string normalized* identifier, which might not match the type of the identifier attribute @@ -2711,7 +2711,7 @@ ___ ▸ **getLivelinessChecking**(): *[LivelinessMode](index.md#livelinessmode)* -*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L27)* +*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L27)* Returns the current liveliness checking mode. @@ -2725,7 +2725,7 @@ ___ ▸ **getMembers**(`target`: IAnyStateTreeNode): *[IModelReflectionData](interfaces/imodelreflectiondata.md)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:853](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L853)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:853](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L853)* Returns a reflection of the model node, including name, properties, views, volatile state, and actions. `flowActions` is also provided as a separate array of names for any action that @@ -2750,7 +2750,7 @@ ___ ▸ **getNodeId**(`target`: IAnyStateTreeNode): *number* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:999](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L999)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:999](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L999)* Returns the unique node id (not to be confused with the instance identifier) for a given instance. @@ -2772,7 +2772,7 @@ ___ ▸ **getParent**<**IT**>(`target`: IAnyStateTreeNode, `depth`: number): *TypeOrStateTreeNodeToStateTreeNode‹IT›* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:383](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L383)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:383](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L383)* Returns the immediate parent of this object, or throws. @@ -2801,7 +2801,7 @@ ___ ▸ **getParentOfType**<**IT**>(`target`: IAnyStateTreeNode, `type`: IT): *IT["Type"]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:427](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L427)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:427](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L427)* Returns the target's parent of a given type, or throws. @@ -2824,7 +2824,7 @@ ___ ▸ **getPath**(`target`: IAnyStateTreeNode): *string* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:467](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L467)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:467](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L467)* Returns the path of the given object in the model tree @@ -2842,7 +2842,7 @@ ___ ▸ **getPathParts**(`target`: IAnyStateTreeNode): *string[]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:480](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L480)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:480](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L480)* Returns the path of the given object as unescaped string array. @@ -2860,7 +2860,7 @@ ___ ▸ **getPropertyMembers**(`typeOrNode`: [IAnyModelType](interfaces/ianymodeltype.md) | IAnyStateTreeNode): *[IModelReflectionPropertiesData](interfaces/imodelreflectionpropertiesdata.md)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:814](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L814)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:814](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L814)* Returns a reflection of the model type properties and name for either a model type or model node. @@ -2878,7 +2878,7 @@ ___ ▸ **getRelativePath**(`base`: IAnyStateTreeNode, `target`: IAnyStateTreeNode): *string* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:649](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L649)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:649](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L649)* Given two state tree nodes that are part of the same tree, returns the shortest jsonpath needed to navigate from the one to the other @@ -2898,7 +2898,7 @@ ___ ▸ **getRoot**<**IT**>(`target`: IAnyStateTreeNode): *TypeOrStateTreeNodeToStateTreeNode‹IT›* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:452](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L452)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:452](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L452)* Given an object in a model tree, returns the root object of that tree. @@ -2923,7 +2923,7 @@ ___ ▸ **getRunningActionContext**(): *[IActionContext](interfaces/iactioncontext.md) | undefined* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L26)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:26](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L26)* Returns the currently executing MST action context, or undefined if none. @@ -2935,7 +2935,7 @@ ___ ▸ **getSnapshot**<**S**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹any, S, any››, `applyPostProcess`: boolean): *S* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:337](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L337)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:337](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L337)* Calculates a snapshot from the given model instance. The snapshot will always reflect the latest state but use structural sharing where possible. Doesn't require MobX transactions to be completed. @@ -2959,7 +2959,7 @@ ___ ▸ **getType**(`object`: IAnyStateTreeNode): *[IAnyComplexType](interfaces/ianycomplextype.md)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L47)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L47)* Returns the _actual_ type of the given tree node. (Or throws) @@ -2977,7 +2977,7 @@ ___ ▸ **hasParent**(`target`: IAnyStateTreeNode, `depth`: number): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:357](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L357)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:357](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L357)* Given a model instance, returns `true` if the object has a parent, that is, is part of another object, map or array. @@ -2996,7 +2996,7 @@ ___ ▸ **hasParentOfType**(`target`: IAnyStateTreeNode, `type`: [IAnyComplexType](interfaces/ianycomplextype.md)): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:407](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L407)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:407](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L407)* Given a model instance, returns `true` if the object has a parent of given type, that is, is part of another object, map or array @@ -3015,7 +3015,7 @@ ___ ▸ **isActionContextChildOf**(`actionContext`: [IActionContext](interfaces/iactioncontext.md), `parent`: number | [IActionContext](interfaces/iactioncontext.md) | [IMiddlewareEvent](interfaces/imiddlewareevent.md)): *boolean* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L56)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L56)* Returns if the given action context is a parent of this action context. @@ -3034,7 +3034,7 @@ ___ ▸ **isActionContextThisOrChildOf**(`actionContext`: [IActionContext](interfaces/iactioncontext.md), `parentOrThis`: number | [IActionContext](interfaces/iactioncontext.md) | [IMiddlewareEvent](interfaces/imiddlewareevent.md)): *boolean* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:66](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L66)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:66](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L66)* Returns if the given action context is this or a parent of this action context. @@ -3053,7 +3053,7 @@ ___ ▸ **isAlive**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:717](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L717)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:717](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L717)* Returns true if the given state tree node is not killed yet. This means that the node is still a part of a tree, and that `destroy` @@ -3074,7 +3074,7 @@ ___ ▸ **isArrayType**<**Items**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IArrayType* -*Defined in [packages/mobx-state-tree/src/types/complex-types/array.ts:501](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/array.ts#L501)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/array.ts:501](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/array.ts#L501)* Returns if a given value represents an array type. @@ -3098,7 +3098,7 @@ ___ ▸ **isFrozenType**<**IT**, **T**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L113)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/frozen.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/frozen.ts#L113)* Returns if a given value represents a frozen type. @@ -3122,7 +3122,7 @@ ___ ▸ **isIdentifierType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:133](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L133)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/identifier.ts:133](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/identifier.ts#L133)* Returns if a given value represents an identifier type. @@ -3144,7 +3144,7 @@ ___ ▸ **isLateType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/late.ts#L141)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/late.ts#L141)* Returns if a given value represents a late type. @@ -3166,7 +3166,7 @@ ___ ▸ **isLiteralType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/literal.ts:86](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/literal.ts#L86)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/literal.ts:86](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/literal.ts#L86)* Returns if a given value represents a literal type. @@ -3188,7 +3188,7 @@ ___ ▸ **isMapType**<**Items**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IMapType* -*Defined in [packages/mobx-state-tree/src/types/complex-types/map.ts:520](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/map.ts#L520)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/map.ts:520](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/map.ts#L520)* Returns if a given value represents a map type. @@ -3212,7 +3212,7 @@ ___ ▸ **isModelType**<**IT**>(`type`: [IAnyType](interfaces/ianytype.md)): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:857](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L857)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:857](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L857)* Returns if a given value represents a model type. @@ -3234,7 +3234,7 @@ ___ ▸ **isOptionalType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:234](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/optional.ts#L234)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:234](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/optional.ts#L234)* Returns if a value represents an optional type. @@ -3258,7 +3258,7 @@ ___ ▸ **isPrimitiveType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/primitives.ts:241](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/primitives.ts#L241)* +*Defined in [packages/mobx-state-tree/src/types/primitives.ts:241](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/primitives.ts#L241)* Returns if a given value represents a primitive type. @@ -3280,7 +3280,7 @@ ___ ▸ **isProtected**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:311](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L311)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:311](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L311)* Returns true if the object is in protected mode, @see protect @@ -3298,7 +3298,7 @@ ___ ▸ **isReferenceType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:533](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L533)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:533](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L533)* Returns if a given value represents a reference type. @@ -3320,7 +3320,7 @@ ___ ▸ **isRefinementType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:126](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L126)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:126](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L126)* Returns if a given value is a refinement type. @@ -3342,7 +3342,7 @@ ___ ▸ **isRoot**(`target`: IAnyStateTreeNode): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:493](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L493)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:493](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L493)* Returns true if the given object is the root of a model tree. @@ -3360,7 +3360,7 @@ ___ ▸ **isStateTreeNode**<**IT**>(`value`: any): *value is STNValue, IT>* -*Defined in [packages/mobx-state-tree/src/core/node/node-utils.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/node-utils.ts#L68)* +*Defined in [packages/mobx-state-tree/src/core/node/node-utils.ts:68](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/node-utils.ts#L68)* Returns true if the given value is a node in a state tree. More precisely, that is, if the value is an instance of a @@ -3386,7 +3386,7 @@ ___ ▸ **isType**(`value`: any): *value is IAnyType* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:539](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L539)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:539](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L539)* Returns if a given value represents a type. @@ -3406,7 +3406,7 @@ ___ ▸ **isUnionType**<**IT**>(`type`: IT): *type is IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:282](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L282)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:282](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L282)* Returns if a given value represents a union type. @@ -3428,7 +3428,7 @@ ___ ▸ **isValidReference**<**N**>(`getter`: function, `checkIfAlive`: boolean): *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:597](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L597)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:597](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L597)* Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns if the check passes or not. @@ -3456,7 +3456,7 @@ ___ ▸ **joinJsonPath**(`path`: string[]): *string* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:98](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L98)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:98](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L98)* Generates a json-path compliant json path from path parts. @@ -3474,7 +3474,7 @@ ___ ▸ **late**<**T**>(`type`: function): *T* -*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/late.ts#L103)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:103](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/late.ts#L103)* `types.late` - Defines a type that gets implemented later. This is useful when you have to deal with circular dependencies. Please notice that when defining circular dependencies TypeScript isn't smart enough to inference them. @@ -3503,7 +3503,7 @@ A function that returns the type that will be defined. ▸ **late**<**T**>(`name`: string, `type`: function): *T* -*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/late.ts#L104)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/late.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/late.ts#L104)* `types.late` - Defines a type that gets implemented later. This is useful when you have to deal with circular dependencies. Please notice that when defining circular dependencies TypeScript isn't smart enough to inference them. @@ -3540,7 +3540,7 @@ ___ ▸ **lazy**<**T**, **U**>(`name`: string, `options`: LazyOptions‹T, U›): *T* -*Defined in [packages/mobx-state-tree/src/types/utility-types/lazy.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/lazy.ts#L22)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/lazy.ts:22](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/lazy.ts#L22)* **Type parameters:** @@ -3563,7 +3563,7 @@ ___ ▸ **literal**<**S**>(`value`: S): *[ISimpleType](interfaces/isimpletype.md)‹S›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/literal.ts:73](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/literal.ts#L73)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/literal.ts:73](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/literal.ts#L73)* `types.literal` - The literal type will return a type that will match only the exact given type. The given value must be a primitive, in order to be serialized to a snapshot correctly. @@ -3595,7 +3595,7 @@ ___ ▸ **map**<**IT**>(`subtype`: IT): *IMapType‹IT›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/map.ts:510](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/map.ts#L510)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/map.ts:510](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/map.ts#L510)* `types.map` - Creates a key based collection type who's children are all of a uniform declared type. If the type stored in a map has an identifier, it is mandatory to store the child under that identifier in the map. @@ -3638,7 +3638,7 @@ ___ ▸ **maybe**<**IT**>(`type`: IT): *IMaybe‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/maybe.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/maybe.ts#L31)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/maybe.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/maybe.ts#L31)* `types.maybe` - Maybe will make a type nullable, and also optional. The value `undefined` will be used to represent nullability. @@ -3661,7 +3661,7 @@ ___ ▸ **maybeNull**<**IT**>(`type`: IT): *IMaybeNull‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/maybe.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/maybe.ts#L44)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/maybe.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/maybe.ts#L44)* `types.maybeNull` - Maybe will make a type nullable, and also optional. The value `null` will be used to represent no value. @@ -3684,7 +3684,7 @@ ___ ▸ **model**<**P**>(`name`: string, `properties?`: [P](undefined)): *[IModelType](interfaces/imodeltype.md)‹ModelPropertiesDeclarationToProperties‹P›, __type›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:741](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L741)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:741](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L741)* `types.model` - Creates a new model type by providing a name, properties, volatile state and actions. @@ -3705,7 +3705,7 @@ Name | Type | ▸ **model**<**P**>(`properties?`: [P](undefined)): *[IModelType](interfaces/imodeltype.md)‹ModelPropertiesDeclarationToProperties‹P›, __type›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:745](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L745)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:745](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L745)* `types.model` - Creates a new model type by providing a name, properties, volatile state and actions. @@ -3729,7 +3729,7 @@ ___ ▸ **onAction**(`target`: IAnyStateTreeNode, `listener`: function, `attachAfter`: boolean): *[IDisposer](index.md#idisposer)* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:226](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L226)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:226](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L226)* Registers a function that will be invoked for each action that is called on the provided model instance, or to any of its children. See [actions](https://github.com/mobxjs/mobx-state-tree#actions) for more details. onAction events are emitted only for the outermost called action in the stack. @@ -3789,7 +3789,7 @@ ___ ▸ **onPatch**(`target`: IAnyStateTreeNode, `callback`: function): *[IDisposer](index.md#idisposer)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L84)* Registers a function that will be invoked for each mutation that is applied to the provided model instance, or to any of its children. See [patches](https://github.com/mobxjs/mobx-state-tree#patches) for more details. onPatch events are emitted immediately and will not await the end of a transaction. @@ -3824,7 +3824,7 @@ ___ ▸ **onSnapshot**<**S**>(`target`: IStateTreeNode‹[IType](interfaces/itype.md)‹any, S, any››, `callback`: function): *[IDisposer](index.md#idisposer)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L104)* Registers a function that is invoked whenever a new snapshot for the given model instance is available. The listener will only be fire at the end of the current MobX (trans)action. @@ -3856,7 +3856,7 @@ ___ ▸ **optional**<**IT**>(`type`: IT, `defaultValueOrFunction`: OptionalDefaultValueOrFunction‹IT›): *IOptionalIType‹IT, []›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:160](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/optional.ts#L160)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:160](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/optional.ts#L160)* `types.optional` - Can be used to create a property with a default value. @@ -3908,7 +3908,7 @@ Name | Type | ▸ **optional**<**IT**, **OptionalVals**>(`type`: IT, `defaultValueOrFunction`: OptionalDefaultValueOrFunction‹IT›, `optionalValues`: OptionalVals): *IOptionalIType‹IT, OptionalVals›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/optional.ts#L164)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/optional.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/optional.ts#L164)* `types.optional` - Can be used to create a property with a default value. @@ -3967,7 +3967,7 @@ ___ ▸ **protect**(`target`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:266](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L266)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:266](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L266)* The inverse of `unprotect`. @@ -3985,7 +3985,7 @@ ___ ▸ **recordActions**(`subject`: IAnyStateTreeNode, `filter?`: undefined | function): *[IActionRecorder](interfaces/iactionrecorder.md)* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:148](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L148)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:148](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L148)* Small abstraction around `onAction` and `applyAction`, attaches an action listener to a tree and records all the actions emitted. Returns an recorder object with the following signature: @@ -4023,7 +4023,7 @@ ___ ▸ **recordPatches**(`subject`: IAnyStateTreeNode, `filter?`: undefined | function): *[IPatchRecorder](interfaces/ipatchrecorder.md)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L178)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:178](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L178)* Small abstraction around `onPatch` and `applyPatch`, attaches a patch listener to a tree and records all the patches. Returns a recorder object with the following signature: @@ -4066,7 +4066,7 @@ ___ ▸ **reference**<**IT**>(`subType`: IT, `options?`: [ReferenceOptions](index.md#referenceoptions)‹IT›): *IReferenceType‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:486](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L486)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:486](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L486)* `types.reference` - Creates a reference to another type, which should have defined an identifier. See also the [reference and identifiers](https://github.com/mobxjs/mobx-state-tree#references-and-identifiers) section. @@ -4090,7 +4090,7 @@ ___ ▸ **refinement**<**IT**>(`name`: string, `type`: IT, `predicate`: function, `message?`: string | function): *IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L84)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L84)* `types.refinement` - Creates a type that is more specific than the base type, e.g. `types.refinement(types.string, value => value.length > 5)` to create a type of strings that can only be longer then 5. @@ -4120,7 +4120,7 @@ Name | Type | ▸ **refinement**<**IT**>(`type`: IT, `predicate`: function, `message?`: string | function): *IT* -*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:90](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L90)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/refinement.ts:90](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/refinement.ts#L90)* `types.refinement` - Creates a type that is more specific than the base type, e.g. `types.refinement(types.string, value => value.length > 5)` to create a type of strings that can only be longer then 5. @@ -4152,7 +4152,7 @@ ___ ▸ **resolveIdentifier**<**IT**>(`type`: IT, `target`: IAnyStateTreeNode, `identifier`: [ReferenceIdentifier](index.md#referenceidentifier)): *IT["Type"] | undefined* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:526](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L526)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:526](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L526)* Resolves a model instance given a root target, the type and the identifier you are searching for. Returns undefined if no value can be found. @@ -4177,7 +4177,7 @@ ___ ▸ **resolvePath**(`target`: IAnyStateTreeNode, `path`: string): *any* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:508](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L508)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:508](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L508)* Resolves a path relatively to a given object. Returns undefined if no value can be found. @@ -4197,7 +4197,7 @@ ___ ▸ **safeReference**<**IT**>(`subType`: IT, `options`: __type | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & object): *IReferenceType‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:537](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L537)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:537](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L537)* `types.safeReference` - A safe reference is like a standard reference, except that it accepts the undefined value by default and automatically sets itself to undefined (when the parent is a model) / removes itself from arrays and maps @@ -4227,7 +4227,7 @@ Name | Type | ▸ **safeReference**<**IT**>(`subType`: IT, `options?`: __type | [ReferenceOptionsGetSet](interfaces/referenceoptionsgetset.md)‹IT› & object): *IMaybe‹IReferenceType‹IT››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:544](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L544)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:544](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L544)* `types.safeReference` - A safe reference is like a standard reference, except that it accepts the undefined value by default and automatically sets itself to undefined (when the parent is a model) / removes itself from arrays and maps @@ -4261,7 +4261,7 @@ ___ ▸ **setLivelinessChecking**(`mode`: [LivelinessMode](index.md#livelinessmode)): *void* -*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:18](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L18)* +*Defined in [packages/mobx-state-tree/src/core/node/livelinessChecking.ts:18](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/livelinessChecking.ts#L18)* Defines what MST should do when running into reads / writes to objects that have died. By default it will print a warning. @@ -4281,7 +4281,7 @@ ___ ▸ **snapshotProcessor**<**IT**, **CustomC**, **CustomS**>(`type`: IT, `processors`: [ISnapshotProcessors](interfaces/isnapshotprocessors.md)‹IT["CreationType"], CustomC, IT["SnapshotType"], CustomS›, `name?`: undefined | string): *[ISnapshotProcessor](interfaces/isnapshotprocessor.md)‹IT, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:246](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L246)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:246](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L246)* `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type. @@ -4332,7 +4332,7 @@ ___ ▸ **splitJsonPath**(`path`: string): *string[]* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L118)* Splits and decodes a json path into several parts. @@ -4350,7 +4350,7 @@ ___ ▸ **toGenerator**<**R**>(`p`: Promise‹R›): *Generator‹Promise‹R›, R, R›* -*Defined in [packages/mobx-state-tree/src/core/flow.ts:87](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/flow.ts#L87)* +*Defined in [packages/mobx-state-tree/src/core/flow.ts:87](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/flow.ts#L87)* **`experimental`** experimental api - might change on minor/patch releases @@ -4390,7 +4390,7 @@ ___ ▸ **toGeneratorFunction**<**R**, **Args**>(`p`: function): *(Anonymous function)* -*Defined in [packages/mobx-state-tree/src/core/flow.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/flow.ts#L60)* +*Defined in [packages/mobx-state-tree/src/core/flow.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/flow.ts#L60)* **`experimental`** experimental api - might change on minor/patch releases @@ -4439,7 +4439,7 @@ ___ ▸ **tryReference**<**N**>(`getter`: function, `checkIfAlive`: boolean): *N | undefined* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:565](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L565)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:565](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L565)* Tests if a reference is valid (pointing to an existing node and optionally if alive) and returns such reference if the check passes, else it returns undefined. @@ -4468,7 +4468,7 @@ ___ ▸ **tryResolve**(`target`: IAnyStateTreeNode, `path`: string): *any* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:625](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L625)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:625](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L625)* Try to resolve a given path relative to a given node. @@ -4487,7 +4487,7 @@ ___ ▸ **typecheck**<**IT**>(`type`: IT, `value`: ExtractCSTWithSTN‹IT›): *void* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:166](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L166)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:166](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L166)* Run's the typechecker for the given type on the given value, which can be a snapshot or an instance. Throws if the given value is not according the provided type specification. @@ -4512,7 +4512,7 @@ ___ ▸ **unescapeJsonPath**(`path`: string): *string* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:88](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L88)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:88](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L88)* Unescape slashes and backslashes. @@ -4530,7 +4530,7 @@ ___ ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:159](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L159)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:159](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L159)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4563,7 +4563,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L161)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:161](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L161)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4597,7 +4597,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L164)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:164](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L164)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4639,7 +4639,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:166](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L166)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:166](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L166)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4682,7 +4682,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:168](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L168)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:168](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L168)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4733,7 +4733,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:171](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L171)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:171](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L171)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4785,7 +4785,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:174](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L174)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:174](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L174)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4845,7 +4845,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:177](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L177)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:177](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L177)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4906,7 +4906,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:180](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L180)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:180](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L180)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -4975,7 +4975,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:183](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L183)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:183](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L183)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5045,7 +5045,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:186](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L186)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:186](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L186)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5123,7 +5123,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L189)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L189)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5202,7 +5202,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L193)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L193)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5289,7 +5289,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L196)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:196](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L196)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5377,7 +5377,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L200)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:200](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L200)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5473,7 +5473,7 @@ Name | Type | ▸ **union**<**PA**, **OA**, **FCA**, **FSA**, **PB**, **OB**, **FCB**, **FSB**, **PC**, **OC**, **FCC**, **FSC**, **PD**, **OD**, **FCD**, **FSD**, **PE**, **OE**, **FCE**, **FSE**, **PF**, **OF**, **FCF**, **FSF**, **PG**, **OG**, **FCG**, **FSG**, **PH**, **OH**, **FCH**, **FSH**, **PI**, **OI**, **FCI**, **FSI**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IModelType](interfaces/imodeltype.md)‹PA, OA, FCA, FSA›, `B`: [IModelType](interfaces/imodeltype.md)‹PB, OB, FCB, FSB›, `C`: [IModelType](interfaces/imodeltype.md)‹PC, OC, FCC, FSC›, `D`: [IModelType](interfaces/imodeltype.md)‹PD, OD, FCD, FSD›, `E`: [IModelType](interfaces/imodeltype.md)‹PE, OE, FCE, FSE›, `F`: [IModelType](interfaces/imodeltype.md)‹PF, OF, FCF, FSF›, `G`: [IModelType](interfaces/imodeltype.md)‹PG, OG, FCG, FSG›, `H`: [IModelType](interfaces/imodeltype.md)‹PH, OH, FCH, FSH›, `I`: [IModelType](interfaces/imodeltype.md)‹PI, OI, FCI, FSI›): *ITypeUnion‹ModelCreationType2‹PA, FCA› | ModelCreationType2‹PB, FCB› | ModelCreationType2‹PC, FCC› | ModelCreationType2‹PD, FCD› | ModelCreationType2‹PE, FCE› | ModelCreationType2‹PF, FCF› | ModelCreationType2‹PG, FCG› | ModelCreationType2‹PH, FCH› | ModelCreationType2‹PI, FCI›, ModelSnapshotType2‹PA, FSA› | ModelSnapshotType2‹PB, FSB› | ModelSnapshotType2‹PC, FSC› | ModelSnapshotType2‹PD, FSD› | ModelSnapshotType2‹PE, FSE› | ModelSnapshotType2‹PF, FSF› | ModelSnapshotType2‹PG, FSG› | ModelSnapshotType2‹PH, FSH› | ModelSnapshotType2‹PI, FSI›, ModelInstanceType‹PA, OA› | ModelInstanceType‹PB, OB› | ModelInstanceType‹PC, OC› | ModelInstanceType‹PD, OD› | ModelInstanceType‹PE, OE› | ModelInstanceType‹PF, OF› | ModelInstanceType‹PG, OG› | ModelInstanceType‹PH, OH› | ModelInstanceType‹PI, OI››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:203](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L203)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:203](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L203)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5570,7 +5570,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›): *ITypeUnion‹CA | CB, SA | SB, TA | TB›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:207](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L207)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:207](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L207)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5599,7 +5599,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›): *ITypeUnion‹CA | CB, SA | SB, TA | TB›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L209)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L209)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5629,7 +5629,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›): *ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:211](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L211)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:211](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L211)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5665,7 +5665,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›): *ITypeUnion‹CA | CB | CC, SA | SB | SC, TA | TB | TC›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L213)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L213)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5702,7 +5702,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›): *ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L215)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:215](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L215)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5745,7 +5745,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›): *ITypeUnion‹CA | CB | CC | CD, SA | SB | SC | SD, TA | TB | TC | TD›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:218](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L218)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:218](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L218)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5789,7 +5789,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›): *ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L220)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:220](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L220)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5839,7 +5839,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›): *ITypeUnion‹CA | CB | CC | CD | CE, SA | SB | SC | SD | SE, TA | TB | TC | TD | TE›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:222](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L222)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:222](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L222)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5890,7 +5890,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›): *ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:224](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L224)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:224](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L224)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -5947,7 +5947,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›): *ITypeUnion‹CA | CB | CC | CD | CE | CF, SA | SB | SC | SD | SE | SF, TA | TB | TC | TD | TE | TF›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:226](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L226)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:226](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L226)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6005,7 +6005,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:228](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L228)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:228](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L228)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6069,7 +6069,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG, SA | SB | SC | SD | SE | SF | SG, TA | TB | TC | TD | TE | TF | TG›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:231](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L231)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:231](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L231)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6134,7 +6134,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**, **CH**, **SH**, **TH**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›, `H`: [IType](interfaces/itype.md)‹CH, SH, TH›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:233](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L233)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:233](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L233)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6205,7 +6205,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**, **CH**, **SH**, **TH**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›, `H`: [IType](interfaces/itype.md)‹CH, SH, TH›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH, SA | SB | SC | SD | SE | SF | SG | SH, TA | TB | TC | TD | TE | TF | TG | TH›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:236](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L236)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:236](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L236)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6277,7 +6277,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**, **CH**, **SH**, **TH**, **CI**, **SI**, **TI**>(`A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›, `H`: [IType](interfaces/itype.md)‹CH, SH, TH›, `I`: [IType](interfaces/itype.md)‹CI, SI, TI›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:239](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L239)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:239](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L239)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6355,7 +6355,7 @@ Name | Type | ▸ **union**<**CA**, **SA**, **TA**, **CB**, **SB**, **TB**, **CC**, **SC**, **TC**, **CD**, **SD**, **TD**, **CE**, **SE**, **TE**, **CF**, **SF**, **TF**, **CG**, **SG**, **TG**, **CH**, **SH**, **TH**, **CI**, **SI**, **TI**>(`options`: [UnionOptions](interfaces/unionoptions.md), `A`: [IType](interfaces/itype.md)‹CA, SA, TA›, `B`: [IType](interfaces/itype.md)‹CB, SB, TB›, `C`: [IType](interfaces/itype.md)‹CC, SC, TC›, `D`: [IType](interfaces/itype.md)‹CD, SD, TD›, `E`: [IType](interfaces/itype.md)‹CE, SE, TE›, `F`: [IType](interfaces/itype.md)‹CF, SF, TF›, `G`: [IType](interfaces/itype.md)‹CG, SG, TG›, `H`: [IType](interfaces/itype.md)‹CH, SH, TH›, `I`: [IType](interfaces/itype.md)‹CI, SI, TI›): *ITypeUnion‹CA | CB | CC | CD | CE | CF | CG | CH | CI, SA | SB | SC | SD | SE | SF | SG | SH | SI, TA | TB | TC | TD | TE | TF | TG | TH | TI›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:242](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L242)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:242](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L242)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6434,7 +6434,7 @@ Name | Type | ▸ **union**(...`types`: [IAnyType](interfaces/ianytype.md)[]): *[IAnyType](interfaces/ianytype.md)* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:245](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L245)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:245](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L245)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6448,7 +6448,7 @@ Name | Type | ▸ **union**(`dispatchOrType`: [UnionOptions](interfaces/unionoptions.md) | [IAnyType](interfaces/ianytype.md), ...`otherTypes`: [IAnyType](interfaces/ianytype.md)[]): *[IAnyType](interfaces/ianytype.md)* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:246](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L246)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:246](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L246)* `types.union` - Create a union of multiple types. If the correct type cannot be inferred unambiguously from a snapshot, provide a dispatcher function of the form `(snapshot) => Type`. @@ -6467,7 +6467,7 @@ ___ ▸ **unprotect**(`target`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:299](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L299)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:299](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L299)* By default it is not allowed to directly modify a model. Models can only be modified through actions. However, in some cases you don't care about the advantages (like replayability, traceability, etc) this yields. @@ -6506,7 +6506,7 @@ ___ ▸ **walk**(`target`: IAnyStateTreeNode, `processor`: function): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:787](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L787)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:787](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L787)* Performs a depth first walk through a tree. @@ -6532,178 +6532,178 @@ Name | Type | ### ▪ **types**: *object* -*Defined in [packages/mobx-state-tree/src/types/index.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L34)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:34](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L34)* ### Date • **Date**: *[IType](interfaces/itype.md)‹number | Date, number, Date›* = DatePrimitive -*Defined in [packages/mobx-state-tree/src/types/index.ts:53](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L53)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:53](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L53)* ### array • **array**: *[array](index.md#array)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L55)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:55](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L55)* ### boolean • **boolean**: *[ISimpleType](interfaces/isimpletype.md)‹boolean›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:48](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L48)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:48](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L48)* ### compose • **compose**: *[compose](index.md#compose)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L37)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L37)* ### custom • **custom**: *[custom](index.md#custom)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L38)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L38)* ### enumeration • **enumeration**: *[enumeration](index.md#enumeration)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L35)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L35)* ### finite • **finite**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:52](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L52)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:52](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L52)* ### float • **float**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:51](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L51)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:51](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L51)* ### frozen • **frozen**: *[frozen](index.md#frozen)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L56)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:56](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L56)* ### identifier • **identifier**: *[ISimpleType](interfaces/isimpletype.md)‹string›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:57](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L57)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:57](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L57)* ### identifierNumber • **identifierNumber**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L58)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:58](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L58)* ### integer • **integer**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:50](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L50)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:50](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L50)* ### late • **late**: *[late](index.md#late)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L59)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:59](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L59)* ### lazy • **lazy**: *[lazy](index.md#lazy)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L60)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:60](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L60)* ### literal • **literal**: *[literal](index.md#literal)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L43)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:43](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L43)* ### map • **map**: *[map](index.md#map)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L54)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:54](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L54)* ### maybe • **maybe**: *[maybe](index.md#maybe)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L44)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:44](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L44)* ### maybeNull • **maybeNull**: *[maybeNull](index.md#maybenull)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:45](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L45)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:45](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L45)* ### model • **model**: *[model](index.md#model)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L36)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:36](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L36)* ### null • **null**: *[ISimpleType](interfaces/isimpletype.md)‹null›* = nullType -*Defined in [packages/mobx-state-tree/src/types/index.ts:62](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L62)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:62](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L62)* ### number • **number**: *[ISimpleType](interfaces/isimpletype.md)‹number›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:49](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L49)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:49](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L49)* ### optional • **optional**: *[optional](index.md#optional)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L42)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L42)* ### reference • **reference**: *[reference](index.md#reference)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L39)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L39)* ### refinement • **refinement**: *[refinement](index.md#refinement)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L46)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:46](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L46)* ### safeReference • **safeReference**: *[safeReference](index.md#safereference)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L40)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L40)* ### snapshotProcessor • **snapshotProcessor**: *[snapshotProcessor](index.md#snapshotprocessor)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:63](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L63)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:63](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L63)* ### string • **string**: *[ISimpleType](interfaces/isimpletype.md)‹string›* -*Defined in [packages/mobx-state-tree/src/types/index.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L47)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:47](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L47)* ### undefined • **undefined**: *[ISimpleType](interfaces/isimpletype.md)‹undefined›* = undefinedType -*Defined in [packages/mobx-state-tree/src/types/index.ts:61](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L61)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:61](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L61)* ### union • **union**: *[union](index.md#union)* -*Defined in [packages/mobx-state-tree/src/types/index.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/index.ts#L41)* +*Defined in [packages/mobx-state-tree/src/types/index.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/index.ts#L41)* diff --git a/docs/API/interfaces/customtypeoptions.md b/docs/API/interfaces/customtypeoptions.md index 6596d9591..498d42914 100644 --- a/docs/API/interfaces/customtypeoptions.md +++ b/docs/API/interfaces/customtypeoptions.md @@ -35,7 +35,7 @@ sidebar_label: "CustomTypeOptions" • **name**: *string* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L15)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L15)* Friendly name @@ -45,7 +45,7 @@ Friendly name ▸ **fromSnapshot**(`snapshot`: S, `env?`: any): *T* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L17)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L17)* given a serialized value and environment, how to turn it into the target type @@ -64,7 +64,7 @@ ___ ▸ **getValidationMessage**(`snapshot`: S): *string* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L23)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:23](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L23)* a non empty string is assumed to be a validation error @@ -82,7 +82,7 @@ ___ ▸ **isTargetType**(`value`: T | S): *boolean* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L21)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:21](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L21)* if true, this is a converted value, if false, it's a snapshot @@ -100,7 +100,7 @@ ___ ▸ **toSnapshot**(`value`: T): *S* -*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/custom.ts#L19)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/custom.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/custom.ts#L19)* return the serialization of the current value diff --git a/docs/API/interfaces/functionwithflag.md b/docs/API/interfaces/functionwithflag.md index 3a94add74..144d68fdd 100644 --- a/docs/API/interfaces/functionwithflag.md +++ b/docs/API/interfaces/functionwithflag.md @@ -47,7 +47,7 @@ ___ • **_isFlowAction**? : *undefined | false | true* -*Defined in [packages/mobx-state-tree/src/core/action.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L42)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:42](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L42)* ___ @@ -55,7 +55,7 @@ ___ • **_isMSTAction**? : *undefined | false | true* -*Defined in [packages/mobx-state-tree/src/core/action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L41)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L41)* ___ diff --git a/docs/API/interfaces/iactioncontext.md b/docs/API/interfaces/iactioncontext.md index 8010e204b..a972c5670 100644 --- a/docs/API/interfaces/iactioncontext.md +++ b/docs/API/interfaces/iactioncontext.md @@ -29,7 +29,7 @@ sidebar_label: "IActionContext" • **args**: *any[]* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L20)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L20)* Event arguments in an array (action arguments for actions) @@ -39,7 +39,7 @@ ___ • **context**: *IAnyStateTreeNode* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L15)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L15)* Event context (node where the action was invoked) @@ -49,7 +49,7 @@ ___ • **id**: *number* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L9)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L9)* Event unique id @@ -59,7 +59,7 @@ ___ • **name**: *string* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L6)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L6)* Event name (action name for actions) @@ -69,7 +69,7 @@ ___ • **parentActionEvent**: *[IMiddlewareEvent](imiddlewareevent.md) | undefined* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L12)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L12)* Parent action event object @@ -79,6 +79,6 @@ ___ • **tree**: *IAnyStateTreeNode* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L17)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L17)* Event tree (root node of the node where the action was invoked) diff --git a/docs/API/interfaces/iactionrecorder.md b/docs/API/interfaces/iactionrecorder.md index 7a4f321d1..25c293180 100644 --- a/docs/API/interfaces/iactionrecorder.md +++ b/docs/API/interfaces/iactionrecorder.md @@ -29,7 +29,7 @@ sidebar_label: "IActionRecorder" • **actions**: *ReadonlyArray‹[ISerializedActionCall](iserializedactioncall.md)›* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L37)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L37)* ___ @@ -37,7 +37,7 @@ ___ • **recording**: *boolean* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L38)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:38](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L38)* ## Methods @@ -45,7 +45,7 @@ ___ ▸ **replay**(`target`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L41)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:41](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L41)* **Parameters:** @@ -61,7 +61,7 @@ ___ ▸ **resume**(): *void* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L40)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:40](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L40)* **Returns:** *void* @@ -71,6 +71,6 @@ ___ ▸ **stop**(): *void* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L39)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:39](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L39)* **Returns:** *void* diff --git a/docs/API/interfaces/iactiontrackingmiddleware2call.md b/docs/API/interfaces/iactiontrackingmiddleware2call.md index ee59b445d..b61ec5761 100644 --- a/docs/API/interfaces/iactiontrackingmiddleware2call.md +++ b/docs/API/interfaces/iactiontrackingmiddleware2call.md @@ -29,7 +29,7 @@ sidebar_label: "IActionTrackingMiddleware2Call" • **env**: *TEnv | undefined* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L6)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L6)* ___ @@ -37,4 +37,4 @@ ___ • **parentCall**? : *[IActionTrackingMiddleware2Call](iactiontrackingmiddleware2call.md)‹TEnv›* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L7)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L7)* diff --git a/docs/API/interfaces/iactiontrackingmiddleware2hooks.md b/docs/API/interfaces/iactiontrackingmiddleware2hooks.md index 4e023c767..05e624ac0 100644 --- a/docs/API/interfaces/iactiontrackingmiddleware2hooks.md +++ b/docs/API/interfaces/iactiontrackingmiddleware2hooks.md @@ -28,7 +28,7 @@ sidebar_label: "IActionTrackingMiddleware2Hooks" • **filter**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L11)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L11)* ___ @@ -36,7 +36,7 @@ ___ • **onFinish**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L13)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L13)* #### Type declaration: @@ -55,7 +55,7 @@ ___ • **onStart**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L12)* +*Defined in [packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/createActionTrackingMiddleware2.ts#L12)* #### Type declaration: diff --git a/docs/API/interfaces/iactiontrackingmiddlewarehooks.md b/docs/API/interfaces/iactiontrackingmiddlewarehooks.md index 21c6b7156..282a727de 100644 --- a/docs/API/interfaces/iactiontrackingmiddlewarehooks.md +++ b/docs/API/interfaces/iactiontrackingmiddlewarehooks.md @@ -31,7 +31,7 @@ sidebar_label: "IActionTrackingMiddlewareHooks" • **filter**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L6)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L6)* ___ @@ -39,7 +39,7 @@ ___ • **onFail**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L11)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:11](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L11)* #### Type declaration: @@ -59,7 +59,7 @@ ___ • **onResume**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L8)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L8)* #### Type declaration: @@ -78,7 +78,7 @@ ___ • **onStart**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L7)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:7](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L7)* #### Type declaration: @@ -96,7 +96,7 @@ ___ • **onSuccess**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L10)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L10)* #### Type declaration: @@ -116,7 +116,7 @@ ___ • **onSuspend**: *function* -*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L9)* +*Defined in [packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/create-action-tracking-middleware.ts#L9)* #### Type declaration: diff --git a/docs/API/interfaces/ianycomplextype.md b/docs/API/interfaces/ianycomplextype.md index a00b65d7e..ac6828ba9 100644 --- a/docs/API/interfaces/ianycomplextype.md +++ b/docs/API/interfaces/ianycomplextype.md @@ -36,7 +36,7 @@ Any kind of complex type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -48,7 +48,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -60,7 +60,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -83,7 +83,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -97,7 +97,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -119,7 +119,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ianymodeltype.md b/docs/API/interfaces/ianymodeltype.md index dedeb2a5b..0e73539b5 100644 --- a/docs/API/interfaces/ianymodeltype.md +++ b/docs/API/interfaces/ianymodeltype.md @@ -45,7 +45,7 @@ Any model type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -57,7 +57,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -69,7 +69,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[properties](imodeltype.md#properties)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L187)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L187)* ## Methods @@ -79,7 +79,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[actions](imodeltype.md#actions)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:201](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L201)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:201](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L201)* **Type parameters:** @@ -107,7 +107,7 @@ ___ *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -130,7 +130,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -144,7 +144,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[extend](imodeltype.md#extend)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L209)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L209)* **Type parameters:** @@ -176,7 +176,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -198,7 +198,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[named](imodeltype.md#named)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L189)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L189)* **Parameters:** @@ -216,7 +216,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[postProcessSnapshot](imodeltype.md#postprocesssnapshot)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:217](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L217)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:217](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L217)* **Type parameters:** @@ -244,7 +244,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[preProcessSnapshot](imodeltype.md#preprocesssnapshot)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L213)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L213)* **Type parameters:** @@ -272,7 +272,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[props](imodeltype.md#props)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L193)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L193)* **Type parameters:** @@ -294,7 +294,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. @@ -317,7 +317,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[views](imodeltype.md#views)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:197](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L197)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:197](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L197)* **Type parameters:** @@ -345,7 +345,7 @@ ___ *Inherited from [IModelType](imodeltype.md).[volatile](imodeltype.md#volatile)* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:205](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L205)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:205](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L205)* **Type parameters:** diff --git a/docs/API/interfaces/ianytype.md b/docs/API/interfaces/ianytype.md index 17d1f1052..598c0525f 100644 --- a/docs/API/interfaces/ianytype.md +++ b/docs/API/interfaces/ianytype.md @@ -36,7 +36,7 @@ Any kind of type. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -48,7 +48,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -60,7 +60,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -83,7 +83,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -97,7 +97,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -119,7 +119,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ihooks.md b/docs/API/interfaces/ihooks.md index 8b6ecef36..1f598b9d2 100644 --- a/docs/API/interfaces/ihooks.md +++ b/docs/API/interfaces/ihooks.md @@ -25,7 +25,7 @@ sidebar_label: "IHooks" • **[Hook.afterAttach]**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/Hook.ts#L14)* +*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/Hook.ts#L14)* ___ @@ -33,7 +33,7 @@ ___ • **[Hook.afterCreate]**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/Hook.ts#L13)* +*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:13](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/Hook.ts#L13)* ___ @@ -41,7 +41,7 @@ ___ • **[Hook.beforeDestroy]**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/Hook.ts#L16)* +*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:16](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/Hook.ts#L16)* ___ @@ -49,4 +49,4 @@ ___ • **[Hook.beforeDetach]**? : *undefined | function* -*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/node/Hook.ts#L15)* +*Defined in [packages/mobx-state-tree/src/core/node/Hook.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/node/Hook.ts#L15)* diff --git a/docs/API/interfaces/ijsonpatch.md b/docs/API/interfaces/ijsonpatch.md index 743763252..8e5e19fe5 100644 --- a/docs/API/interfaces/ijsonpatch.md +++ b/docs/API/interfaces/ijsonpatch.md @@ -29,7 +29,7 @@ http://jsonpatch.com/ • **op**: *"replace" | "add" | "remove"* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L8)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L8)* ___ @@ -37,7 +37,7 @@ ___ • **path**: *string* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L9)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L9)* ___ @@ -45,4 +45,4 @@ ___ • **value**? : *any* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L10)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L10)* diff --git a/docs/API/interfaces/imiddlewareevent.md b/docs/API/interfaces/imiddlewareevent.md index dbaae567d..306be5e59 100644 --- a/docs/API/interfaces/imiddlewareevent.md +++ b/docs/API/interfaces/imiddlewareevent.md @@ -34,7 +34,7 @@ sidebar_label: "IMiddlewareEvent" • **allParentIds**: *number[]* -*Defined in [packages/mobx-state-tree/src/core/action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L37)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:37](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L37)* Id of all events, from root until current (excluding current) @@ -46,7 +46,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[args](iactioncontext.md#args)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L20)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:20](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L20)* Event arguments in an array (action arguments for actions) @@ -58,7 +58,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[context](iactioncontext.md#context)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L15)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:15](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L15)* Event context (node where the action was invoked) @@ -70,7 +70,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[id](iactioncontext.md#id)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L9)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L9)* Event unique id @@ -82,7 +82,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[name](iactioncontext.md#name)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L6)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:6](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L6)* Event name (action name for actions) @@ -94,7 +94,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[parentActionEvent](iactioncontext.md#parentactionevent)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L12)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:12](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L12)* Parent action event object @@ -104,7 +104,7 @@ ___ • **parentEvent**: *[IMiddlewareEvent](imiddlewareevent.md) | undefined* -*Defined in [packages/mobx-state-tree/src/core/action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L32)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L32)* Parent event object @@ -114,7 +114,7 @@ ___ • **parentId**: *number* -*Defined in [packages/mobx-state-tree/src/core/action.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L30)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L30)* Parent event unique id @@ -124,7 +124,7 @@ ___ • **rootId**: *number* -*Defined in [packages/mobx-state-tree/src/core/action.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L35)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:35](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L35)* Root event unique id @@ -136,7 +136,7 @@ ___ *Inherited from [IActionContext](iactioncontext.md).[tree](iactioncontext.md#tree)* -*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/actionContext.ts#L17)* +*Defined in [packages/mobx-state-tree/src/core/actionContext.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/actionContext.ts#L17)* Event tree (root node of the node where the action was invoked) @@ -146,6 +146,6 @@ ___ • **type**: *[IMiddlewareEventType](../index.md#imiddlewareeventtype)* -*Defined in [packages/mobx-state-tree/src/core/action.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/action.ts#L27)* +*Defined in [packages/mobx-state-tree/src/core/action.ts:27](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/action.ts#L27)* Event type diff --git a/docs/API/interfaces/imodelreflectiondata.md b/docs/API/interfaces/imodelreflectiondata.md index 402e24015..bd690abb2 100644 --- a/docs/API/interfaces/imodelreflectiondata.md +++ b/docs/API/interfaces/imodelreflectiondata.md @@ -29,7 +29,7 @@ sidebar_label: "IModelReflectionData" • **actions**: *string[]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:834](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L834)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:834](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L834)* ___ @@ -37,7 +37,7 @@ ___ • **flowActions**: *string[]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:837](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L837)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:837](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L837)* ___ @@ -47,7 +47,7 @@ ___ *Inherited from [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md).[name](imodelreflectionpropertiesdata.md#name)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:804](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L804)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:804](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L804)* ___ @@ -57,7 +57,7 @@ ___ *Inherited from [IModelReflectionPropertiesData](imodelreflectionpropertiesdata.md).[properties](imodelreflectionpropertiesdata.md#properties)* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L805)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L805)* #### Type declaration: @@ -69,7 +69,7 @@ ___ • **views**: *string[]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:835](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L835)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:835](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L835)* ___ @@ -77,4 +77,4 @@ ___ • **volatile**: *string[]* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:836](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L836)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:836](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L836)* diff --git a/docs/API/interfaces/imodelreflectionpropertiesdata.md b/docs/API/interfaces/imodelreflectionpropertiesdata.md index 2a5d3bbae..088d4b941 100644 --- a/docs/API/interfaces/imodelreflectionpropertiesdata.md +++ b/docs/API/interfaces/imodelreflectionpropertiesdata.md @@ -25,7 +25,7 @@ sidebar_label: "IModelReflectionPropertiesData" • **name**: *string* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:804](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L804)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:804](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L804)* ___ @@ -33,7 +33,7 @@ ___ • **properties**: *object* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L805)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:805](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L805)* #### Type declaration: diff --git a/docs/API/interfaces/imodeltype.md b/docs/API/interfaces/imodeltype.md index e7bc31b39..d0f6ca356 100644 --- a/docs/API/interfaces/imodeltype.md +++ b/docs/API/interfaces/imodeltype.md @@ -55,7 +55,7 @@ sidebar_label: "IModelType" *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -67,7 +67,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -77,7 +77,7 @@ ___ • **properties**: *PROPS* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L187)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:187](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L187)* ## Methods @@ -85,7 +85,7 @@ ___ ▸ **actions**<**A**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & A, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:201](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L201)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:201](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L201)* **Type parameters:** @@ -113,7 +113,7 @@ ___ *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -136,7 +136,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -148,7 +148,7 @@ ___ ▸ **extend**<**A**, **V**, **VS**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & A & V & VS, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L209)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:209](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L209)* **Type parameters:** @@ -180,7 +180,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -200,7 +200,7 @@ ___ ▸ **named**(`newName`: string): *[IModelType](imodeltype.md)‹PROPS, OTHERS, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L189)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:189](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L189)* **Parameters:** @@ -216,7 +216,7 @@ ___ ▸ **postProcessSnapshot**<**NewS**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS, CustomC, NewS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:217](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L217)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:217](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L217)* **Type parameters:** @@ -242,7 +242,7 @@ ___ ▸ **preProcessSnapshot**<**NewC**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS, NewC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L213)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:213](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L213)* **Type parameters:** @@ -268,7 +268,7 @@ ___ ▸ **props**<**PROPS2**>(`props`: PROPS2): *[IModelType](imodeltype.md)‹PROPS & ModelPropertiesDeclarationToProperties‹PROPS2›, OTHERS, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L193)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:193](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L193)* **Type parameters:** @@ -290,7 +290,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. @@ -311,7 +311,7 @@ ___ ▸ **views**<**V**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & V, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:197](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L197)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:197](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L197)* **Type parameters:** @@ -337,7 +337,7 @@ ___ ▸ **volatile**<**TP**>(`fn`: function): *[IModelType](imodeltype.md)‹PROPS, OTHERS & TP, CustomC, CustomS›* -*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:205](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/complex-types/model.ts#L205)* +*Defined in [packages/mobx-state-tree/src/types/complex-types/model.ts:205](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/complex-types/model.ts#L205)* **Type parameters:** diff --git a/docs/API/interfaces/ipatchrecorder.md b/docs/API/interfaces/ipatchrecorder.md index 6a648723b..847a3cd80 100644 --- a/docs/API/interfaces/ipatchrecorder.md +++ b/docs/API/interfaces/ipatchrecorder.md @@ -32,7 +32,7 @@ sidebar_label: "IPatchRecorder" • **inversePatches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:138](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L138)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:138](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L138)* ___ @@ -40,7 +40,7 @@ ___ • **patches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:137](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L137)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:137](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L137)* ___ @@ -48,7 +48,7 @@ ___ • **recording**: *boolean* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:140](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L140)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:140](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L140)* ___ @@ -56,7 +56,7 @@ ___ • **reversedInversePatches**: *ReadonlyArray‹[IJsonPatch](ijsonpatch.md)›* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:139](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L139)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:139](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L139)* ## Methods @@ -64,7 +64,7 @@ ___ ▸ **replay**(`target?`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:143](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L143)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:143](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L143)* **Parameters:** @@ -80,7 +80,7 @@ ___ ▸ **resume**(): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L142)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:142](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L142)* **Returns:** *void* @@ -90,7 +90,7 @@ ___ ▸ **stop**(): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L141)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:141](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L141)* **Returns:** *void* @@ -100,7 +100,7 @@ ___ ▸ **undo**(`target?`: IAnyStateTreeNode): *void* -*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:144](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/mst-operations.ts#L144)* +*Defined in [packages/mobx-state-tree/src/core/mst-operations.ts:144](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/mst-operations.ts#L144)* **Parameters:** diff --git a/docs/API/interfaces/ireversiblejsonpatch.md b/docs/API/interfaces/ireversiblejsonpatch.md index 4d30aa231..cd85e7647 100644 --- a/docs/API/interfaces/ireversiblejsonpatch.md +++ b/docs/API/interfaces/ireversiblejsonpatch.md @@ -27,7 +27,7 @@ sidebar_label: "IReversibleJsonPatch" • **oldValue**: *any* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L14)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:14](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L14)* ___ @@ -37,7 +37,7 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[op](ijsonpatch.md#op)* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L8)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:8](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L8)* ___ @@ -47,7 +47,7 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[path](ijsonpatch.md#path)* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L9)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:9](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L9)* ___ @@ -57,4 +57,4 @@ ___ *Inherited from [IJsonPatch](ijsonpatch.md).[value](ijsonpatch.md#optional-value)* -*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/json-patch.ts#L10)* +*Defined in [packages/mobx-state-tree/src/core/json-patch.ts:10](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/json-patch.ts#L10)* diff --git a/docs/API/interfaces/iserializedactioncall.md b/docs/API/interfaces/iserializedactioncall.md index 031658ffc..07cdc6790 100644 --- a/docs/API/interfaces/iserializedactioncall.md +++ b/docs/API/interfaces/iserializedactioncall.md @@ -24,7 +24,7 @@ sidebar_label: "ISerializedActionCall" • **args**? : *any[]* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:33](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L33)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:33](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L33)* ___ @@ -32,7 +32,7 @@ ___ • **name**: *string* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L31)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L31)* ___ @@ -40,4 +40,4 @@ ___ • **path**? : *undefined | string* -*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/middlewares/on-action.ts#L32)* +*Defined in [packages/mobx-state-tree/src/middlewares/on-action.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/middlewares/on-action.ts#L32)* diff --git a/docs/API/interfaces/isimpletype.md b/docs/API/interfaces/isimpletype.md index 867af283b..1f0a753fc 100644 --- a/docs/API/interfaces/isimpletype.md +++ b/docs/API/interfaces/isimpletype.md @@ -40,7 +40,7 @@ A simple type, this is, a type where the instance and the snapshot representatio *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -52,7 +52,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -64,7 +64,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -87,7 +87,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -101,7 +101,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -123,7 +123,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/isnapshotprocessor.md b/docs/API/interfaces/isnapshotprocessor.md index fefd89239..fd5c314c8 100644 --- a/docs/API/interfaces/isnapshotprocessor.md +++ b/docs/API/interfaces/isnapshotprocessor.md @@ -44,7 +44,7 @@ A type that has its snapshots processed. *Inherited from [IType](itype.md).[identifierAttribute](itype.md#optional-identifierattribute)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -56,7 +56,7 @@ ___ *Inherited from [IType](itype.md).[name](itype.md#name)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -68,7 +68,7 @@ Friendly type name. *Inherited from [IType](itype.md).[create](itype.md#create)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -91,7 +91,7 @@ ___ *Inherited from [IType](itype.md).[describe](itype.md#describe)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -105,7 +105,7 @@ ___ *Inherited from [IType](itype.md).[is](itype.md#is)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -127,7 +127,7 @@ ___ *Inherited from [IType](itype.md).[validate](itype.md#validate)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/isnapshotprocessors.md b/docs/API/interfaces/isnapshotprocessors.md index c54308ad9..1b96dde31 100644 --- a/docs/API/interfaces/isnapshotprocessors.md +++ b/docs/API/interfaces/isnapshotprocessors.md @@ -35,7 +35,7 @@ Snapshot processors. ▸ **postProcessor**(`snapshot`: S): *CustomS* -*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L212)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:212](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L212)* Function that transforms an output snapshot. @@ -53,7 +53,7 @@ ___ ▸ **preProcessor**(`snapshot`: CustomC): *C* -*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:207](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L207)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts:207](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/snapshotProcessor.ts#L207)* Function that transforms an input snapshot. diff --git a/docs/API/interfaces/itype.md b/docs/API/interfaces/itype.md index 912696859..c9280b6aa 100644 --- a/docs/API/interfaces/itype.md +++ b/docs/API/interfaces/itype.md @@ -50,7 +50,7 @@ A type, either complex or simple. • **identifierAttribute**? : *undefined | string* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L89)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:89](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L89)* Name of the identifier attribute or null if none. @@ -60,7 +60,7 @@ ___ • **name**: *string* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L84)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:84](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L84)* Friendly type name. @@ -70,7 +70,7 @@ Friendly type name. ▸ **create**(`snapshot?`: [C](undefined), `env?`: any): *this["Type"]* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L96)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:96](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L96)* Creates an instance for the type given an snapshot input. @@ -91,7 +91,7 @@ ___ ▸ **describe**(): *string* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L118)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:118](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L118)* Gets the textual representation of the type as a string. @@ -103,7 +103,7 @@ ___ ▸ **is**(`thing`: any): *thing is C | this["Type"]* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L104)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:104](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L104)* Checks if a given snapshot / instance is of the given type. @@ -123,7 +123,7 @@ ___ ▸ **validate**(`thing`: C, `context`: [IValidationContext](../index.md#ivalidationcontext)): *[IValidationResult](../index.md#ivalidationresult)* -*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type.ts#L113)* +*Defined in [packages/mobx-state-tree/src/core/type/type.ts:113](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type.ts#L113)* Run's the type's typechecker on the given value with the given validation context. diff --git a/docs/API/interfaces/ivalidationcontextentry.md b/docs/API/interfaces/ivalidationcontextentry.md index 24cd85d96..f757df2cc 100644 --- a/docs/API/interfaces/ivalidationcontextentry.md +++ b/docs/API/interfaces/ivalidationcontextentry.md @@ -25,7 +25,7 @@ Validation context entry, this is, where the validation should run against which • **path**: *string* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L17)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:17](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L17)* Subpath where the validation should be run, or an empty string to validate it all @@ -35,6 +35,6 @@ ___ • **type**: *[IAnyType](ianytype.md)* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L19)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:19](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L19)* Type to validate the subpath against diff --git a/docs/API/interfaces/ivalidationerror.md b/docs/API/interfaces/ivalidationerror.md index 11f7b2ec0..c4896942f 100644 --- a/docs/API/interfaces/ivalidationerror.md +++ b/docs/API/interfaces/ivalidationerror.md @@ -26,7 +26,7 @@ Type validation error • **context**: *[IValidationContext](../index.md#ivalidationcontext)* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L28)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:28](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L28)* Validation context @@ -36,7 +36,7 @@ ___ • **message**? : *undefined | string* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L32)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:32](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L32)* Error message @@ -46,6 +46,6 @@ ___ • **value**: *any* -*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/core/type/type-checker.ts#L30)* +*Defined in [packages/mobx-state-tree/src/core/type/type-checker.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/core/type/type-checker.ts#L30)* Value that was being validated, either a snapshot or an instance diff --git a/docs/API/interfaces/referenceoptionsgetset.md b/docs/API/interfaces/referenceoptionsgetset.md index 7a16d2d1f..09fb10d59 100644 --- a/docs/API/interfaces/referenceoptionsgetset.md +++ b/docs/API/interfaces/referenceoptionsgetset.md @@ -27,7 +27,7 @@ sidebar_label: "ReferenceOptionsGetSet" ▸ **get**(`identifier`: [ReferenceIdentifier](../index.md#referenceidentifier), `parent`: IAnyStateTreeNode | null): *ReferenceT‹IT›* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:464](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L464)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:464](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L464)* **Parameters:** @@ -44,7 +44,7 @@ ___ ▸ **set**(`value`: ReferenceT‹IT›, `parent`: IAnyStateTreeNode | null): *[ReferenceIdentifier](../index.md#referenceidentifier)* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:465](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L465)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:465](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L465)* **Parameters:** diff --git a/docs/API/interfaces/referenceoptionsoninvalidated.md b/docs/API/interfaces/referenceoptionsoninvalidated.md index 1410e0910..840b5ee23 100644 --- a/docs/API/interfaces/referenceoptionsoninvalidated.md +++ b/docs/API/interfaces/referenceoptionsoninvalidated.md @@ -26,4 +26,4 @@ sidebar_label: "ReferenceOptionsOnInvalidated" • **onInvalidated**: *[OnReferenceInvalidated](../index.md#onreferenceinvalidated)‹ReferenceT‹IT››* -*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:470](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/reference.ts#L470)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/reference.ts:470](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/reference.ts#L470)* diff --git a/docs/API/interfaces/unionoptions.md b/docs/API/interfaces/unionoptions.md index 0723ab03e..a02c047fe 100644 --- a/docs/API/interfaces/unionoptions.md +++ b/docs/API/interfaces/unionoptions.md @@ -23,7 +23,7 @@ sidebar_label: "UnionOptions" • **dispatcher**? : *[ITypeDispatcher](../index.md#itypedispatcher)* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L31)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:31](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L31)* ___ @@ -31,4 +31,4 @@ ___ • **eager**? : *undefined | false | true* -*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/46151874/packages/mobx-state-tree/src/types/utility-types/union.ts#L30)* +*Defined in [packages/mobx-state-tree/src/types/utility-types/union.ts:30](https://github.com/mobxjs/mobx-state-tree/blob/707cb5de/packages/mobx-state-tree/src/types/utility-types/union.ts#L30)*