From b29b0ea0baa52576e0e1d65e8cf7f6801c95b6d9 Mon Sep 17 00:00:00 2001 From: Michel Weststrate Date: Tue, 15 Aug 2017 21:28:37 +0200 Subject: [PATCH] Fix syntax issue in markdown --- README.md | 84 +++++++++++++++++++++++++++---------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 87b8b90b8..71a704708 100644 --- a/README.md +++ b/README.md @@ -744,48 +744,48 @@ See the [full API docs](https://github.com/mobxjs/mobx-state-tree/blob/master/AP | signature | | | ---- | --- | -| `[addDisposer(node, () => void)`](API.md#adddisposer) | Function to be invoked whenever the target node is to be destroyed | -| `[addMiddleware(node, middleware: (actionDescription, next) => any)`](API.md#addmiddleware) | Attaches middleware to a node. See [actions](#actions). Returns disposer. | -| `[applyAction(node, actionDescription)`](API.md#applyaction) | Replays an action on the targeted node | -| `[applyPatch(node, jsonPatch)`](API.md#applypatch) | Applies a JSON patch, or array of patches, to a node in the tree | -| `[applySnapshot(node, snapshot)`](API.md#applysnapshot) | Updates a node with the given snapshot | -| `[asReduxStore(node)`](API.md#asreduxstore) | Wraps a node in a Redux-store compatible API | -| `[clone(node, keepEnvironment?: true \| false \| newEnvironment)`](API.md#clone) | Creates a full clone of the given node. By default preserves the same environment | -| `[connectReduxDevtools(removeDevModule, node)`](API.md#connectreduxdevtools) | Connects a node to the Redux development tools [example](https://github.com/mobxjs/mobx-state-tree/blob/b01fe97d427ca664f7ecc99349d10e58d08d2d98/examples/redux-todomvc/src/index.js) | -| `[destroy(node)`](API.md#destroy) | Kills `node`, making it unusable. Removes it from any parent in the process | -| `[detach(node)`](API.md#detach) | Removes `node` from its current parent, and lets it live on as standalone tree | -| `[getChildType(node, property?)`](API.md#getchildtype) | Returns the declared type of the given `property` of `node`. For arrays and maps `property` can be omitted as they all have the same type | -| `[getEnv(node)`](API.md#getenv) | Returns the environment of `node`, see [environments](#environments) | -| `[getParent(node, depth=1)`](API.md#getparent) | Returns the intermediate parent of the `node`, or a higher one if `depth > 1` | -| `[getPath(node)`](API.md#getpath) | Returns the path of `node` in the tree | -| `[getPathParts(node)`](API.md#getpathparts) | Returns the path of `node` in the tree, unescaped as separate parts | -| `[getRelativePath(base, target)`](API.md#getrelativepath) | Returns the short path, which one could use to walk from node `base` to node `target`, assuming they are in the same tree. Up is represented as `../` | -| `[getRoot(node)`](API.md#getroot) | Returns the root element of the tree containing `node` | -| `[getSnapshot(node)`](API.md#getsnapshot) | Returns the snapshot of the `node`. See [snapshots](#snapshots) | -| `[getType(node)`](API.md#gettype) | Returns the type of `node` | -| `[hasParent(node, depth=1)`](API.md#hasparent) | Returns `true` if `node` has a parent at `depth` | -| `[isAlive(node)`](API.md#isalive) | Returns `true` if `node` is alive | -| `[isStateTreeNode(value)`](API.md#isstatetreenode) | Returns `true` if `value` is a node of a mobx-state-tree | -| `[isProtected(value)`](API.md#isprotected) | Returns `true` if the given node is protected, see [actions](#actions) | -| `[isRoot(node)`](API.md#isroot) | Returns true if `node` has no parents | -| `[joinJsonPath(parts)`](API.md#joinjsonpath) | Joins and escapes the given path `parts` into a JSON path | -| `[onAction(node, (actionDescription) => void)`](API.md#onaction) | A built-in middleware that calls the provided callback with an action description upon each invocation. Returns disposer | -| `[onPatch(node, (patch) => void)`](API.md#onpatch) | Attach a JSONPatch listener, that is invoked for each change in the tree. Returns disposer | -| `[onSnapshot(node, (snapshot) => void)`](API.md#onsnapshot) | Attach a snapshot listener, that is invoked for each change in the tree. Returns disposer | -| `[process(generator)`](API.md#process) | creates an asynchronous process based on a generator function | -| `[protect(node)`](API.md#protect) | Protects an unprotected tree against modifications from outside actions | -| `[recordActions(node)`](API.md#recordactions) | Creates a recorder that listens to all actions in `node`. Call `.stop()` on the recorder to stop this, and `.replay(target)` to replay the recorded actions on another tree | -| `[recordPatches(node)`](API.md#recordpatches) | Creates a recorder that listens to all patches emitted by the node. Call `.stop()` on the recorder to stop this, and `.replay(target)` to replay the recorded patches on another tree | -| `[resolve(node, path)`](API.md#resolve) | Resolves a `path` (json path) relatively to the given `node` | -| `[revertPatch(node, jsonPatch)`](API.md#revertpatch) | Inverse applies a JSON patch or array of patches to `node` | -| `[splitJsonPath(path)`](API.md#splitjsonpath) | Splits and unescapes the given JSON `path` into path parts | -| `[tryResolve(node, path)`](API.md#tryresolve) | Like `resolve`, but just returns `null` if resolving fails at any point in the path | -| `[unprotect(node)`](API.md#unprotect) | Unprotects `node`, making it possible to directly modify any value in the subtree, without actions | -| `[walk(startNode, (node) => void)`](API.md#walk) | Performs a depth-first walk through a tree | -| `[escapeJsonPath(path)`](API.md#escapejsonpath) | escape special characters in an identifier, according to http://tools.ietf.org/html/rfc6901 | -| `[unescapeJsonPath(path)`](API.md#unescapejsonpath) | escape special characters in an identifier, according to http://tools.ietf.org/html/rfc6901 | -| `[resolveIdentifier(type, target, identifier)`](API.md#resolveidentifier) | resolves an identifier of a given type in a model tree | -| `[resolvePath(target, path)`](API.md#resolvepath) | resolves a JSON path, starting at the specified target | +| [`addDisposer(node, () => void)`](API.md#adddisposer) | Function to be invoked whenever the target node is to be destroyed | +| [`addMiddleware(node, middleware: (actionDescription, next) => any)`](API.md#addmiddleware) | Attaches middleware to a node. See [actions](#actions). Returns disposer. | +| [`applyAction(node, actionDescription)`](API.md#applyaction) | Replays an action on the targeted node | +| [`applyPatch(node, jsonPatch)`](API.md#applypatch) | Applies a JSON patch, or array of patches, to a node in the tree | +| [`applySnapshot(node, snapshot)`](API.md#applysnapshot) | Updates a node with the given snapshot | +| [`asReduxStore(node)`](API.md#asreduxstore) | Wraps a node in a Redux-store compatible API | +| [`clone(node, keepEnvironment?: true \| false \| newEnvironment)`](API.md#clone) | Creates a full clone of the given node. By default preserves the same environment | +| [`connectReduxDevtools(removeDevModule, node)`](API.md#connectreduxdevtools) | Connects a node to the Redux development tools [example](https://github.com/mobxjs/mobx-state-tree/blob/b01fe97d427ca664f7ecc99349d10e58d08d2d98/examples/redux-todomvc/src/index.js) | +| [`destroy(node)`](API.md#destroy) | Kills `node`, making it unusable. Removes it from any parent in the process | +| [`detach(node)`](API.md#detach) | Removes `node` from its current parent, and lets it live on as standalone tree | +| [`getChildType(node, property?)`](API.md#getchildtype) | Returns the declared type of the given `property` of `node`. For arrays and maps `property` can be omitted as they all have the same type | +| [`getEnv(node)`](API.md#getenv) | Returns the environment of `node`, see [environments](#environments) | +| [`getParent(node, depth=1)`](API.md#getparent) | Returns the intermediate parent of the `node`, or a higher one if `depth > 1` | +| [`getPath(node)`](API.md#getpath) | Returns the path of `node` in the tree | +| [`getPathParts(node)`](API.md#getpathparts) | Returns the path of `node` in the tree, unescaped as separate parts | +| [`getRelativePath(base, target)`](API.md#getrelativepath) | Returns the short path, which one could use to walk from node `base` to node `target`, assuming they are in the same tree. Up is represented as `../` | +| [`getRoot(node)`](API.md#getroot) | Returns the root element of the tree containing `node` | +| [`getSnapshot(node)`](API.md#getsnapshot) | Returns the snapshot of the `node`. See [snapshots](#snapshots) | +| [`getType(node)`](API.md#gettype) | Returns the type of `node` | +| [`hasParent(node, depth=1)`](API.md#hasparent) | Returns `true` if `node` has a parent at `depth` | +| [`isAlive(node)`](API.md#isalive) | Returns `true` if `node` is alive | +| [`isStateTreeNode(value)`](API.md#isstatetreenode) | Returns `true` if `value` is a node of a mobx-state-tree | +| [`isProtected(value)`](API.md#isprotected) | Returns `true` if the given node is protected, see [actions](#actions) | +| [`isRoot(node)`](API.md#isroot) | Returns true if `node` has no parents | +| [`joinJsonPath(parts)`](API.md#joinjsonpath) | Joins and escapes the given path `parts` into a JSON path | +| [`onAction(node, (actionDescription) => void)`](API.md#onaction) | A built-in middleware that calls the provided callback with an action description upon each invocation. Returns disposer | +| [`onPatch(node, (patch) => void)`](API.md#onpatch) | Attach a JSONPatch listener, that is invoked for each change in the tree. Returns disposer | +| [`onSnapshot(node, (snapshot) => void)`](API.md#onsnapshot) | Attach a snapshot listener, that is invoked for each change in the tree. Returns disposer | +| [`process(generator)`](API.md#process) | creates an asynchronous process based on a generator function | +| [`protect(node)`](API.md#protect) | Protects an unprotected tree against modifications from outside actions | +| [`recordActions(node)`](API.md#recordactions) | Creates a recorder that listens to all actions in `node`. Call `.stop()` on the recorder to stop this, and `.replay(target)` to replay the recorded actions on another tree | +| [`recordPatches(node)`](API.md#recordpatches) | Creates a recorder that listens to all patches emitted by the node. Call `.stop()` on the recorder to stop this, and `.replay(target)` to replay the recorded patches on another tree | +| [`resolve(node, path)`](API.md#resolve) | Resolves a `path` (json path) relatively to the given `node` | +| [`revertPatch(node, jsonPatch)`](API.md#revertpatch) | Inverse applies a JSON patch or array of patches to `node` | +| [`splitJsonPath(path)`](API.md#splitjsonpath) | Splits and unescapes the given JSON `path` into path parts | +| [`tryResolve(node, path)`](API.md#tryresolve) | Like `resolve`, but just returns `null` if resolving fails at any point in the path | +| [`unprotect(node)`](API.md#unprotect) | Unprotects `node`, making it possible to directly modify any value in the subtree, without actions | +| [`walk(startNode, (node) => void)`](API.md#walk) | Performs a depth-first walk through a tree | +| [`escapeJsonPath(path)`](API.md#escapejsonpath) | escape special characters in an identifier, according to http://tools.ietf.org/html/rfc6901 | +| [`unescapeJsonPath(path)`](API.md#unescapejsonpath) | escape special characters in an identifier, according to http://tools.ietf.org/html/rfc6901 | +| [`resolveIdentifier(type, target, identifier)`](API.md#resolveidentifier) | resolves an identifier of a given type in a model tree | +| [`resolvePath(target, path)`](API.md#resolvepath) | resolves a JSON path, starting at the specified target | A _disposer_ is a function that cancels the effect it was created for.