Skip to content

Commit 56bf6c1

Browse files
700softwaretargos
authored andcommitted
doc: typo stats() should be stat(); clarity
PR-URL: #38541 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]>
1 parent 16a6c8d commit 56bf6c1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/fs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,8 @@ changes:
775775
* Returns: {Promise} Fulfills with the {fs.Stats} object for the given
776776
symbolic link `path`.
777777
778-
Equivalent to `fsPromises.stats()` when `path` refers to a symbolic link.
778+
Equivalent to [`fsPromises.stat()`][] unless `path` refers to a symbolic link,
779+
in which case the link itself is stat-ed, not the file that it refers to.
779780
Refer to the POSIX lstat(2) document for more detail.
780781
781782
### `fsPromises.mkdir(path[, options])`
@@ -6718,6 +6719,7 @@ the file contents.
67186719
[`fsPromises.open()`]: #fs_fspromises_open_path_flags_mode
67196720
[`fsPromises.opendir()`]: #fs_fspromises_opendir_path_options
67206721
[`fsPromises.rm()`]: #fs_fspromises_rm_path_options
6722+
[`fsPromises.stat()`]: #fs_fspromises_stat_path_options
67216723
[`fsPromises.utimes()`]: #fs_fspromises_utimes_path_atime_mtime
67226724
[`inotify(7)`]: https://man7.org/linux/man-pages/man7/inotify.7.html
67236725
[`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2

0 commit comments

Comments
 (0)