Skip to content

fs: make FSWatcher.start private

Rodrigo Muino Tomonari requested to merge github/fork/lholmquist/fswatcher-private_start-change into master
  • This is a semver-major change to rename the FSWatcher.start function to FSWatcher._start to make it private

Also see #29872

The motivation here is that it serves no purpose to the end user. An instance of FSWatcher is returned when a user calls fs.watch, which will call the start method. A user can't create an instance of a FSWatcher directly. If the start method is called by a user it is a noop since the watcher has already started. Calling start after a watcher has closed is also a noop

@addaleax @cjihrig I went straight for changing the function to private, do we need an entry or anything in the deprecations.md?

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

Merge request reports