Skip to content

Commit e95b4c6

Browse files
38elementseddyerburgh
authored andcommitted
docs: add api document in docs/ja (#194)
* Update README.md * Update README.md
1 parent 5fb5843 commit e95b4c6

File tree

6 files changed

+136
-6
lines changed

6 files changed

+136
-6
lines changed

docs/ja/README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,24 @@
1111
* [Vue Router と一緒に使う](guides/using-with-vue-router.md)
1212
* [Vuex と一緒に使う](guides/using-with-vuex.md)
1313
* [API](api/README.md)
14-
* [createLocalVue](api/createLocalVue.md)
1514
* [mount](api/mount.md)
1615
* [shallow](api/shallow.md)
1716
* [マウンティングオプション](api/options.md)
17+
- [context](api/options.md#context)
18+
- [slots](api/options.md#slots)
19+
- [stubs](api/options.md#stubs)
20+
- [mocks](api/options.md#mocks)
21+
- [localVue](api/options.md#localvue)
22+
- [attachToDocument](api/options.md#attachtodocument)
23+
- [attrs](api/options.md#attrs)
24+
- [listeners](api/options.md#listeners)
25+
- [clone](api/options.md#clone)
1826
* [Wrapper](api/wrapper/README.md)
1927
* [contains](api/wrapper/contains.md)
28+
* [emitted](api/wrapper/emitted.md)
29+
* [emittedByOrder](api/wrapper/emittedByOrder.md)
2030
* [find](api/wrapper/find.md)
31+
* [findAll](api/wrapper/findAll.md)
2132
* [hasAttribute](api/wrapper/hasAttribute.md)
2233
* [hasClass](api/wrapper/hasClass.md)
2334
* [hasProp](api/wrapper/hasProp.md)
@@ -27,11 +38,14 @@
2738
* [isEmpty](api/wrapper/isEmpty.md)
2839
* [isVueInstance](api/wrapper/isVueInstance.md)
2940
* [name](api/wrapper/name.md)
30-
* [update](api/wrapper/update.md)
41+
* [setComputed](api/wrapper/setComputed.md)
3142
* [setData](api/wrapper/setData.md)
43+
* [setMethods](api/wrapper/setMethods.md)
3244
* [setProps](api/wrapper/setProps.md)
3345
* [text](api/wrapper/text.md)
3446
* [trigger](api/wrapper/trigger.md)
47+
* [update](api/wrapper/update.md)
48+
* [destroy](api/wrapper/destroy.md)
3549
* [WrapperArray](api/wrapper-array/README.md)
3650
* [at](api/wrapper-array/at.md)
3751
* [contains](api/wrapper-array/contains.md)
@@ -42,8 +56,12 @@
4256
* [is](api/wrapper-array/is.md)
4357
* [isEmpty](api/wrapper-array/isEmpty.md)
4458
* [isVueInstance](api/wrapper-array/isVueInstance.md)
45-
* [update](api/wrapper-array/update.md)
59+
* [setComputed](api/wrapper-array/setComputed.md)
4660
* [setData](api/wrapper-array/setData.md)
61+
* [setMethods](api/wrapper-array/setMethods.md)
4762
* [setProps](api/wrapper-array/setProps.md)
4863
* [trigger](api/wrapper-array/trigger.md)
64+
* [update](api/wrapper-array/update.md)
65+
* [destroy](api/wrapper-array/destroy.md)
4966
* [セレクタ](api/selectors.md)
67+
* [createLocalVue](api/createLocalVue.md)

docs/ja/api/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* [emitted](./wrapper/emitted.md)
1818
* [emittedByOrder](./wrapper/emittedByOrder.md)
1919
* [find](./wrapper/find.md)
20+
* [findAll](./wrapper/findAll.md)
2021
* [hasAttribute](./wrapper/hasAttribute.md)
2122
* [hasClass](./wrapper/hasClass.md)
2223
* [hasProp](./wrapper/hasProp.md)
@@ -26,11 +27,14 @@
2627
* [isEmpty](./wrapper/isEmpty.md)
2728
* [isVueInstance](./wrapper/isVueInstance.md)
2829
* [name](./wrapper/name.md)
29-
* [update](./wrapper/update.md)
30+
* [setComputed](./wrapper/setComputed.md)
3031
* [setData](./wrapper/setData.md)
32+
* [setMethods](./wrapper/setMethods.md)
3133
* [setProps](./wrapper/setProps.md)
3234
* [text](./wrapper/text.md)
3335
* [trigger](./wrapper/trigger.md)
36+
* [update](./wrapper/update.md)
37+
* [destroy](./wrapper/destroy.md)
3438
* [WrapperArray](./wrapper-array/README.md)
3539
* [at](./wrapper-array/at.md)
3640
* [contains](./wrapper-array/contains.md)
@@ -41,9 +45,12 @@
4145
* [is](./wrapper-array/is.md)
4246
* [isEmpty](./wrapper-array/isEmpty.md)
4347
* [isVueInstance](./wrapper-array/isVueInstance.md)
44-
* [update](./wrapper-array/update.md)
48+
* [setComputed](./wrapper-array/setComputed.md)
4549
* [setData](./wrapper-array/setData.md)
50+
* [setMethods](./wrapper-array/setMethods.md)
4651
* [setProps](./wrapper-array/setProps.md)
4752
* [trigger](./wrapper-array/trigger.md)
53+
* [update](./wrapper-array/update.md)
54+
* [destroy](./wrapper-array/destroy.md)
4855
* [createLocalVue](./createLocalVue.md)
49-
* [Selectors](./selectors.md)
56+
* [セレクタ](./selectors.md)

docs/ja/api/wrapper-array/destroy.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# destroy()
2+
3+
`WrapperArray` のすべての Vue コンポーネントインスタンスを破棄します。
4+
5+
- **例:**
6+
7+
```js
8+
import { mount } from 'vue-test-utils'
9+
import { expect } from 'chai'
10+
import Foo from './Foo.vue'
11+
12+
const wrapper = mount(Foo)
13+
const divArray = wrapper.findAll('div')
14+
expect(divArray.contains('p')).toBe(true)
15+
divArray.destroy()
16+
expect(divArray.contains('p')).toBe(false)
17+
```
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# setComputed(computedObjects)
2+
3+
`WrapperArray``Wrapper` ごとに `Wrapper` `vm` の computed プロパティを設定し、更新を強制します。
4+
5+
**すべての Wrapper には Vue インスタンスを含む必要があることに注意してください**
6+
**`setComputed` に渡す computed プロパティはすべての Vue インスタンスに存在する必要があることに注意してください**
7+
8+
- **引数:**
9+
- `{Object} computed properties`
10+
11+
- **例:**
12+
13+
```js
14+
import { mount } from 'vue-test-utils'
15+
import Foo from './Foo.vue'
16+
import Bar from './Bar.vue'
17+
18+
const wrapper = mount(Foo)
19+
const barArray = wrapper.findAll(Bar)
20+
21+
barArray.setComputed({
22+
computed1: 'new-computed1',
23+
computed2: 'new-computed2'
24+
})
25+
```

docs/ja/api/wrapper/destroy.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# destroy()
2+
3+
Vue コンポーネントインスタンスを破棄します。
4+
5+
- **例:**
6+
7+
```js
8+
import { mount } from 'vue-test-utils'
9+
import { expect } from 'chai'
10+
import sinon from 'sinon'
11+
12+
const spy = sinon.stub()
13+
mount({
14+
render: null,
15+
destroyed () {
16+
spy()
17+
}
18+
}).destroy()
19+
expect(spy.calledOnce).to.equal(true)
20+
```

docs/ja/api/wrapper/setComputed.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# setComputed(computedProperties)
2+
3+
`Wrapper` `vm` の computed プロパティを設定し、更新を強制します。
4+
5+
**Wrapper には Vue インスタンスを含む必要があることに注意してください**
6+
**`setComputed`に渡す computed プロパティは Vue インスタンスに存在する必要があることに注意してください**
7+
8+
9+
- **引数:**
10+
- `{Object} computed プロパティ`
11+
12+
- **例:**
13+
14+
```js
15+
import { mount } from 'vue-test-utils'
16+
import { expect } from 'chai'
17+
18+
const wrapper = mount({
19+
template: '<div>{{ computed1 }} {{ computed2 }}</div>',
20+
data () {
21+
return {
22+
initial: 'initial'
23+
}
24+
},
25+
computed: {
26+
computed1 () {
27+
return this.initial
28+
},
29+
computed2 () {
30+
return this.initial
31+
}
32+
}
33+
})
34+
35+
expect(wrapper.html()).toBe('<div>initial initial</div>')
36+
37+
wrapper.setComputed({
38+
computed1: 'new-computed1',
39+
computed2: 'new-computed2'
40+
})
41+
42+
expect(wrapper.html()).toBe('<div>new-computed1 new-computed2</div>')
43+
```

0 commit comments

Comments
 (0)