Merge pull request #1405 from samgre/dev

docs: add note about waiting for async trigger event to be handled

Author: lmiller1990

docs/api/wrapper/emitted.md

@@ -9,26 +9,30 @@ Return an object containing custom events emitted by the `Wrapper` `vm`.
 ```js
 import { mount } from '@vue/test-utils'
 
-const wrapper = mount(Component)
+test('emit demo', async () => {
+  const wrapper = mount(Component)
 
-wrapper.vm.$emit('foo')
-wrapper.vm.$emit('foo', 123)
+  wrapper.vm.$emit('foo')
+  wrapper.vm.$emit('foo', 123)
 
-/*
-wrapper.emitted() returns the following object:
-{
-  foo: [[], [123]]
-}
-*/
+  await wrapper.vm.$nextTick() // Wait until $emits have been handled
 
-// assert event has been emitted
-expect(wrapper.emitted().foo).toBeTruthy()
+  /*
+  wrapper.emitted() returns the following object:
+  {
+    foo: [[], [123]]
+  }
+  */
 
-// assert event count
-expect(wrapper.emitted().foo.length).toBe(2)
+  // assert event has been emitted
+  expect(wrapper.emitted().foo).toBeTruthy()
 
-// assert event payload
-expect(wrapper.emitted().foo[1]).toEqual([123])
+  // assert event count
+  expect(wrapper.emitted().foo.length).toBe(2)
+
+  // assert event payload
+  expect(wrapper.emitted().foo[1]).toEqual([123])
+})
 ```
 
 You can also write the above as follows:

docs/api/wrapper/trigger.md

@@ -1,6 +1,6 @@
 ## trigger
 
-Triggers an event on the `Wrapper` DOM node.
+Triggers an event asynchronously on the `Wrapper` DOM node.
 
 `trigger` takes an optional `options` object. The properties in the `options` object are added to the Event.
 
@@ -16,22 +16,26 @@ import { mount } from '@vue/test-utils'
 import sinon from 'sinon'
 import Foo from './Foo'
 
-const clickHandler = sinon.stub()
-const wrapper = mount(Foo, {
-  propsData: { clickHandler }
-})
+test('trigger demo', async () => {
+  const clickHandler = sinon.stub()
+  const wrapper = mount(Foo, {
+    propsData: { clickHandler }
+  })
 
-wrapper.trigger('click')
+  wrapper.trigger('click')
 
-wrapper.trigger('click', {
-  button: 0
-})
+  wrapper.trigger('click', {
+    button: 0
+  })
 
-wrapper.trigger('click', {
-  ctrlKey: true // For testing @click.ctrl handlers
-})
+  wrapper.trigger('click', {
+    ctrlKey: true // For testing @click.ctrl handlers
+  })
 
-expect(clickHandler.called).toBe(true)
+  await wrapper.vm.$nextTick() // Wait until trigger events have been handled
+
+  expect(clickHandler.called).toBe(true)
+})
 ```
 
 - **Setting the event target:**