fs: make FSStatWatcher.start private #29971
Conversation
nodejs-github-bot
added
the
fs
|
Unfortunately I think this will require a deprecation cycle before it can be made private |
jasnell
added
the
semver-major
|
That should have included a deprecation also. I hadn't seen it before it landed |
|
I see that new deprecation PR, #29989, for the |
|
There seems to be some discussion happening in this issue, #29989 (comment), regarding the needing a deprecation or not, so going to wait to see what happens there before proceeding |
|
It looks like the outcome of #29989 (comment) , was that it is prefered to have an alias or stub than a runtime deprecation for this type of thing. I'm going to update this PR then to do that |
|
Updated this PR with the stubbed out start method |
lholmquist
force-pushed
the
fs-staatwatch-private
branch
from
38b9f56
to
c2ec954
Compare
|
Also gave this a rebase since it was out of date |
|
also adding in a comment, which was suggested here: #30160 (review) I also realize i have a 2 different PR's open for the same file, sorry about that :) |
An instance of FSStatWatcher is returned when a user calls fs.watchFile, which will call the start method. A user can't create an instance of a FSStatWatcher directly. If the start method is called by a user it is a noop since the watcher has already started. This "Class" is currently undocumented
lholmquist
force-pushed
the
fs-staatwatch-private
branch
from
442c5be
to
7e03961
Compare
|
Just did a rebase now that #30160 has been merged |
|
This needs another @nodejs/tsc approval in order to land |
addaleax
added
the
author ready
An instance of FSStatWatcher is returned when a user calls fs.watchFile, which will call the start method. A user can't create an instance of a FSStatWatcher directly. If the start method is called by a user it is a noop since the watcher has already started. This "Class" is currently undocumented. PR-URL: #29971 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michaël Zasso <targos@protonmail.com>
|
Landed in 535e957 🎉 |
Similar to #29905
An instance of FSStatWatcher is returned when a user calls fs.watchFile,
which will call the start method. A user can't create an instance
of a FSStatWatcher directly. If the start method is called by a user
it is a noop since the watcher has already started.
ATM, a user could call start on a closed watcher and i believe it would restart it, however, they would need to re-pass the filename and other function parameters. I haven't actually tested that out, though. This is what i see from the code. It would be nice if it acted in a similar fashion to the FSWatch class, and a noop would happen if start was called on a closed watcher, but if this function becomes private, then that wouldn't matter
This method is also undocumented, in fact, the whole "Class" FSStatWatcher seems to be undocumented, although that can be a different issue/PR
This PR makes this method private, and would be a semver-major change, similar to the link issue above
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes