Skip to content

docs: tweaks #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2018
Merged

docs: tweaks #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7017bb
Update options.md
38elements May 23, 2018
2f1eef2
Update README.md
38elements May 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/api/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,6 @@ Pass properties for components to use in injection. See [provide/inject](https:/
- type: `boolean`
- default: `true`

Sets all watchers to run synchronously.
Copy link
Contributor Author

@38elements 38elements May 23, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line was removed at #487.


When `sync` is `true`, the Vue component is rendered synchronously.
When `sync` is `false`, the Vue component is rendered asynchronously.

Expand Down
11 changes: 5 additions & 6 deletions docs/api/wrapper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,19 @@ A `Wrapper` is an object that contains a mounted component or vnode and methods

`Component`: This is the `Vue` instance. You can access all the [instance methods and properties of a vm](https://vuejs.org/v2/api/#Instance-Properties) with `wrapper.vm`. This only exists on Vue component wrappers

### `element`:
### `element`

`HTMLElement`: the root DOM node of the wrapper

### `options`:
`Object`: Object containing Vue Test Utils options passed to `mount` or `shallowMount`
### `options`

#### `options.attachedToDocument`:
#### `options.attachedToDocument`

`Boolean`: True if `attachedToDocument` was passed to `mount` or `shallowMount`
`Boolean`: True if `attachedToDocument` in mounting options was true 
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using mounting options is better.


#### `options.sync`

`Boolean`: True if `sync` was not passed as `false` to `mount` or `shallowMount`
`Boolean`: True if `sync` in mounting options was not `false`

## Methods

Expand Down