Wrapper array consistency (#1650)

* feat(wrapperarray): make WrapperArray setData awaitable Make wrapperarray setData awaitable to be consistent with wrapper setData * feat(wrapperarray): make WrapperArray setProps awaitable Make wrapperarray setProps awaitable to be consistent with wrapper setData * feat(wrapperarray): make WrapperArray setValue awaitable Make wrapperarray setValue awaitable to be consistent with wrapper setValue * feat(wrapperarray): make WrapperArray setChecked awaitable Make wrapperarray setChecked awaitable to be consistent with wrapper setChecked * feat(wrapperarray): make WrapperArray trigger awaitable Make wrapperarray trigger awaitable to be consistent with wrapper trigger * docs(trigger): update trigger docs in other languages to be consistent
vuejs · Aug 19, 2020 · 8cc6654 · 8cc6654
1 parent f0ed63b
commit 8cc6654
Show file tree

Hide file tree

Showing 24 changed files with 274 additions and 201 deletions.
diff --git a/docs/api/wrapper-array/setChecked.md b/docs/api/wrapper-array/setChecked.md
@@ -15,25 +15,27 @@ wrapperArray.wrappers.forEach(wrapper => wrapper.setChecked(checked))
 ```js
 import { mount } from '@vue/test-utils'
 
-const wrapper = mount({
-  data() {
-    return {
-      t1: false,
-      t2: ''
-    }
-  },
-  template: `
-    <div>
-      <input type="checkbox" name="t1" class="foo" v-model="t1" />
-      <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
-      <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
-    </div>`
+test('setChecked demo', async () => {
+  const wrapper = mount({
+    data() {
+      return {
+        t1: false,
+        t2: ''
+      }
+    },
+    template: `
+      <div>
+        <input type="checkbox" name="t1" class="foo" v-model="t1" />
+        <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
+        <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
+      </div>`
+  })
+
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual(false)
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setChecked()
+  expect(wrapper.vm.t1).toEqual(true)
+  expect(wrapper.vm.t2).toEqual('foo')
 })
-
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual(false)
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setChecked()
-expect(wrapper.vm.t1).toEqual(true)
-expect(wrapper.vm.t2).toEqual('foo')
 ```
diff --git a/docs/api/wrapper-array/setData.md b/docs/api/wrapper-array/setData.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setData({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setData demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setData({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/api/wrapper-array/setProps.md b/docs/api/wrapper-array/setProps.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setProps({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setProps demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setProps({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/api/wrapper-array/setValue.md b/docs/api/wrapper-array/setValue.md
@@ -29,10 +29,12 @@ const wrapper = mount({
     </div>`
 })
 
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual('')
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setValue('foo')
-expect(wrapper.vm.t1).toEqual('foo')
-expect(wrapper.vm.t2).toEqual('foo')
+test('setValue demo', async () => {
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual('')
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setValue('foo')
+  expect(wrapper.vm.t1).toEqual('foo')
+  expect(wrapper.vm.t2).toEqual('foo')
+})
 ```
diff --git a/docs/api/wrapper-array/trigger.md b/docs/api/wrapper-array/trigger.md
@@ -16,12 +16,14 @@ import { mount } from '@vue/test-utils'
 import sinon from 'sinon'
 import Foo from './Foo.vue'
 
-const clickHandler = sinon.stub()
-const wrapper = mount(Foo, {
-  propsData: { clickHandler }
+test('trigger demo', async () => {
+  const clickHandler = sinon.stub()
+  const wrapper = mount(Foo, {
+    propsData: { clickHandler }
+  })
+
+  const divArray = wrapper.findAll('div')
+  await divArray.trigger('click')
+  expect(clickHandler.called).toBe(true)
 })
-
-const divArray = wrapper.findAll('div')
-divArray.trigger('click')
-expect(clickHandler.called).toBe(true)
 ```
diff --git a/docs/ja/api/wrapper-array/setChecked.md b/docs/ja/api/wrapper-array/setChecked.md
@@ -15,25 +15,27 @@ wrapperArray.wrappers.forEach(wrapper => wrapper.setChecked(checked))
 ```js
 import { mount } from '@vue/test-utils'
 
-const wrapper = mount({
-  data() {
-    return {
-      t1: false,
-      t2: ''
-    }
-  },
-  template: `
-    <div>
-      <input type="checkbox" name="t1" class="foo" v-model="t1" />
-      <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
-      <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
-    </div>`
+test('setChecked demo', async () => {
+  const wrapper = mount({
+    data() {
+      return {
+        t1: false,
+        t2: ''
+      }
+    },
+    template: `
+      <div>
+        <input type="checkbox" name="t1" class="foo" v-model="t1" />
+        <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
+        <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
+      </div>`
+  })
+
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual(false)
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setChecked()
+  expect(wrapper.vm.t1).toEqual(true)
+  expect(wrapper.vm.t2).toEqual('foo')
 })
-
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual(false)
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setChecked()
-expect(wrapper.vm.t1).toEqual(true)
-expect(wrapper.vm.t2).toEqual('foo')
 ```
diff --git a/docs/ja/api/wrapper-array/setData.md b/docs/ja/api/wrapper-array/setData.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setData({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setData demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setData({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/ja/api/wrapper-array/setProps.md b/docs/ja/api/wrapper-array/setProps.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setProps({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setProps demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setProps({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/ja/api/wrapper-array/setValue.md b/docs/ja/api/wrapper-array/setValue.md
@@ -29,10 +29,12 @@ const wrapper = mount({
     </div>`
 })
 
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual('')
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setValue('foo')
-expect(wrapper.vm.t1).toEqual('foo')
-expect(wrapper.vm.t2).toEqual('foo')
+test('setValue demo', async () => {
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual('')
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setValue('foo')
+  expect(wrapper.vm.t1).toEqual('foo')
+  expect(wrapper.vm.t2).toEqual('foo')
+})
 ```
diff --git a/docs/ja/api/wrapper-array/trigger.md b/docs/ja/api/wrapper-array/trigger.md
@@ -15,12 +15,14 @@ import { mount } from '@vue/test-utils'
 import sinon from 'sinon'
 import Foo from './Foo.vue'
 
-const clickHandler = sinon.stub()
-const wrapper = mount(Foo, {
-  propsData: { clickHandler }
-})
+test('trigger demo', async () => {
+  const clickHandler = sinon.stub()
+  const wrapper = mount(Foo, {
+    propsData: { clickHandler }
+  })
 
-const divArray = wrapper.findAll('div')
-divArray.trigger('click')
-expect(clickHandler.called).toBe(true)
+  const divArray = wrapper.findAll('div')
+  await divArray.trigger('click')
+  expect(clickHandler.called).toBe(true)
+})
 ```
diff --git a/docs/ja/api/wrapper/trigger.md b/docs/ja/api/wrapper/trigger.md
@@ -16,18 +16,24 @@ 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')
+  await wrapper.trigger('click')
 
-wrapper.trigger('click', {
-  button: 0
-})
+  await wrapper.trigger('click', {
+    button: 0
+  })
 
-expect(clickHandler.called).toBe(true)
+  await wrapper.trigger('click', {
+    ctrlKey: true
+  })
+
+  expect(clickHandler.called).toBe(true)
+})
 ```
 
 - **イベントターゲットの設定:**

diff --git a/docs/ru/api/wrapper-array/setChecked.md b/docs/ru/api/wrapper-array/setChecked.md
@@ -15,25 +15,27 @@ wrapperArray.wrappers.forEach(wrapper => wrapper.setChecked(checked))
 ```js
 import { mount } from '@vue/test-utils'
 
-const wrapper = mount({
-  data() {
-    return {
-      t1: false,
-      t2: ''
-    }
-  },
-  template: `
-    <div>
-      <input type="checkbox" name="t1" class="foo" v-model="t1" />
-      <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
-      <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
-    </div>`
+test('setChecked demo', async () => {
+  const wrapper = mount({
+    data() {
+      return {
+        t1: false,
+        t2: ''
+      }
+    },
+    template: `
+      <div>
+        <input type="checkbox" name="t1" class="foo" v-model="t1" />
+        <input type="radio" name="t2" class="foo" value="foo" v-model="t2"/>
+        <input type="radio" name="t2" class="bar" value="bar" v-model="t2"/>
+      </div>`
+  })
+
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual(false)
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setChecked()
+  expect(wrapper.vm.t1).toEqual(true)
+  expect(wrapper.vm.t2).toEqual('foo')
 })
-
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual(false)
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setChecked()
-expect(wrapper.vm.t1).toEqual(true)
-expect(wrapper.vm.t2).toEqual('foo')
 ```
diff --git a/docs/ru/api/wrapper-array/setData.md b/docs/ru/api/wrapper-array/setData.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setData({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setData demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setData({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/ru/api/wrapper-array/setProps.md b/docs/ru/api/wrapper-array/setProps.md
@@ -15,8 +15,10 @@ import { mount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = mount(Foo)
-const barArray = wrapper.findAll(Bar)
-barArray.setProps({ foo: 'bar' })
-expect(barArray.at(0).vm.foo).toBe('bar')
+test('setProps demo', async () => {
+  const wrapper = mount(Foo)
+  const barArray = wrapper.findAll(Bar)
+  await barArray.setProps({ foo: 'bar' })
+  expect(barArray.at(0).vm.foo).toBe('bar')
+})
 ```
diff --git a/docs/ru/api/wrapper-array/setValue.md b/docs/ru/api/wrapper-array/setValue.md
@@ -29,10 +29,12 @@ const wrapper = mount({
     </div>`
 })
 
-const wrapperArray = wrapper.findAll('.foo')
-expect(wrapper.vm.t1).toEqual('')
-expect(wrapper.vm.t2).toEqual('')
-wrapperArray.setValue('foo')
-expect(wrapper.vm.t1).toEqual('foo')
-expect(wrapper.vm.t2).toEqual('foo')
+test('setValue demo', async () => {
+  const wrapperArray = wrapper.findAll('.foo')
+  expect(wrapper.vm.t1).toEqual('')
+  expect(wrapper.vm.t2).toEqual('')
+  await wrapperArray.setValue('foo')
+  expect(wrapper.vm.t1).toEqual('foo')
+  expect(wrapper.vm.t2).toEqual('foo')
+})
 ```
diff --git a/docs/ru/api/wrapper-array/trigger.md b/docs/ru/api/wrapper-array/trigger.md
@@ -16,12 +16,14 @@ import { mount } from '@vue/test-utils'
 import sinon from 'sinon'
 import Foo from './Foo.vue'
 
-const clickHandler = sinon.stub()
-const wrapper = mount(Foo, {
-  propsData: { clickHandler }
+test('trigger demo', async () => {
+  const clickHandler = sinon.stub()
+  const wrapper = mount(Foo, {
+    propsData: { clickHandler }
+  })
+
+  const divArray = wrapper.findAll('div')
+  await divArray.trigger('click')
+  expect(clickHandler.called).toBe(true)
 })
-
-const divArray = wrapper.findAll('div')
-divArray.trigger('click')
-expect(clickHandler.called).toBe(true)
 ```