Skip to content

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

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

Closed
niveditn wants to merge 3 commits into from
Closed

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06f2eae
doc: added note to fs.watchFile on previousStat
niveditn Oct 9, 2017
01a8da4
doc: corrected position of note on fs.watchFile
niveditn Oct 14, 2017
1041e87
doc: updated content of note on fs.watchFile
niveditn 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
Next Next commit
doc: added note to fs.watchFile on previousStat 
Explains the expected behavior of previousStat in fs.watchFile() when
a watched file disappears and reappears.

Fixes: #15364
  • Loading branch information
@niveditn
niveditn committed Oct 9, 2017
commit 06f2eaeffd65887ec4181a594d1f2a7a98a1f0cf
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 @@ -626,6 +626,19 @@ Any specified file descriptor has to have been opened for appending.
*Note*: If a file descriptor is specified as the `file`, it will not be closed
automatically.

*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
Copy Markdown
Member

@gireeshpunathil gireeshpunathil Oct 14, 2017

Choose a reason for hiding this comment

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

Why this is documented under Appendfile, as opposed to watchFile?

Copy link
Copy Markdown
Contributor Author

@niveditn niveditn Oct 14, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@gireeshpunathil Corrected. Thanks for pointing that out! It would be great if you could please review again.

Copy link
Copy Markdown
Member

@gireeshpunathil gireeshpunathil Oct 14, 2017

Choose a reason for hiding this comment

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

great, thanks!

## fs.appendFileSync(file, data[, options])
<!-- YAML
added: v0.6.7
Expand Down