Document new fixedChunkSizePolling ts watch mode

This commit is contained in:
Matt Bierner 2021-03-05 16:19:00 -08:00
parent d7d4253426
commit e066c74761
2 changed files with 6 additions and 0 deletions

View file

@ -872,6 +872,7 @@
"type": "string",
"description": "%configuration.tsserver.watchOptions.watchFile%",
"enum": [
"fixedChunkSizePolling",
"fixedPollingInterval",
"priorityPollingInterval",
"dynamicPriorityPolling",
@ -879,6 +880,7 @@
"useFsEventsOnParentDirectory"
],
"enumDescriptions": [
"%configuration.tsserver.watchOptions.watchFile.fixedChunkSizePolling%",
"%configuration.tsserver.watchOptions.watchFile.fixedPollingInterval%",
"%configuration.tsserver.watchOptions.watchFile.priorityPollingInterval%",
"%configuration.tsserver.watchOptions.watchFile.dynamicPriorityPolling%",
@ -891,11 +893,13 @@
"type": "string",
"description": "%configuration.tsserver.watchOptions.watchDirectory%",
"enum": [
"fixedChunkSizePolling",
"fixedPollingInterval",
"dynamicPriorityPolling",
"useFsEvents"
],
"enumDescriptions": [
"%configuration.tsserver.watchOptions.watchDirectory.fixedChunkSizePolling%",
"%configuration.tsserver.watchOptions.watchDirectory.fixedPollingInterval%",
"%configuration.tsserver.watchOptions.watchDirectory.dynamicPriorityPolling%",
"%configuration.tsserver.watchOptions.watchDirectory.useFsEvents%"

View file

@ -98,12 +98,14 @@
"configuration.suggest.completeJSDocs": "Enable/disable suggestion to complete JSDoc comments.",
"configuration.tsserver.watchOptions": "Configure which watching strategies should be used to keep track of files and directories. Requires using TypeScript 3.8+ in the workspace.",
"configuration.tsserver.watchOptions.watchFile": "Strategy for how individual files are watched.",
"configuration.tsserver.watchOptions.watchFile.fixedChunkSizePolling": "Polls files in chunks at regular interval. Requires using TypeScript 4.3+ in the workspace.",
"configuration.tsserver.watchOptions.watchFile.fixedPollingInterval": "Check every file for changes several times a second at a fixed interval.",
"configuration.tsserver.watchOptions.watchFile.priorityPollingInterval": "Check every file for changes several times a second, but use heuristics to check certain types of files less frequently than others.",
"configuration.tsserver.watchOptions.watchFile.dynamicPriorityPolling": "Use a dynamic queue where less-frequently modified files will be checked less often.",
"configuration.tsserver.watchOptions.watchFile.useFsEvents": "Attempt to use the operating system/file systems native events for file changes.",
"configuration.tsserver.watchOptions.watchFile.useFsEventsOnParentDirectory": "Attempt to use the operating system/file systems native events to listen for changes on a files containing directories. This can use fewer file watchers, but might be less accurate.",
"configuration.tsserver.watchOptions.watchDirectory": "Strategy for how entire directory trees are watched under systems that lack recursive file-watching functionality.",
"configuration.tsserver.watchOptions.watchDirectory.fixedChunkSizePolling": "Polls directories in chunks at regular interval. Requires using TypeScript 4.3+ in the workspace.",
"configuration.tsserver.watchOptions.watchDirectory.fixedPollingInterval": "Check every directory for changes several times a second at a fixed interval.",
"configuration.tsserver.watchOptions.watchDirectory.dynamicPriorityPolling": "Use a dynamic queue where less-frequently modified directories will be checked less often.",
"configuration.tsserver.watchOptions.watchDirectory.useFsEvents": "Attempt to use the operating system/file systems native events for directory changes.",