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 — doc: add missing return types in fs.md by chasetonco · Pull Request #65307 · nodejs/node

Conversation

@chasetonco

@chasetonco chasetonco commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

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:

  • filehandle[Symbol.asyncDispose]() and dir[Symbol.asyncDispose]() both return a promise. This matches the existing Returns: {Promise} annotations on other async dispose methods, such as heapProfileHandle[Symbol.asyncDispose]() in v8.md.
  • new fs.Utf8Stream([options]) is a constructor and returns an instance of the class, annotated the same way as the fs.ReadStream and fs.WriteStream constructors in this file.

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. fs Issues and PRs related to file-system APIs and the fs module. labels Aug 15, 2026
jasnell
jasnell approved these changes Aug 15, 2026
View reviewed changes
lpinca
lpinca approved these changes Aug 15, 2026
View reviewed changes
@chasetonco
doc: add missing return types in fs.md
dfb19a4
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 <[email protected]>
@chasetonco
chasetonco force-pushed the doc-fs-return-types branch from f95269e to dfb19a4 Compare August 15, 2026 18:32
mertcanaltin
mertcanaltin approved these changes Aug 16, 2026
View reviewed changes
avivkeller
avivkeller approved these changes Aug 16, 2026
View reviewed changes
@avivkeller avivkeller added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. labels Aug 16, 2026
UlisesGascon
UlisesGascon approved these changes Aug 16, 2026
View reviewed changes
@nodejs-github-bot nodejs-github-bot added commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. and removed commit-queue PRs queued for automated landing through the Commit Queue. labels Aug 17, 2026
@nodejs-github-bot

nodejs-github-bot commented Aug 17, 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 <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/65307
Refs: https://github.com/nodejs/doc-kit/issues/953
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
------------------------------ 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 <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
--------------------------------------------------------------------------------
   ℹ  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/.ncu
https://github.com/nodejs/node/actions/runs/32045336475
All reactions

Sorry, something went wrong.

Uh oh!

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

@trivikr trivikr added commit-queue PRs queued for automated landing through the Commit Queue. and removed commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. labels Aug 18, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 205ef76 into nodejs:main Aug 18, 2026
30 checks passed

Uh oh!

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

@nodejs-github-bot

nodejs-github-bot commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Landed in 205ef76

All reactions

Sorry, something went wrong.

Uh oh!

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

@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 18, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
@chasetonco @aduh95
doc: add missing return types in fs.md
b99243c
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 <[email protected]>
PR-URL: #65307
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
@chasetonco @aduh95
doc: add missing return types in fs.md
262f966
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 <[email protected]>
PR-URL: #65307
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
@github-actions github-actions Bot mentioned this pull request Aug 25, 2026
2026-08-26, Version 26.8.0 (Current) #65551
Merged
aduh95 pushed a commit that referenced this pull request Aug 27, 2026
@chasetonco @aduh95
doc: add missing return types in fs.md
0f4ab49
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 <[email protected]>
PR-URL: #65307
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
@github-actions github-actions Bot mentioned this pull request Sep 7, 2026
2026-09-08, Version 24.21.0 'Krypton' (LTS) #65873
Merged
aduh95 pushed a commit that referenced this pull request Sep 7, 2026
@chasetonco @aduh95
doc: add missing return types in fs.md
a1e9c3a
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 <[email protected]>
PR-URL: #65307
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Aviv Keller <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
@Cayan Cayan mentioned this pull request Oct 2, 2026
doc: add missing return types in cluster.md #66453
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
@UlisesGascon UlisesGascon UlisesGascon approved these changes
@avivkeller avivkeller avivkeller approved these changes
+1 more reviewer
@mertcanaltin mertcanaltin mertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

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. doc Issues and PRs related to Node.js documentation. fs Issues and PRs related to file-system APIs and the fs module.

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.

8 participants

@chasetonco @nodejs-github-bot @jasnell @lpinca @UlisesGascon @mertcanaltin @avivkeller @trivikr
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.