docs(server): add reference link for 'server.watcher' null behavior #20687
+1
−1
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
hi-ogawa
reviewed
Aug 27, 2025
docs/config/server-options.md
Outdated
| @@ -256,7 +256,7 @@ File system watcher options to pass on to [chokidar](https://github.com/paulmill | |||
|
|
|||
| The Vite server watcher watches the `root` and skips the `.git/`, `node_modules/`, `test-results/`, and Vite's `cacheDir` and `build.outDir` directories by default. When updating a watched file, Vite will apply HMR and update the page only if needed. | |||
|
|
|||
| If set to `null`, no files will be watched. `server.watcher` will provide a compatible event emitter, but calling `add` or `unwatch` will have no effect. | |||
| If set to `null`, no files will be watched. `server.watch` will provide a compatible event emitter, but calling `add` or `unwatch` will have no effect. | |||
There was a problem hiding this comment.
Current documentation is correct since this is ViteDevServer.watcher https://vite.dev/guide/api-javascript.html#vitedevserver. Perhaps we can add a link instead.
Suggested change
| If set to `null`, no files will be watched. `server.watch` will provide a compatible event emitter, but calling `add` or `unwatch` will have no effect. | |
| If set to `null`, no files will be watched. [`server.watcher`](/guide/api-javascript.html#vitedevserver) will provide a compatible event emitter, but calling `add` or `unwatch` will have no effect. |
There was a problem hiding this comment.
Yes, I checked! I will fix it by adding the link :)
…' in file watcher options
wo-o29
changed the title
hi-ogawa
approved these changes
Aug 27, 2025
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.
Description
This PR adds a reference link in the documentation for the
server.watcheroption regarding its behavior when set tonull.The documentation states:
If set to
null, no files will be watched.server.watcherwill provide a compatible event emitter, but callingaddorunwatchwill have no effect.This PR adds a link to the
server.watcherAPI for further details.What was changed
server.watcherAPI documentation in the relevant sentence about its behavior when set tonull.Why this change is necessary
server.watchermore effectively.