Skip to content

Commit 479dabc

Browse files
committed
docs: add async function
1 parent a2b48c9 commit 479dabc

File tree

2 files changed

+33
-29
lines changed

2 files changed

+33
-29
lines changed

docs/api/wrapper/emitted.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,30 @@ Return an object containing custom events emitted by the `Wrapper` `vm`.
99
```js
1010
import { mount } from '@vue/test-utils'
1111

12-
const wrapper = mount(Component)
12+
test('emit demo', async () => {
13+
const wrapper = mount(Component)
1314

14-
wrapper.vm.$emit('foo')
15-
wrapper.vm.$emit('foo', 123)
15+
wrapper.vm.$emit('foo')
16+
wrapper.vm.$emit('foo', 123)
1617

17-
await wrapper.vm.$nextTick() // Wait until $emits have been handled
18+
await wrapper.vm.$nextTick() // Wait until $emits have been handled
1819

19-
/*
20-
wrapper.emitted() returns the following object:
21-
{
22-
foo: [[], [123]]
23-
}
24-
*/
20+
/*
21+
wrapper.emitted() returns the following object:
22+
{
23+
foo: [[], [123]]
24+
}
25+
*/
2526

26-
// assert event has been emitted
27-
expect(wrapper.emitted().foo).toBeTruthy()
27+
// assert event has been emitted
28+
expect(wrapper.emitted().foo).toBeTruthy()
2829

29-
// assert event count
30-
expect(wrapper.emitted().foo.length).toBe(2)
30+
// assert event count
31+
expect(wrapper.emitted().foo.length).toBe(2)
3132

32-
// assert event payload
33-
expect(wrapper.emitted().foo[1]).toEqual([123])
33+
// assert event payload
34+
expect(wrapper.emitted().foo[1]).toEqual([123])
35+
})
3436
```
3537

3638
You can also write the above as follows:

docs/api/wrapper/trigger.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,26 @@ import { mount } from '@vue/test-utils'
1616
import sinon from 'sinon'
1717
import Foo from './Foo'
1818

19-
const clickHandler = sinon.stub()
20-
const wrapper = mount(Foo, {
21-
propsData: { clickHandler }
22-
})
19+
test('trigger demo', async () => {
20+
const clickHandler = sinon.stub()
21+
const wrapper = mount(Foo, {
22+
propsData: { clickHandler }
23+
})
2324

24-
wrapper.trigger('click')
25+
wrapper.trigger('click')
2526

26-
wrapper.trigger('click', {
27-
button: 0
28-
})
27+
wrapper.trigger('click', {
28+
button: 0
29+
})
2930

30-
wrapper.trigger('click', {
31-
ctrlKey: true // For testing @click.ctrl handlers
32-
})
31+
wrapper.trigger('click', {
32+
ctrlKey: true // For testing @click.ctrl handlers
33+
})
3334

34-
await wrapper.vm.$nextTick() // Wait until trigger events have been handled
35+
await wrapper.vm.$nextTick() // Wait until trigger events have been handled
3536

36-
expect(clickHandler.called).toBe(true)
37+
expect(clickHandler.called).toBe(true)
38+
})
3739
```
3840

3941
- **Setting the event target:**

0 commit comments

Comments
 (0)