docs: update handleHotUpdate example to use server.hot API #21330
+2
−2
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What is this PR solving?
The
handleHotUpdateexamples in the Plugin API documentation were still usingserver.ws.send, which has been deprecated in favor of theserver.hotAPIsince Vite 5.1+.
This PR updates the examples to use
server.hot.sendso the documentationreflects current HMR best practices.
Related Issue
Fixes #21317
Alternatives considered
Keeping the existing examples and mentioning the deprecation was considered,
but updating the examples directly avoids confusion for plugin authors copying
code from the docs.
Reviewer notes
This is a documentation-only change and is limited to the
handleHotUpdateexamples. No runtime behavior or APIs are affected.