GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — fs: update param in jsdoc for `readdir` by pluris · Pull Request #50448 · nodejs/node

Conversation

@pluris

@pluris pluris commented Oct 28, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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\[]}

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bricss reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
pluris
fs: update param in jsdoc for readdir
b9a2b95
@nodejs-github-bot nodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Oct 28, 2023
jasnell
jasnell approved these changes Oct 28, 2023
View reviewed changes
anonrig
anonrig approved these changes Oct 28, 2023
View reviewed changes
@anonrig anonrig added author ready PRs with CI started, the required approvals, and no outstanding review comments. request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. labels Oct 28, 2023
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Oct 28, 2023
@nodejs-github-bot

nodejs-github-bot commented Oct 28, 2023

Copy link
Copy Markdown
Collaborator

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
lpinca
lpinca approved these changes Oct 28, 2023
View reviewed changes
@github-actions github-actions Bot mentioned this pull request Oct 29, 2023
CI Reliability 2023-10-29 nodejs/reliability#701
Open
21 tasks
@nodejs-github-bot

nodejs-github-bot commented Oct 29, 2023

Copy link
Copy Markdown
Collaborator

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
deokjinkim
deokjinkim approved these changes Oct 29, 2023
View reviewed changes
@deokjinkim deokjinkim added the commit-queue PRs queued for automated landing through the Commit Queue. label Oct 29, 2023
@github-actions github-actions Bot mentioned this pull request Oct 30, 2023
CI Reliability 2023-10-30 nodejs/reliability#702
Open
25 tasks
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Oct 30, 2023
@nodejs-github-bot
nodejs-github-bot merged commit 63494a9 into nodejs:main Oct 30, 2023
@nodejs-github-bot

nodejs-github-bot commented Oct 30, 2023

Copy link
Copy Markdown
Collaborator

Landed in 63494a9
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
This was referenced Oct 31, 2023
CI Reliability 2023-10-31 nodejs/reliability#703
Open
CI Reliability 2023-11-01 nodejs/reliability#704
Open
@pluris
pluris deleted the fs/jsdoc branch November 8, 2023 02:23
targos pushed a commit that referenced this pull request Nov 11, 2023
Jungku Lee @targos
fs: update param in jsdoc for readdir
b5308be 
PR-URL: #50448
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@targos targos mentioned this pull request Nov 12, 2023
v21.2.0 release proposal #50681
Merged
targos pushed a commit that referenced this pull request Nov 14, 2023
Jungku Lee @targos
fs: update param in jsdoc for readdir
44f19ce 
PR-URL: #50448
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
UlisesGascon pushed a commit that referenced this pull request Dec 11, 2023
Jungku Lee @UlisesGascon
fs: update param in jsdoc for readdir
d1b6bd6 
PR-URL: #50448
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@UlisesGascon UlisesGascon mentioned this pull request Dec 12, 2023
v20.11.0 proposal #51124
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. fs Issues and PRs related to file-system APIs and the fs module. 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.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@pluris @nodejs-github-bot @jasnell @lpinca @anonrig @deokjinkim
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.