uhhm/buuh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix app.start()

Browse Source
This commit is contained in:
Yoshua Wuyts
2016-05-24 05:50:14 +09:00
parent 6493c85979
commit fdfd866930
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -2
View File
@@ -465,9 +465,12 @@ state object. When calling `.toString()` instead of `.start()`, all calls to
`send()` are disabled, and `subscriptions`, `effects` and `reducers` aren't `send()` are disabled, and `subscriptions`, `effects` and `reducers` aren't
loaded. See [rendering in Node](#rendering-in-node) for an in-depth guide. loaded. See [rendering in Node](#rendering-in-node) for an in-depth guide.
### tree = app.start(opts) ### tree = app.start(rootId?, opts)
Start the application. Returns a tree of DOM nodes that can be mounted using Start the application. Returns a tree of DOM nodes that can be mounted using
`document.body.appendChild()`. Opts can contain the following values: `document.body.appendChild()`. If a valid `id` selector is passed in as the
first argument, the tree will diff against the selected node rather than be
returned. This is useful for [rehydration](#rehydration). Opts can contain the
following values:
- __opts.history:__ default: `true`. Enable a `subscription` to the browser - __opts.history:__ default: `true`. Enable a `subscription` to the browser
history API. e.g. updates the internal `state.location` state whenever the history API. e.g. updates the internal `state.location` state whenever the
browser "forward" and "backward" buttons are pressed. browser "forward" and "backward" buttons are pressed.