Skip to content

Commit 30f52fb

Browse files
authored
doc/api/fs: Correct note on stats.isDirectory
Original author incorrectly assumed that lstat can _only_ be used on symbolic links
1 parent 95b1989 commit 30f52fb

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
@@ -6970,8 +6970,9 @@ added: v0.1.10
69706970
69716971
Returns `true` if the {fs.Stats} object describes a file system directory.
69726972
6973-
If the {fs.Stats} object was obtained from [`fs.lstat()`][], this method will
6974-
always return `false`. This is because [`fs.lstat()`][] returns information
6973+
If the {fs.Stats} object was obtained from calling [`fs.lstat()`][] on a
6974+
symbolic link which resolves to a directory, this method will return false.
6975+
This is because [`fs.lstat()`][] returns information
69756976
about a symbolic link itself and not the path it resolves to.
69766977
69776978
#### `stats.isFIFO()`

0 commit comments

Comments
 (0)