Skip to content

Commit

Permalink
doc: typo stats() should be stat(); clarity
Browse files Browse the repository at this point in the history
PR-URL: #38541
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
  • Loading branch information
700software authored and targos committed May 17, 2021
1 parent 16a6c8d commit 56bf6c1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/fs.md
Expand Up @@ -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])`
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 56bf6c1

Please sign in to comment.