Skip to content
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

doc: typo stats() should be stat(); clarity #38541

Closed
wants to merge 2 commits into from
+3 −1
Closed

doc: typo stats() should be stat(); clarity #38541

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb74491
doc: typo stats() should be stat(); clarity
700software May 4, 2021
9e4b357
fix lint
700software May 5, 2021
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
4 changes: 3 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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,
700software marked this conversation as resolved.
Show resolved Hide resolved
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