doc: clarify fs.ReadStream and fs.WriteStream are not constructable · nodejs/node@4a1f20e · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 632
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 4a1f20e

Browse filesBrowse the repository at this point in the historyBrowse files

authored and

aduh95

committed

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

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: #40546 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> PR-URL: #62208 Reviewed-By: René <contact.9a5d6388@renegade334.me.uk> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

1 parent 40a43ac commit 4a1f20e
Copy full SHA for 4a1f20e

1 file changed

+4-4Lines changed: 4 additions & 4 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • fs.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md

+4-4Lines changed: 4 additions & 4 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -7155,8 +7155,8 @@ added: v0.1.93
7155	7155
7156	7156	* Extends: {stream.Readable}
7157	7157
7158		- Instances of {fs.ReadStream} are created and returned using the
7159		- [`fs.createReadStream()`][] function.
	7158	+ Instances of {fs.ReadStream} cannot be constructed directly. They are created and
	7159	+ returned using the [`fs.createReadStream()`][] function.
7160	7160
7161	7161	#### Event: `'close'`
7162	7162
@@ -7926,8 +7926,8 @@ added: v0.1.93
7926	7926
7927	7927	* Extends {stream.Writable}
7928	7928
7929		- Instances of {fs.WriteStream} are created and returned using the
7930		- [`fs.createWriteStream()`][] function.
	7929	+ Instances of {fs.WriteStream} cannot be constructed directly. They are created and
	7930	+ returned using the [`fs.createWriteStream()`][] function.
7931	7931
7932	7932	#### Event: `'close'`
7933	7933

0 commit comments

Comments

0 (0)