diff options
| author | Eileen <eileenlu0306@gmail.com> | 2020-04-11 18:11:44 -0700 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2020-04-28 16:28:30 +0100 |
| commit | 7e9f88e0053010c47923656d55ff59d09baddea9 (patch) | |
| tree | 2fae160e3902b736350f7ee0534944cb9a269ef9 | |
| parent | 45e188b2e3d64bdc8e96396e27db73209f116ae1 (diff) | |
| download | node-new-7e9f88e0053010c47923656d55ff59d09baddea9.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 fa87f017d8..a899686cae 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 |