From cb7dae33859ec82a7dfe8fb378f1f585a471765f Mon Sep 17 00:00:00 2001 From: Eileen Date: Sat, 11 Apr 2020 18:11:44 -0700 Subject: [PATCH] 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 --- doc/api/fs.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index eb65562852b2bf..691e329e467546 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