doc,fs: document value of stats.isDirectory on symbolic links

PR-URL: #27413 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
nodejs · Nov 9, 2020 · 85cf305 · 85cf305
1 parent eea7e3b
commit 85cf305
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -826,6 +826,10 @@ 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
+about a symbolic link itself and not the path it resolves to.
+
 ### `stats.isFIFO()`
 <!-- YAML
 added: v0.1.10