Skip to content

Commit 2a61602

Browse files
NReilinghrichardlau
authored andcommitted
doc: correct note on behavior of stats.isDirectory
PR-URL: #50946 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 184b8be commit 2a61602

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/fs.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6932,8 +6932,9 @@ added: v0.1.10
69326932
69336933
Returns `true` if the {fs.Stats} object describes a file system directory.
69346934
6935-
If the {fs.Stats} object was obtained from [`fs.lstat()`][], this method will
6936-
always return `false`. This is because [`fs.lstat()`][] returns information
6935+
If the {fs.Stats} object was obtained from calling [`fs.lstat()`][] on a
6936+
symbolic link which resolves to a directory, this method will return `false`.
6937+
This is because [`fs.lstat()`][] returns information
69376938
about a symbolic link itself and not the path it resolves to.
69386939
69396940
#### `stats.isFIFO()`

0 commit comments

Comments
 (0)