diff options
| author | Eileen <eileenlu0306@gmail.com> | 2020-04-11 18:11:44 -0700 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2020-04-28 13:58:23 +0200 |
| commit | fae1aed6ff0ac67fa3981830a45ccceb61ac3d93 (patch) | |
| tree | 1125402e855eae64f6f4ea03ff980aa65cb4ccf1 | |
| parent | 4169bc4d1705d8cd178346ace991f667f604e418 (diff) | |
| download | node-new-fae1aed6ff0ac67fa3981830a45ccceb61ac3d93.tar.gz | |
doc: updated directory entry information
Fixes: https://github.com/nodejs/node/issues/25595
subdirectory
updated def
PR-URL: https://github.com/nodejs/node/pull/32791
Reviewed-By: Anna Henningsen <anna@addaleax.net>
| -rw-r--r-- | doc/api/fs.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index e9083e1aec..cd9a51963b 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -430,8 +430,9 @@ included in the iteration results. added: v10.10.0 --> -A representation of a directory entry, as returned by reading from an -[`fs.Dir`][]. +A representation of a directory entry, which can be a file or a subdirectory +within the directory, as returned by reading from an [`fs.Dir`][]. The +directory entry is a combination of the file name and file type pairs. Additionally, when [`fs.readdir()`][] or [`fs.readdirSync()`][] is called with the `withFileTypes` option set to `true`, the resulting array is filled with |