Skip to content

docs: update guide on get method specifying the difference with find #48

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 1 commit into from
Aug 15, 2020
Merged

docs: update guide on get method specifying the difference with find #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions src/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,7 +755,7 @@ test('findAllComponents', () => {

### `get`

Similar to `find`, `get` looks for an element and returns a `DOMWrapper` if one is found. Otherwise it throws an error.
Similar to `find`, `get` looks for an element and returns a `DOMWrapper` if one is found. Otherwise it throws an error. As a rule of thumb, always use get except when you are asserting something doesn't exist. In that case use [`find`](#find).

`Component.vue`:

Expand All @@ -773,13 +773,10 @@ test('get', () => {
const wrapper = mount(Component)

wrapper.get('span') //=> found; returns DOMWrapper
wrapper.get('[data-test="span"]') //=> found; returns DOMWrapper

expect(() => wrapper.getComponent('p')).toThrowError()
wrapper.get('[data-test="span"]') //=> found; returns DOMWrapper, fails if no matching element is found
})
```


### `getComponent`

Similar to `findComponent`, `getComponent` looks for a Vue Component instance and returns a `VueWrapper` if one is found. Otherwise it throws an error.
Expand Down