Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add warning about #55764 #55876

Closed
wants to merge 1 commit into from
Closed

doc: add warning about #55764 #55876

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Loading