Skip to content

Commit

Permalink
doc: correct note on behavior of stats.isDirectory
Browse files Browse the repository at this point in the history
PR-URL: #50946
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
NReilingh authored and richardlau committed Mar 25, 2024
1 parent 184b8be commit 2a61602
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6932,8 +6932,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`.
This is because [`fs.lstat()`][] returns information
about a symbolic link itself and not the path it resolves to.
#### `stats.isFIFO()`
Expand Down

0 comments on commit 2a61602

Please sign in to comment.