Skip to content

Commit 3c597d3

Browse files
eddyerburgheddyerburgh
authored
fix: return promise from render and renderToString (vuejs#1164)
BREAKING CHANGE: render and renderToString are now async
1 parent 4cc79e1 commit 3c597d3

24 files changed

+581
-751
lines changed

‎docs/api/render.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **Returns:** `{CheerioWrapper}`
16+
- **Returns:** `{Promise<CheerioWrapper>}`
1717

1818
- **Options:**
1919

@@ -36,8 +36,8 @@ import { render } from '@vue/server-test-utils'
3636
import Foo from './Foo.vue'
3737

3838
describe('Foo', () => {
39-
it('renders a div', () => {
40-
const wrapper = render(Foo)
39+
it('renders a div', async () => {
40+
const wrapper = await render(Foo)
4141
expect(wrapper.text()).toContain('<div></div>')
4242
})
4343
})
@@ -50,8 +50,8 @@ import { render } from '@vue/server-test-utils'
5050
import Foo from './Foo.vue'
5151

5252
describe('Foo', () => {
53-
it('renders a div', () => {
54-
const wrapper = render(Foo, {
53+
it('renders a div', async () => {
54+
const wrapper = await render(Foo, {
5555
propsData: {
5656
color: 'red'
5757
}
@@ -70,8 +70,8 @@ import Bar from './Bar.vue'
7070
import FooBar from './FooBar.vue'
7171

7272
describe('Foo', () => {
73-
it('renders a div', () => {
74-
const wrapper = render(Foo, {
73+
it('renders a div', async () => {
74+
const wrapper = await render(Foo, {
7575
slots: {
7676
default: [Bar, FooBar],
7777
fooBar: FooBar, // Will match <slot name="FooBar" />,
@@ -90,9 +90,9 @@ import { render } from '@vue/server-test-utils'
9090
import Foo from './Foo.vue'
9191

9292
describe('Foo', () => {
93-
it('renders a div', () => {
93+
it('renders a div', async () => {
9494
const $route = { path: 'http://www.example-path.com' }
95-
const wrapper = render(Foo, {
95+
const wrapper = await render(Foo, {
9696
mocks: {
9797
$route
9898
}

‎docs/api/renderToString.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **Returns:** `{string}`
16+
- **Returns:** `{Promise<string>}`
1717

1818
- **Options:**
1919

@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
3434
import Foo from './Foo.vue'
3535

3636
describe('Foo', () => {
37-
it('renders a div', () => {
38-
const renderedString = renderToString(Foo)
39-
expect(renderedString).toContain('<div></div>')
37+
it('renders a div', async () => {
38+
const str = await renderToString(Foo)
39+
expect(str).toContain('<div></div>')
4040
})
4141
})
4242
```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
4848
import Foo from './Foo.vue'
4949

5050
describe('Foo', () => {
51-
it('renders a div', () => {
52-
const renderedString = renderToString(Foo, {
51+
it('renders a div', async () => {
52+
const str = await renderToString(Foo, {
5353
propsData: {
5454
color: 'red'
5555
}
5656
})
57-
expect(renderedString).toContain('red')
57+
expect(str).toContain('red')
5858
})
5959
})
6060
```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
6868
import FooBar from './FooBar.vue'
6969

7070
describe('Foo', () => {
71-
it('renders a div', () => {
72-
const renderedString = renderToString(Foo, {
71+
it('renders a div', async () => {
72+
const str = await renderToString(Foo, {
7373
slots: {
7474
default: [Bar, FooBar],
7575
fooBar: FooBar, // Will match <slot name="FooBar" />,
7676
foo: '<div />'
7777
}
7878
})
79-
expect(renderedString).toContain('<div></div>')
79+
expect(str).toContain('<div></div>')
8080
})
8181
})
8282
```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
8888
import Foo from './Foo.vue'
8989

9090
describe('Foo', () => {
91-
it('renders a div', () => {
91+
it('renders a div', async () => {
9292
const $route = { path: 'http://www.example-path.com' }
93-
const renderedString = renderToString(Foo, {
93+
const str = await renderToString(Foo, {
9494
mocks: {
9595
$route
9696
}
9797
})
98-
expect(renderedString).toContain($route.path)
98+
expect(str).toContain($route.path)
9999
})
100100
})
101101
```

‎docs/ja/api/render.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **戻り値:** `{CheerioWrapper}`
16+
- **戻り値:** `{Promise<CheerioWrapper>}`
1717

1818
- **オプション:**
1919

@@ -37,8 +37,8 @@ import { render } from '@vue/server-test-utils'
3737
import Foo from './Foo.vue'
3838

3939
describe('Foo', () => {
40-
it('renders a div', () => {
41-
const wrapper = render(Foo)
40+
it('renders a div', async () => {
41+
const wrapper = await render(Foo)
4242
expect(wrapper.text()).toContain('<div></div>')
4343
})
4444
})
@@ -51,8 +51,8 @@ import { render } from '@vue/server-test-utils'
5151
import Foo from './Foo.vue'
5252

5353
describe('Foo', () => {
54-
it('renders a div', () => {
55-
const wrapper = render(Foo, {
54+
it('renders a div', async () => {
55+
const wrapper = await render(Foo, {
5656
propsData: {
5757
color: 'red'
5858
}
@@ -71,8 +71,8 @@ import Bar from './Bar.vue'
7171
import FooBar from './FooBar.vue'
7272

7373
describe('Foo', () => {
74-
it('renders a div', () => {
75-
const wrapper = render(Foo, {
74+
it('renders a div', async () => {
75+
const wrapper = await render(Foo, {
7676
slots: {
7777
default: [Bar, FooBar],
7878
fooBar: FooBar, // <slot name="FooBar" /> にマッチします。
@@ -91,9 +91,9 @@ import { render } from '@vue/server-test-utils'
9191
import Foo from './Foo.vue'
9292

9393
describe('Foo', () => {
94-
it('renders a div', () => {
94+
it('renders a div', async () => {
9595
const $route = { path: 'http://www.example-path.com' }
96-
const wrapper = render(Foo, {
96+
const wrapper = await render(Foo, {
9797
mocks: {
9898
$route
9999
}

‎docs/ja/api/renderToString.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **戻り値:** `{string}`
16+
- **戻り値:** `{Promise<string>}`
1717

1818
- **オプション:**
1919

@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
3434
import Foo from './Foo.vue'
3535

3636
describe('Foo', () => {
37-
it('renders a div', () => {
38-
const renderedString = renderToString(Foo)
39-
expect(renderedString).toContain('<div></div>')
37+
it('renders a div', async () => {
38+
const str = await renderToString(Foo)
39+
expect(str).toContain('<div></div>')
4040
})
4141
})
4242
```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
4848
import Foo from './Foo.vue'
4949

5050
describe('Foo', () => {
51-
it('renders a div', () => {
52-
const renderedString = renderToString(Foo, {
51+
it('renders a div', async () => {
52+
const str = await renderToString(Foo, {
5353
propsData: {
5454
color: 'red'
5555
}
5656
})
57-
expect(renderedString).toContain('red')
57+
expect(str).toContain('red')
5858
})
5959
})
6060
```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
6868
import FooBar from './FooBar.vue'
6969

7070
describe('Foo', () => {
71-
it('renders a div', () => {
72-
const renderedString = renderToString(Foo, {
71+
it('renders a div', async () => {
72+
const str = await renderToString(Foo, {
7373
slots: {
7474
default: [Bar, FooBar],
7575
fooBar: FooBar, // <slot name="FooBar" /> にマッチします。
7676
foo: '<div />'
7777
}
7878
})
79-
expect(renderedString).toContain('<div></div>')
79+
expect(str).toContain('<div></div>')
8080
})
8181
})
8282
```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
8888
import Foo from './Foo.vue'
8989

9090
describe('Foo', () => {
91-
it('renders a div', () => {
91+
it('renders a div', async () => {
9292
const $route = { path: 'http://www.example-path.com' }
93-
const renderedString = renderToString(Foo, {
93+
const str = await renderToString(Foo, {
9494
mocks: {
9595
$route
9696
}
9797
})
98-
expect(renderedString).toContain($route.path)
98+
expect(str).toContain($route.path)
9999
})
100100
})
101101
```

‎docs/ru/api/render.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **Возвращает:** `{CheerioWrapper}`
16+
- **Возвращает:** `{Promise<CheerioWrapper>}`
1717

1818
- **Опции:**
1919

@@ -36,8 +36,8 @@ import { render } from '@vue/server-test-utils'
3636
import Foo from './Foo.vue'
3737

3838
describe('Foo', () => {
39-
it('renders a div', () => {
40-
const wrapper = render(Foo)
39+
it('renders a div', async () => {
40+
const wrapper = await render(Foo)
4141
expect(wrapper.text()).toContain('<div></div>')
4242
})
4343
})
@@ -50,8 +50,8 @@ import { render } from '@vue/server-test-utils'
5050
import Foo from './Foo.vue'
5151

5252
describe('Foo', () => {
53-
it('renders a div', () => {
54-
const wrapper = render(Foo, {
53+
it('renders a div', async () => {
54+
const wrapper = await render(Foo, {
5555
propsData: {
5656
color: 'red'
5757
}
@@ -70,8 +70,8 @@ import Bar from './Bar.vue'
7070
import FooBar from './FooBar.vue'
7171

7272
describe('Foo', () => {
73-
it('renders a div', () => {
74-
const wrapper = render(Foo, {
73+
it('renders a div', async () => {
74+
const wrapper = await render(Foo, {
7575
slots: {
7676
default: [Bar, FooBar],
7777
fooBar: FooBar, // Будет соответствовать <slot name="FooBar" />,
@@ -90,9 +90,9 @@ import { render } from '@vue/server-test-utils'
9090
import Foo from './Foo.vue'
9191

9292
describe('Foo', () => {
93-
it('renders a div', () => {
93+
it('renders a div', async () => {
9494
const $route = { path: 'http://www.example-path.com' }
95-
const wrapper = render(Foo, {
95+
const wrapper = await render(Foo, {
9696
mocks: {
9797
$route
9898
}

‎docs/ru/api/renderToString.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- `{Object|Array<string>} stubs`
1414
- `{Vue} localVue`
1515

16-
- **Возвращает:** `{string}`
16+
- **Возвращает:** `{Promise<string>}`
1717

1818
- **Опции:**
1919

@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
3434
import Foo from './Foo.vue'
3535

3636
describe('Foo', () => {
37-
it('renders a div', () => {
38-
const renderedString = renderToString(Foo)
39-
expect(renderedString).toContain('<div></div>')
37+
it('renders a div', async () => {
38+
const str = await renderToString(Foo)
39+
expect(str).toContain('<div></div>')
4040
})
4141
})
4242
```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
4848
import Foo from './Foo.vue'
4949

5050
describe('Foo', () => {
51-
it('renders a div', () => {
52-
const renderedString = renderToString(Foo, {
51+
it('renders a div', async () => {
52+
const str = await renderToString(Foo, {
5353
propsData: {
5454
color: 'red'
5555
}
5656
})
57-
expect(renderedString).toContain('red')
57+
expect(str).toContain('red')
5858
})
5959
})
6060
```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
6868
import FooBar from './FooBar.vue'
6969

7070
describe('Foo', () => {
71-
it('renders a div', () => {
72-
const renderedString = renderToString(Foo, {
71+
it('renders a div', async () => {
72+
const str = await renderToString(Foo, {
7373
slots: {
7474
default: [Bar, FooBar],
7575
fooBar: FooBar, // Будет соответствовать <slot name="FooBar" />,
7676
foo: '<div />'
7777
}
7878
})
79-
expect(renderedString).toContain('<div></div>')
79+
expect(str).toContain('<div></div>')
8080
})
8181
})
8282
```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
8888
import Foo from './Foo.vue'
8989

9090
describe('Foo', () => {
91-
it('renders a div', () => {
91+
it('renders a div', async () => {
9292
const $route = { path: 'http://www.example-path.com' }
93-
const renderedString = renderToString(Foo, {
93+
const str = await renderToString(Foo, {
9494
mocks: {
9595
$route
9696
}
9797
})
98-
expect(renderedString).toContain($route.path)
98+
expect(str).toContain($route.path)
9999
})
100100
})
101101
```

0 commit comments

Comments
 (0)