doc,fs: update description of fs.stat() method

PR-URL: #47654 Fixes: #47633 Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daeyeon Jeong <[email protected]> Reviewed-By: LiviaMedeiros <[email protected]>
nodejs · Jul 6, 2023 · 8651ea8 · 8651ea8
1 parent d4eecb5
commit 8651ea8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -4066,6 +4066,9 @@ Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
 
 In case of an error, the `err.code` will be one of [Common System Errors][].
 
+[`fs.stat()`][] follows symbolic links. Use [`fs.lstat()`][] to look at the
+links themselves.
+
 Using `fs.stat()` to check for the existence of a file before calling
 `fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended.
 Instead, user code should open/read/write the file directly and handle the