From b2847b305cea9446264cfbeb19f527e3045b0233 Mon Sep 17 00:00:00 2001 From: tjaisson Date: Sat, 16 Nov 2024 12:57:38 +0100 Subject: [PATCH] doc: add warning about #55764 --- doc/api/fs.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 4fafdc453b0603..d4a528582d79d1 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1340,7 +1340,9 @@ changes: internally when reading from the directory. Higher values lead to better performance but higher memory usage. **Default:** `32` * `recursive` {boolean} Resolved `Dir` will be an {AsyncIterable} - containing all sub files and directories. **Default:** `false` + containing all sub files and directories. Warning: a bug ([#55764][]) + about to be fixed but still affecting all current versions + prevents recursive mode from working as expected. **Default:** `false` * Returns: {Promise} Fulfills with an {fs.Dir}. Asynchronously open a directory for iterative scanning. See the POSIX @@ -8426,3 +8428,4 @@ the file contents. [chcp]: https://ss64.com/nt/chcp.html [inode]: https://en.wikipedia.org/wiki/Inode [support of file system `flags`]: #file-system-flags +[#55764]: https://github.com/nodejs/node/issues/55764 \ No newline at end of file