doc: clarify fs.ReadStream and fs.WriteStream are not constructable#62208
Open
kovan wants to merge 2 commits intonodejs:mainfrom
Open
doc: clarify fs.ReadStream and fs.WriteStream are not constructable#62208kovan wants to merge 2 commits intonodejs:mainfrom
kovan wants to merge 2 commits intonodejs:mainfrom
Conversation
Add explicit wording that fs.ReadStream and fs.WriteStream should not
be constructed directly, matching the existing pattern used by fs.Stats
("not to be created directly using the new keyword"). The factory
functions fs.createReadStream() and fs.createWriteStream() are the
supported API.
Fixes: nodejs#40546
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
nodejs-github-bot
added
doc
Renegade334
reviewed
Mar 14, 2026
doc/api/fs.md
Outdated
Comment on lines
+7150
to
+7151
| Instances of {fs.ReadStream} are created and returned using the | ||
| [`fs.createReadStream()`][] function. | ||
| `fs.ReadStream` is not to be constructed directly; use | ||
| [`fs.createReadStream()`][] instead. |
Member
There was a problem hiding this comment.
No issues in principle, but I think this would scan better as a combination of your wording and the original wording, eg.
Instances of {fs.ReadStream} cannot be constructed directly. They are created and
returned using the [`fs.createReadStream()`][] function.
…table apply reviewer suggestion: combine wording
Renegade334
approved these changes
Mar 14, 2026
Renegade334
added
the
author ready
lpinca
approved these changes
Mar 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add explicit wording that
fs.ReadStreamandfs.WriteStreamshould not be constructed directly, matching the existing pattern
used by
fs.Stats("not to be created directly using thenewkeyword"). The factory functions
fs.createReadStream()andfs.createWriteStream()are the supported API.Verified against
lib/internal/fs/streams.js— the constructorsexist as plain functions with
newguards, but are not documentedas public constructors.
Fixes: #40546