Optional ReadonlydebounceDebounce delay in milliseconds.
Optional ReadonlyeventsEvents to watch. Also decides the native ignore*Events flags, so unwanted
event kinds never enter the pipeline at all.
Optional ReadonlyignorePatterns to ignore.
Optional ReadonlymaxOnce this many distinct files are pending, flush immediately instead of
waiting for the debounce window — bounds memory during bursts
(git checkout, npm install) where events outpace the window.
Unbounded by default, and worth knowing what that means: the
debounce only fires once the stream goes quiet, so while events keep
arriving closer together than debounceDelay nothing is delivered and the
pending map keeps one entry per distinct path. A long enough burst
therefore delays every listener and holds memory proportional to the number
of paths touched. Set this, or FileWatcherOptions.maxWait, whenever
the watched glob can see a burst you do not control.
Optional ReadonlymaxLongest a pending batch may wait, in milliseconds, however busy the stream
stays. This is the liveness bound debounceDelay alone cannot give: with it
set, a burst that never pauses still delivers every maxWait.
ReadonlypatternsGlob pattern(s) to watch.
Optional ReadonlyworkspaceBase folder for any string pattern (combined into a relative pattern for better performance). Entries that already carry a base are unaffected.
Options for creating a file watcher.