FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: clarify how fs.Dirent file types are determined · nodejs/node@89aba0c · GitHub

/ node Public

Commit 89aba0c

Browse files
soreavis
authored and
aduh95
committed
doc: clarify how fs.Dirent file types are determined
The file type of a directory entry returned by fs.readdir() or fs.opendir() is the type reported by the operating system's directory listing. Node.js falls back to lstat() only when the reported type is unknown, and some file systems may report a type that differs from what lstat() would return. Document this in the fs.Dirent class introduction, with fs.lstat() as the accurate alternative. Fixes: #30646 Signed-off-by: Julian Soreavis <julian.soreavis@gmail.com> PR-URL: #64532 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jason Zhang <xzha4350@gmail.com>
1 parent 3ed0492 commit 89aba0c

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7386,6 +7386,13 @@ Additionally, when [`fs.readdir()`][] or [`fs.readdirSync()`][] is called with
73867386
the `withFileTypes` option set to `true`, the resulting array is filled with
73877387
{fs.Dirent} objects, rather than strings or {Buffer}s.
73887388
7389+
When a directory is read, such as with [`fs.readdir()`][] or
7390+
[`fs.opendir()`][], the file type of each entry is the type reported by the
7391+
operating system and may depend on the file system; for example, some file
7392+
systems may report a type that differs from what [`fs.lstat()`][] returns.
7393+
Node.js calls [`fs.lstat()`][] on such an entry only when the reported type
7394+
is unknown. Use [`fs.lstat()`][] when an accurate file type is required.
7395+
73897396
#### `dirent.isBlockDevice()`
73907397
73917398
<!-- YAML

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL