doc: add withFileTypes option to fsPromises.readdir

PR-URL: #22833 Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Sep 20, 2018 · ed142e1 · ed142e1
1 parent 8e8748c
commit ed142e1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -4170,11 +4170,16 @@ a colon, Node.js will open a file system stream, as described by
 ### fsPromises.readdir(path[, options])
 <!-- YAML
 added: v10.0.0
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/22020
+    description: New option `withFileTypes` was added.
 -->
 
 * `path` {string|Buffer|URL}
 * `options` {string|Object}
   * `encoding` {string} **Default:** `'utf8'`
+  * `withFileTypes` {boolean} **Default:** `false`
 * Returns: {Promise}
 
 Reads the contents of a directory then resolves the `Promise` with an array
@@ -4185,6 +4190,9 @@ object with an `encoding` property specifying the character encoding to use for
 the filenames. If the `encoding` is set to `'buffer'`, the filenames returned
 will be passed as `Buffer` objects.
 
+If `options.withFileTypes` is set to `true`, the resolved array will contain
+[`fs.Dirent`][] objects.
+
 ### fsPromises.readFile(path[, options])
 <!-- YAML
 added: v10.0.0