Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: added note to fs.watchFile on previousStat #16099

Closed
wants to merge 3 commits into from
Closed

doc: added note to fs.watchFile on previousStat #16099

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06f2eae
doc: added note to fs.watchFile on previousStat
nikniv Oct 9, 2017
01a8da4
doc: corrected position of note on fs.watchFile
nikniv Oct 14, 2017
1041e87
doc: updated content of note on fs.watchFile
nikniv Oct 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2562,6 +2562,19 @@ v0.10.
`fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and
`fs.unwatchFile` when possible.

*Note:* When a file being watched by `fs.watchFile()` disappears and reappears,
then the `previousStat` reported in the second callback event (the file's
reappearance) will be the same as the `previousStat` of the first callback
event (its disappearance).

This happens when:
- the file is deleted, followed by a restore
- the file is renamed twice - the second time back to its original name

In such cases the reappearance callback will not report the `previousStat` of
the file with all zeroes. This is the correct and expected behavior for
`uv_fs_poll_start()`, the libuv function that `fs.watchFile()` uses internally.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph can be removed. The first sentence is redundant and the last sentence won't be relevant to most readers, they won't know or care it's implemented by libuv.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bnoordhuis Done!


## fs.write(fd, buffer[, offset[, length[, position]]], callback)
<!-- YAML
added: v0.0.2
Expand Down