docs: documentation for emitted() and emittedByOrder()

Author: yyx990803

docs/en/SUMMARY.md

@@ -22,6 +22,8 @@
     - [clone](api/options.md#clone)
   * [Wrapper](api/wrapper/README.md)
     * [contains](api/wrapper/contains.md)
+    * [emitted](api/wrapper/emitted.md)
+    * [emittedByOrder](api/wrapper/emittedByOrder.md)
     * [find](api/wrapper/find.md)
     * [hasAttribute](api/wrapper/hasAttribute.md)
     * [hasClass](api/wrapper/hasClass.md)

docs/en/api/README.md

@@ -14,6 +14,8 @@
   - [clone](./options.md#clone)
 * [Wrapper](./wrapper/README.md)
   * [contains](./wrapper/contains.md)
+  * [emitted](./wrapper/emitted.md)
+  * [emittedByOrder](./wrapper/emittedByOrder.md)
   * [find](./wrapper/find.md)
   * [hasAttribute](./wrapper/hasAttribute.md)
   * [hasClass](./wrapper/hasClass.md)

docs/en/api/wrapper/emitted.md

@@ -0,0 +1,33 @@
+# emitted()
+
+Return an object containing custom events emitted by the `Wrapper` `vm`.
+
+- **Returns:** `{ [name: string]: Array<Array<any>> }`
+
+- **Example:**
+
+```js
+import { mount } from 'vue-test-utils'
+import { expect } from 'chai'
+
+const wrapper = mount(Foo)
+
+wrapper.vm.$emit('foo')
+wrapper.vm.$emit('foo', 123)
+
+/*
+wrapper.emitted() returns the following object:
+{
+  foo: [[], [123]]
+}
+*/
+
+// assert event has been emitted
+expect(wrapper.emitted().foo).to.exist
+
+// assert event count
+expect(wrapper.emitted().foo.length).to.equal(2)
+
+// assert event payload
+expect(wrapper.emitted().foo[1]).to.eql([123])
+```

docs/en/api/wrapper/emittedByOrder.md

@@ -0,0 +1,28 @@
+# emittedByOrder()
+
+Return an Array containing custom events emitted by the `Wrapper` `vm`.
+
+- **Returns:** `Array<{ name: string, args: Array<any> }>`
+
+- **Example:**
+
+```js
+import { mount } from 'vue-test-utils'
+import { expect } from 'chai'
+
+const wrapper = mount(Foo)
+
+wrapper.vm.$emit('foo')
+wrapper.vm.$emit('bar', 123)
+
+/*
+wrapper.emittedByOrder() returns the following Array:
+[
+  { name: 'foo', args: [] },
+  { name: 'bar', args: [123] }
+]
+*/
+
+// assert event emit order
+expect(wrapper.emittedByOrder().map(e => e.name)).to.eql(['foo', 'bar'])
+```

docs/en/guides/choosing-a-test-runner.md

@@ -6,7 +6,7 @@ There are many popular JavaScript test runners, and `vue-test-utils` works with
 
 There are a few things to consider when choosing a test runner though: feature set, performance, and support for single-file component (SFC) pre-compilation. After carefully comparing existing libraries, here are two test runners that we recommend:
 
-- [Jest](https://facebook.github.io/jest/docs/en/getting-started.html#content) is the most fully featured test runner. It requires the least configuration, sets up JSDOM by default, and has a great command line user experience. However, you will need a preprocessor to be able to import SFC components in your tests. We have created the `jest-vue` preprocessor which can handle most common SFC features, but it currently does not have 100% feature parity with `vue-loader`.
+- [Jest](https://facebook.github.io/jest/docs/en/getting-started.html#content) is the most fully featured test runner. It requires the least configuration, sets up JSDOM by default, provides built-in assertions, and has a great command line user experience. However, you will need a preprocessor to be able to import SFC components in your tests. We have created the `jest-vue` preprocessor which can handle most common SFC features, but it currently does not have 100% feature parity with `vue-loader`.
 
 - [mocha-webpack](https://github.com/zinserjan/mocha-webpack) is a wrapper around webpack + Mocha, but with a more streamlined interface and watch mode. The benefits of this setup is that we can get complete SFC support via webpack + `vue-loader`, but it requires more configuration upfront.
 

docs/en/guides/common-tips.md

@@ -27,6 +27,41 @@ const wrapper = shallow(Component) // returns a Wrapper containing a mounted Com
 wrapper.vm // the mounted Vue instance
 ```
 
+## Asserting Emitted Events
+
+Each mounted wrapper automatically records all events emitted by the underlying Vue instance. You can retrieve the recorded events using the `wrapper.emitted()` method:
+
+``` js
+const wrapper = mount(Foo)
+
+wrapper.vm.$emit('foo')
+wrapper.vm.$emit('foo', 123)
+
+/*
+wrapper.emitted() returns the following object:
+{
+  foo: [[], [123]]
+}
+*/
+```
+
+You can then make assertions based on these data:
+
+``` js
+import { expect } from 'chai'
+
+// assert event has been emitted
+expect(wrapper.emitted().foo).to.exist
+
+// assert event count
+expect(wrapper.emitted().foo.length).to.equal(2)
+
+// assert event payload
+expect(wrapper.emitted().foo[1]).to.eql([123])
+```
+
+You can also get an Array of the events in their emit order by calling [wrapper.emittedByOrder()](../api/emittedByOrder.md).
+
 ## Manipulating Component State
 
 You can directly manipulate the state of the component using the `setData` or `setProps` method on the wrapper:
@@ -51,7 +86,7 @@ mount(Component, {
 })
 ```
 
-You can also update the props of an already-mounted component with the `wrapper.setProps` method.
+You can also update the props of an already-mounted component with the `wrapper.setProps({})` method.
 
 *For a full list of options, please see the [mount options section](./api/options.md) of the docs.*