Skip to content

Commit

Permalink
doc: updated directory entry information
Browse files Browse the repository at this point in the history
Fixes: #25595

subdirectory

updated def

PR-URL: #32791
Reviewed-By: Anna Henningsen <[email protected]>
  • Loading branch information
Eileen authored and BethGriggs committed Apr 28, 2020
1 parent 45e188b commit 7e9f88e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7e9f88e

Please sign in to comment.