Skip to content

doc: clarify fs.ReadStream and fs.WriteStream are not constructable #62208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 2 commits into from
Mar 17, 2026
+4 −4
Merged

doc: clarify fs.ReadStream and fs.WriteStream are not constructable #62208

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10646ba
doc: clarify fs.ReadStream and fs.WriteStream are not constructable
kovan Mar 11, 2026
74287d8
fixup! doc: clarify fs.ReadStream and fs.WriteStream are not construc…
kovan Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7147,8 +7147,8 @@ added: v0.1.93

* Extends: {stream.Readable}

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.
Copy link
Copy Markdown
Member

@Renegade334 Renegade334 Mar 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


#### Event: `'close'`

Expand Down Expand Up @@ -7918,8 +7918,8 @@ added: v0.1.93

* Extends {stream.Writable}

Instances of {fs.WriteStream} are created and returned using the
[`fs.createWriteStream()`][] function.
`fs.WriteStream` is not to be constructed directly; use
[`fs.createWriteStream()`][] instead.

#### Event: `'close'`

Expand Down