Skip to content

doc: add missing return types in fs.md - #65307

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
chasetonco:doc-fs-return-types
Aug 18, 2026
Merged

doc: add missing return types in fs.md#65307
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
chasetonco:doc-fs-return-types

Conversation

@chasetonco

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

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels 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
chasetonco force-pushed the doc-fs-return-types branch from f95269e to dfb19a4 Compare August 15, 2026 18:32
@avivkeller avivkeller added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 16, 2026
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 17, 2026
@nodejs-github-bot

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/.ncu
https://github.com/nodejs/node/actions/runs/32045336475

@trivikr trivikr added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Aug 18, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 205ef76 into nodejs:main Aug 18, 2026
30 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 205ef76

@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants