Skip to content

Commit

Permalink
doc,fs: document value of stats.isDirectory on symbolic links
Browse files Browse the repository at this point in the history
PR-URL: #27413
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
coderaiser authored and BethGriggs committed Dec 15, 2020
1 parent d2ee676 commit 17c3fc6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 17c3fc6

Please sign in to comment.