Skip to content

doc: Correct note on behavior of stats.isDirectory #50946

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

Merged
nodejs-github-bot merged 2 commits into from
Dec 18, 2023
Merged

doc: Correct note on behavior of stats.isDirectory #50946

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0aa00c9
doc: correct note on behavior of stats.isDirectory
NReilingh Nov 27, 2023
952de7a
Update doc/api/fs.md: Fix `false` backticks
NReilingh Dec 1, 2023
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
Next Next commit
doc: correct note on behavior of stats.isDirectory
  • Loading branch information
@NReilingh
NReilingh committed Dec 18, 2023
commit 0aa00c96035c311094b35eead6b165f5ece94bde
5 changes: 3 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6970,8 +6970,9 @@ added: v0.1.10

Returns `true` if the {fs.Stats} object describes a file system directory.

If the {fs.Stats} object was obtained from [`fs.lstat()`][], this method will
always return `false`. This is because [`fs.lstat()`][] returns information
If the {fs.Stats} object was obtained from calling [`fs.lstat()`][] on a
symbolic link which resolves to a directory, this method will return false.
Comment thread
NReilingh marked this conversation as resolved.
Outdated
This is because [`fs.lstat()`][] returns information
about a symbolic link itself and not the path it resolves to.

#### `stats.isFIFO()`
Expand Down