fix: return promise from render and renderToString (#1164)

BREAKING CHANGE: render and renderToString are now async
vuejs · Mar 3, 2019 · 3c597d3 · 3c597d3
1 parent 4cc79e1
commit 3c597d3
Show file tree

Hide file tree

Showing 24 changed files with 581 additions and 751 deletions.
diff --git a/docs/api/render.md b/docs/api/render.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **Returns:** `{CheerioWrapper}`
+- **Returns:** `{Promise<CheerioWrapper>}`
 
 - **Options:**
 
@@ -36,8 +36,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo)
+  it('renders a div', async () => {
+    const wrapper = await render(Foo)
     expect(wrapper.text()).toContain('<div></div>')
   })
 })
@@ -50,8 +50,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       propsData: {
         color: 'red'
       }
@@ -70,8 +70,8 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // Will match <slot name="FooBar" />,
@@ -90,9 +90,9 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const wrapper = render(Foo, {
+    const wrapper = await render(Foo, {
       mocks: {
         $route
       }

diff --git a/docs/api/renderToString.md b/docs/api/renderToString.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **Returns:** `{string}`
+- **Returns:** `{Promise<string>}`
 
 - **Options:**
 
@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo)
-    expect(renderedString).toContain('<div></div>')
+  it('renders a div', async () => {
+    const str = await renderToString(Foo)
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       propsData: {
         color: 'red'
       }
     })
-    expect(renderedString).toContain('red')
+    expect(str).toContain('red')
   })
 })
 ```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // Will match <slot name="FooBar" />,
         foo: '<div />'
       }
     })
-    expect(renderedString).toContain('<div></div>')
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const renderedString = renderToString(Foo, {
+    const str = await renderToString(Foo, {
       mocks: {
         $route
       }
     })
-    expect(renderedString).toContain($route.path)
+    expect(str).toContain($route.path)
   })
 })
 ```
diff --git a/docs/ja/api/render.md b/docs/ja/api/render.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **戻り値:** `{CheerioWrapper}`
+- **戻り値:** `{Promise<CheerioWrapper>}`
 
 - **オプション:**
 
@@ -37,8 +37,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo)
+  it('renders a div', async () => {
+    const wrapper = await render(Foo)
     expect(wrapper.text()).toContain('<div></div>')
   })
 })
@@ -51,8 +51,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       propsData: {
         color: 'red'
       }
@@ -71,8 +71,8 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // <slot name="FooBar" /> にマッチします。
@@ -91,9 +91,9 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const wrapper = render(Foo, {
+    const wrapper = await render(Foo, {
       mocks: {
         $route
       }

diff --git a/docs/ja/api/renderToString.md b/docs/ja/api/renderToString.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **戻り値:** `{string}`
+- **戻り値:** `{Promise<string>}`
 
 - **オプション:**
 
@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo)
-    expect(renderedString).toContain('<div></div>')
+  it('renders a div', async () => {
+    const str = await renderToString(Foo)
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       propsData: {
         color: 'red'
       }
     })
-    expect(renderedString).toContain('red')
+    expect(str).toContain('red')
   })
 })
 ```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // <slot name="FooBar" /> にマッチします。
         foo: '<div />'
       }
     })
-    expect(renderedString).toContain('<div></div>')
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const renderedString = renderToString(Foo, {
+    const str = await renderToString(Foo, {
       mocks: {
         $route
       }
     })
-    expect(renderedString).toContain($route.path)
+    expect(str).toContain($route.path)
   })
 })
 ```
diff --git a/docs/ru/api/render.md b/docs/ru/api/render.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **Возвращает:** `{CheerioWrapper}`
+- **Возвращает:** `{Promise<CheerioWrapper>}`
 
 - **Опции:**
 
@@ -36,8 +36,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo)
+  it('renders a div', async () => {
+    const wrapper = await render(Foo)
     expect(wrapper.text()).toContain('<div></div>')
   })
 })
@@ -50,8 +50,8 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       propsData: {
         color: 'red'
       }
@@ -70,8 +70,8 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const wrapper = render(Foo, {
+  it('renders a div', async () => {
+    const wrapper = await render(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // Будет соответствовать <slot name="FooBar" />,
@@ -90,9 +90,9 @@ import { render } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const wrapper = render(Foo, {
+    const wrapper = await render(Foo, {
       mocks: {
         $route
       }

diff --git a/docs/ru/api/renderToString.md b/docs/ru/api/renderToString.md
@@ -13,7 +13,7 @@
     - `{Object|Array<string>} stubs`
     - `{Vue} localVue`
 
-- **Возвращает:** `{string}`
+- **Возвращает:** `{Promise<string>}`
 
 - **Опции:**
 
@@ -34,9 +34,9 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo)
-    expect(renderedString).toContain('<div></div>')
+  it('renders a div', async () => {
+    const str = await renderToString(Foo)
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -48,13 +48,13 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       propsData: {
         color: 'red'
       }
     })
-    expect(renderedString).toContain('red')
+    expect(str).toContain('red')
   })
 })
 ```
@@ -68,15 +68,15 @@ import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
-    const renderedString = renderToString(Foo, {
+  it('renders a div', async () => {
+    const str = await renderToString(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // Будет соответствовать <slot name="FooBar" />,
         foo: '<div />'
       }
     })
-    expect(renderedString).toContain('<div></div>')
+    expect(str).toContain('<div></div>')
   })
 })
 ```
@@ -88,14 +88,14 @@ import { renderToString } from '@vue/server-test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
-  it('renders a div', () => {
+  it('renders a div', async () => {
     const $route = { path: 'http://www.example-path.com' }
-    const renderedString = renderToString(Foo, {
+    const str = await renderToString(Foo, {
       mocks: {
         $route
       }
     })
-    expect(renderedString).toContain($route.path)
+    expect(str).toContain($route.path)
   })
 })
 ```