feat: add renderToString function #1971
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for vue-test-utils-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
cexbrayat
force-pushed
the
render-to-string
branch
from
9af6455
to
c8f7180
Compare
|
@lmiller1990 @freazlike This is a rebased/tidied up version of #1572 |
|
I forgot to mention I added types tests and a bit of documentation |
cexbrayat
force-pushed
the
render-to-string
branch
from
c8f7180
to
c8fe9b9
Compare
It is now possible to use `renderToString` to test the SSR rendering of a component.
To do so, use `renderToString(MyComponent)`.
`renderToString` returns a `Promise<string>` with the HTML rendered.
```ts
it('returns correct html with pre-fetched data on server', async () => {
const Component = defineComponent({
template: '<div>{{ text }}</div>',
setup() {
const text = ref<string | null>(null)
onServerPrefetch(async () => {
text.value = await fakeFetch('onServerPrefetch')
})
return { text }
}
})
const contents = await renderToString(Component)
expect(contents).toBe('<div>onServerPrefetch</div>')
})
```
cexbrayat
force-pushed
the
render-to-string
branch
from
c8fe9b9
to
71bdb19
Compare
freakzlike
approved these changes
Feb 13, 2023
lmiller1990
approved these changes
Feb 19, 2023
There was a problem hiding this comment.
Let's ship it and start to get feedback! Thanks @cexbrayat and @wobsoriano
This was referenced Mar 20, 2023
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is now possible to use
renderToStringto test the SSR rendering of a component.To do so, use
renderToString(MyComponent).renderToStringreturns aPromise<string>with the HTML rendered.