doc: add missing return types in fs.md - #65307
Merged
nodejs-github-bot merged 1 commit intoAug 18, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
jasnell
approved these changes
Aug 15, 2026
lpinca
approved these changes
Aug 15, 2026
Three entries in the fs documentation described their return
value only in prose, or not at all, so doc-kit could not parse
a return type and fell back to `void`:
* `filehandle[Symbol.asyncDispose]()` and
`dir[Symbol.asyncDispose]()` both return a promise, matching
the existing `Returns: {Promise}` annotations on other async
dispose methods.
* `new fs.Utf8Stream([options])` is a constructor and returns
an instance of the class.
Verified at runtime and by rendering the page locally with
doc-kit.
Refs: nodejs/doc-kit#953
Signed-off-by: Chxxeton <43923165+Chxxeton@users.noreply.github.com>
chasetonco
force-pushed
the
doc-fs-return-types
branch
from
f95269e to
dfb19a4
Compare
August 15, 2026 18:32
mertcanaltin
approved these changes
Aug 16, 2026
avivkeller
approved these changes
Aug 16, 2026
UlisesGascon
approved these changes
Aug 16, 2026
Copy link
Copy Markdown
Collaborator
Commit Queue failed- Loading data for nodejs/node/pull/65307 ✔ Done loading data for nodejs/node/pull/65307 ----------------------------------- PR info ------------------------------------ Title doc: add missing return types in fs.md (#65307) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch chasetonco:doc-fs-return-types -> nodejs:main Labels doc, fs, author ready, commit-queue Commits 1 - doc: add missing return types in fs.md Committers 1 - Chxxeton <43923165+Chxxeton@users.noreply.github.com> PR-URL: https://github.com/nodejs/node/pull/65307 Refs: https://github.com/nodejs/doc-kit/issues/953 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Aviv Keller <me@aviv.sh> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/65307 Refs: https://github.com/nodejs/doc-kit/issues/953 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Aviv Keller <me@aviv.sh> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> -------------------------------------------------------------------------------- ℹ This PR was created on Sat, 15 Aug 2026 14:13:12 GMT ✔ Approvals: 4 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/65307#pullrequestreview-4944187613 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/65307#pullrequestreview-4944240692 ✔ - Aviv Keller (@avivkeller): https://github.com/nodejs/node/pull/65307#pullrequestreview-4946336401 ✔ - Ulises Gascón (@UlisesGascon): https://github.com/nodejs/node/pull/65307#pullrequestreview-4946351571 ✘ 4 GitHub CI job(s) failed: ✘ - github-actions: ACTION_REQUIRED ✘ - github-actions: ACTION_REQUIRED ✘ - github-actions: ACTION_REQUIRED ✘ - github-actions: ACTION_REQUIRED ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/32045336475 |
Sorry, something went wrong.
aduh95
pushed a commit
that referenced
this pull request
Aug 25, 2026
Three entries in the fs documentation described their return
value only in prose, or not at all, so doc-kit could not parse
a return type and fell back to `void`:
* `filehandle[Symbol.asyncDispose]()` and
`dir[Symbol.asyncDispose]()` both return a promise, matching
the existing `Returns: {Promise}` annotations on other async
dispose methods.
* `new fs.Utf8Stream([options])` is a constructor and returns
an instance of the class.
Verified at runtime and by rendering the page locally with
doc-kit.
Refs: nodejs/doc-kit#953
Signed-off-by: Chxxeton <43923165+Chxxeton@users.noreply.github.com>
PR-URL: #65307
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
aduh95
pushed a commit
that referenced
this pull request
Aug 25, 2026
Three entries in the fs documentation described their return
value only in prose, or not at all, so doc-kit could not parse
a return type and fell back to `void`:
* `filehandle[Symbol.asyncDispose]()` and
`dir[Symbol.asyncDispose]()` both return a promise, matching
the existing `Returns: {Promise}` annotations on other async
dispose methods.
* `new fs.Utf8Stream([options])` is a constructor and returns
an instance of the class.
Verified at runtime and by rendering the page locally with
doc-kit.
Refs: nodejs/doc-kit#953
Signed-off-by: Chxxeton <43923165+Chxxeton@users.noreply.github.com>
PR-URL: #65307
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
8 participants
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.
Three entries in the fs documentation described their return value only in prose, or not at all, so the documentation tooling could not parse a return type and fell back to void:
No prose was changed; only the structured Returns: lines were added.
Verified by calling each function on a local build and by rendering fs.md locally, which now shows Promise, Promise and fs.Utf8Stream instead of void.
Refs: nodejs/doc-kit#953