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

@chasetoncochasetonco 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

@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller 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
@nodejs-github-botnodejs-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 <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

@trivikrtrivikr 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:mainAug 18, 2026
30 checks passed
@nodejs-github-bot

nodejs-github-bot commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Landed in 205ef76

@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot mentioned this pull request Aug 25, 2026
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 <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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes
+1 more reviewer
@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

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
@chasetoncochasetonco
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
@nodejs-github-botnodejs-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
@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 <43923165+Chxxeton@users.noreply.github.com>
@avivkelleravivkeller
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
@nodejs-github-botnodejs-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 <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
@trivikrtrivikr
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:mainAug 18, 2026

30 checks passed

@nodejs-github-bot
nodejs-github-bot
commented
Aug 18, 2026

Copy link


Copy Markdown

Collaborator
Landed in 205ef76
@nodejs-github-botnodejs-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 <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
@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 <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>
@github-actionsgithub-actionsBot
mentioned this pull request
Aug 25, 2026
 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 <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>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@UlisesGasconUlisesGasconUlisesGascon approved these changes
@avivkelleravivkelleravivkeller approved these changes

+1 more reviewer

@mertcanaltinmertcanaltinmertcanaltin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.docIssues and PRs related to Node.js documentation.fsIssues 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.

8 participants

@chasetonco@nodejs-github-bot@jasnell@lpinca@UlisesGascon@mertcanaltin@avivkeller@trivikr