doc: Add example to fs.promises.readdir #31552
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
jasnell
reviewed
Jan 28, 2020
jasnell
approved these changes
Jan 28, 2020
Co-Authored-By: James M Snell <jasnell@gmail.com>
addaleax
approved these changes
Jan 28, 2020
addaleax
added
the
author ready
lpinca
approved these changes
Jan 28, 2020
Trott
reviewed
Jan 31, 2020
doc/api/fs.md
Outdated
| @@ -4929,6 +4929,20 @@ will be passed as `Buffer` objects. | |||
| If `options.withFileTypes` is set to `true`, the resolved array will contain | |||
| [`fs.Dirent`][] objects. | |||
|
|
|||
| Example iterating over a directory listing: | |||
There was a problem hiding this comment.
You can probably omit this line and simply show the example code. If you want to include // Iterate over a directory listing. as a comment in the example code, that would be better IMO. The example code and surrounding text should be related but independent.
Trott
approved these changes
Jan 31, 2020
jasnell
reviewed
Feb 3, 2020
addaleax
pushed a commit
that referenced
this pull request
Feb 5, 2020
PR-URL: #31552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
|
Landed in 7e911d8, and thanks for the PR! :) 🎉 |
codebytere
pushed a commit
that referenced
this pull request
Feb 17, 2020
PR-URL: #31552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Mar 15, 2020
PR-URL: #31552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
codebytere
pushed a commit
that referenced
this pull request
Mar 17, 2020
PR-URL: #31552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Mar 30, 2020
PR-URL: #31552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes