Skip to content

Commit 57aca74

Browse files
Austioeddyerburgh
authored andcommitted
docs: add documentation for setComputed (#171)
1 parent ade28d5 commit 57aca74

File tree

4 files changed

+73
-0
lines changed

4 files changed

+73
-0
lines changed

docs/en/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
* [isEmpty](api/wrapper/isEmpty.md)
4040
* [isVueInstance](api/wrapper/isVueInstance.md)
4141
* [name](api/wrapper/name.md)
42+
* [setComputed](api/wrapper/setComputed.md)
4243
* [setData](api/wrapper/setData.md)
4344
* [setMethods](api/wrapper/setMethods.md)
4445
* [setProps](api/wrapper/setProps.md)
@@ -55,6 +56,7 @@
5556
* [is](api/wrapper-array/is.md)
5657
* [isEmpty](api/wrapper-array/isEmpty.md)
5758
* [isVueInstance](api/wrapper-array/isVueInstance.md)
59+
* [setComputed](api/wrapper-array/setComputed.md)
5860
* [setData](api/wrapper-array/setData.md)
5961
* [setMethods](api/wrapper-array/setMethods.md)
6062
* [setProps](api/wrapper-array/setProps.md)

docs/en/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
* [isEmpty](api/wrapper/isEmpty.md)
3838
* [isVueInstance](api/wrapper/isVueInstance.md)
3939
* [name](api/wrapper/name.md)
40+
* [setComputed](api/wrapper/setComputed.md)
4041
* [setData](api/wrapper/setData.md)
4142
* [setMethods](api/wrapper/setMethods.md)
4243
* [setProps](api/wrapper/setProps.md)
@@ -54,6 +55,7 @@
5455
* [is](api/wrapper-array/is.md)
5556
* [isEmpty](api/wrapper-array/isEmpty.md)
5657
* [isVueInstance](api/wrapper-array/isVueInstance.md)
58+
* [setComputed](api/wrapper-array/setComputed.md)
5759
* [setData](api/wrapper-array/setData.md)
5860
* [setMethods](api/wrapper-array/setMethods.md)
5961
* [setProps](api/wrapper-array/setProps.md)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# setComputed(computedObjects)
3+
4+
Sets `Wrapper` `vm` computed and forces update on each `Wrapper` in `WrapperArray`.
5+
6+
**Note every `Wrapper` must contain a Vue instance.**
7+
**Note every Vue instance must already have the computed properties passed to setComputed.**
8+
9+
- **Arguments:**
10+
- `{Object} computed properties`
11+
12+
- **Example:**
13+
14+
```js
15+
import { mount } from 'vue-test-utils'
16+
import Foo from './Foo.vue'
17+
import Bar from './Bar.vue'
18+
19+
const wrapper = mount(Foo)
20+
const barArray = wrapper.findAll(Bar)
21+
22+
barArray.setComputed({
23+
computed1: 'new-computed1',
24+
computed2: 'new-computed2'
25+
})
26+
```

docs/en/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+
Sets `Wrapper` `vm` computed property and forces update.
4+
5+
**Note the Wrapper must contain a Vue instance.**
6+
**Note every Vue instance must already have the computed properties passed to setComputed.**
7+
8+
9+
- **Arguments:**
10+
- `{Object} computed properties`
11+
12+
- **Example:**
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)