Skip to content

doc: list macOS as supporting filename argument #13111

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
chris--young wants to merge 3 commits into from
Closed

doc: list macOS as supporting filename argument #13111

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fee2e8
doc: list macOS as supporting filename argument
May 19, 2017
9bd4012
test: check fs.watch filename on Linux and macOS
May 19, 2017
64884c2
test: fs.watch filename check for Windows & AIX
May 19, 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
Prev Previous commit
test: fs.watch filename check for Windows & AIX 
Fixes: #13108
  • Loading branch information
Chris Young
Chris Young committed May 22, 2017
commit 64884c2a5c1371a645215a0caec8fdcd39e994d2
2 changes: 1 addition & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2406,7 +2406,7 @@ this improves the usability of file watching. This is expected behavior.
<!--type=misc-->

Providing `filename` argument in the callback is only supported on Linux,
macOS, and Windows. Even on supported platforms, `filename` is not always
macOS, Windows, and AIX. Even on supported platforms, `filename` is not always
guaranteed to be provided. Therefore, don't assume that `filename` argument is
always provided in the callback, and have some fallback logic if it is null.

Expand Down
14 changes: 5 additions & 9 deletions test/parallel/test-fs-watchfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,24 +64,20 @@ fs.watchFile(enoentFile, {interval: 0}, common.mustCall(function(curr, prev) {
}
}, 2));

// Watch events should callback with a filename
if (common.isLinux || common.isOSX) {
// Watch events should callback with a filename on supported systems
if (common.isLinux || common.isOSX || common.isWindows || common.isAix) {
const dir = common.tmpDir + '/watch';

fs.mkdir(dir, common.mustCall(function(err) {
assert(!err);
if (err) assert.fail(err);

fs.watch(dir, common.mustCall(function(eventType, filename) {
this._handle.close();
common.refreshTmpDir();
assert.strictEqual(filename, 'foo.txt');
}));

fs.writeFile(`${dir}/foo.txt`, 'foo', common.mustCall((err) => {
if (err) {
common.refreshTmpDir();
assert(!err);
}
fs.writeFile(`${dir}/foo.txt`, 'foo', common.mustCall(function(err) {
if (err) assert.fail(err);
}));
}));
}