Skip to content

doc: Add example to fs.promises.readdir - #31552

Closed
conoro wants to merge 3 commits into
nodejs:masterfrom
conoro:code-and-learn
Closed

doc: Add example to fs.promises.readdir#31552
conoro wants to merge 3 commits into
nodejs:masterfrom
conoro:code-and-learn

Conversation

@conoro

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jan 28, 2020
Comment threaddoc/api/fs.md Outdated

@jasnelljasnell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with the suggested change.

Co-Authored-By: James M Snell <jasnell@gmail.com>
@addaleaxaddaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 28, 2020
Comment threaddoc/api/fs.md Outdated
If `options.withFileTypes` is set to `true`, the resolved array will contain
[`fs.Dirent`][] objects.

Example iterating over a directory listing:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment threaddoc/api/fs.md Outdated
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>
@addaleax

Copy link
Copy Markdown
Member

Landed in 7e911d8, and thanks for the PR! :) 🎉

@addaleaxaddaleax closed this Feb 5, 2020
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>
@codebyterecodebytere mentioned this pull request Feb 17, 2020
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>
@codebyterecodebytere mentioned this pull request Mar 17, 2020
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@conoro@addaleax@jasnell@Trott@lpinca@nodejs-github-bot