Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: createViteRuntime should be imported from vite #16067

Closed
wants to merge 2 commits into from

Conversation

yuusheng
Copy link

@yuusheng yuusheng commented Mar 1, 2024

Description

Fix typo in Vite SSR documents.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines, especially the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Update the corresponding documentation if needed.
  • Ideally, include relevant tests that fail without this PR but pass with it.

Copy link

stackblitz bot commented Mar 1, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@yuusheng yuusheng changed the title fix: createViteRuntime should be imported from vite docs: createViteRuntime should be imported from vite Mar 1, 2024
docs/guide/ssr.md Outdated Show resolved Hide resolved
@@ -134,7 +136,7 @@ app.use('*', async (req, res, next) => {
// It fully supports HMR and works in a simillar way to ssrLoadModule
// More advanced use case would be creating a runtime in a separate
// thread or even a different machine using ViteRuntime class
const runtime = await vite.createViteRuntime(server)
const runtime = await createViteRuntime(server)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that we shouldn't be creating createViteRuntime for every request I guess. @sheremet-va Does this work fine?
Maybe we should extract the ViteRuntime part and put a complete example in ::: details block.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a complete example will definitely help a lot!

@sapphi-red sapphi-red added the documentation Improvements or additions to documentation label Mar 1, 2024
@sheremet-va
Copy link
Member

By the way, this will be removed in 5.3 - #16089

@sapphi-red
Copy link
Member

Closing as we removed this section for now. Thanks for the PR 🙏

@sapphi-red sapphi-red closed this Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants