From fb74491c8783d870494416a95a8d06b31b645aa2 Mon Sep 17 00:00:00 2001 From: Bryan Field Date: Tue, 4 May 2021 18:56:54 -0500 Subject: [PATCH 1/2] doc: typo stats() should be stat(); clarity --- doc/api/fs.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 7595c1e314e7cb..df7be12e1d31fb 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -775,7 +775,8 @@ changes: * Returns: {Promise} Fulfills with the {fs.Stats} object for the given symbolic link `path`. -Equivalent to `fsPromises.stats()` when `path` refers to a symbolic link. +Equivalent to [`fsPromises.stat()`] unless `path` refers to a symbolic link, +in which case the link itself is stat-ed, not the file that it refers to. Refer to the POSIX lstat(2) document for more detail. ### `fsPromises.mkdir(path[, options])` @@ -6718,6 +6719,7 @@ the file contents. [`fsPromises.open()`]: #fs_fspromises_open_path_flags_mode [`fsPromises.opendir()`]: #fs_fspromises_opendir_path_options [`fsPromises.rm()`]: #fs_fspromises_rm_path_options +[`fsPromises.stat()`]: #fs_fspromises_stat_path_options [`fsPromises.utimes()`]: #fs_fspromises_utimes_path_atime_mtime [`inotify(7)`]: https://man7.org/linux/man-pages/man7/inotify.7.html [`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 From 9e4b3575ae8109b0e0ba033252bdf7396b531989 Mon Sep 17 00:00:00 2001 From: Bryan Field Date: Wed, 5 May 2021 13:36:06 -0500 Subject: [PATCH 2/2] fix lint Co-authored-by: Voltrex <62040526+VoltrexMaster@users.noreply.github.com> --- doc/api/fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index df7be12e1d31fb..edd7054d6aab36 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -775,7 +775,7 @@ changes: * Returns: {Promise} Fulfills with the {fs.Stats} object for the given symbolic link `path`. -Equivalent to [`fsPromises.stat()`] unless `path` refers to a symbolic link, +Equivalent to [`fsPromises.stat()`][] unless `path` refers to a symbolic link, in which case the link itself is stat-ed, not the file that it refers to. Refer to the POSIX lstat(2) document for more detail.