From e636d839147645dc119b3bfa39d3f90118b7b0ed Mon Sep 17 00:00:00 2001 From: Nick Reilingh Date: Mon, 18 Dec 2023 12:25:37 -0500 Subject: [PATCH] doc: correct note on behavior of stats.isDirectory PR-URL: https://github.com/nodejs/node/pull/50946 Reviewed-By: Luigi Pinca Reviewed-By: Daijiro Wachi Reviewed-By: James M Snell --- doc/api/fs.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 46987b21bbd41f..ab51410d2431f8 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -6968,8 +6968,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()`