From 23a8aed3f9cc8ed450e181f8bf805110421547f0 Mon Sep 17 00:00:00 2001 From: Bryan Field Date: Tue, 4 May 2021 18:56:54 -0500 Subject: [PATCH] doc: typo stats() should be stat(); clarity PR-URL: https://github.com/nodejs/node/pull/38541 Reviewed-By: Anna Henningsen Reviewed-By: James M Snell Reviewed-By: Rich Trott Reviewed-By: Darshan Sen --- 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 68725fb7960be6..4289c972383d15 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])` @@ -6672,6 +6673,7 @@ the file contents. [`fs.writev()`]: #fs_fs_writev_fd_buffers_position_callback [`fsPromises.open()`]: #fs_fspromises_open_path_flags_mode [`fsPromises.opendir()`]: #fs_fspromises_opendir_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