FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fs: update param in jsdoc for `readdir` by pluris · Pull Request #50448 · nodejs/node · GitHub

/ node Public

fs: update param in jsdoc for readdir - #50448

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
pluris:fs/jsdoc
Oct 30, 2023
ConversationCommits (1)ChecksFiles changed
Merged

fs: update param in jsdoc for readdir#50448
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
pluris:fs/jsdoc

Conversation

pluris commented Oct 28, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fixed inconsistencies between jsdoc and api documentation.

  • recursive is missing
  • Dirent is written as Direct

node/doc/api/fs.md

Lines 3672 to 3681 in 4c3dde9

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* `withFileTypes` {boolean} **Default:** `false`
* `recursive` {boolean} If `true`, reads the contents of a directory
recursively. In recursive mode, it will list all files, sub files and
directories. **Default:** `false`.
* `callback` {Function}
* `err` {Error}
* `files` {string\[]|Buffer\[]|fs.Dirent\[]}

nodejs-github-bot added fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run. labels Oct 28, 2023
anonrig added author ready PRs that have at least one approval, no outstanding review comments, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Oct 28, 2023
github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 28, 2023

nodejs-github-bot commented Oct 28, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/55295/

github-actions Bot mentioned this pull request Oct 29, 2023
Open
21 tasks

nodejs-github-bot commented Oct 29, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/55305/

deokjinkim added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 29, 2023
github-actions Bot mentioned this pull request Oct 30, 2023
Open
25 tasks
nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 30, 2023
nodejs-github-bot merged commit 63494a9 into nodejs:main Oct 30, 2023

nodejs-github-bot commented Oct 30, 2023

Copy link
Copy Markdown
Collaborator

Landed in 63494a9

This was referenced Oct 31, 2023
Open
Open
pluris deleted the fs/jsdoc branch November 8, 2023 02:23
targos pushed a commit that referenced this pull request Nov 11, 2023
fs: update param in jsdoc for readdir
b5308be 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
targos mentioned this pull request Nov 12, 2023
Merged
targos pushed a commit that referenced this pull request Nov 14, 2023
fs: update param in jsdoc for readdir
44f19ce 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
UlisesGascon pushed a commit that referenced this pull request Dec 11, 2023
fs: update param in jsdoc for readdir
d1b6bd6 
PR-URL: #50448
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
UlisesGascon mentioned this pull request Dec 12, 2023
Merged
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
lpinca lpinca approved these changes
anonrig anonrig approved these changes
deokjinkim deokjinkim approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL