Skip to content

Commit e7dadd3

Browse files
committed
doc: specify how fs.WriteStream/ReadStreams are created
Alternative to #33841 Co-authored-by: zombieleet <[email protected]> PR-URL: #34188 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 1b1e985 commit e7dadd3

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/api/fs.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -654,8 +654,8 @@ added: v0.1.93
654654

655655
* Extends: {stream.Readable}
656656

657-
A successful call to `fs.createReadStream()` will return a new `fs.ReadStream`
658-
object.
657+
Instances of `fs.ReadStream` are created and returned using the
658+
[`fs.createReadStream()`][] function.
659659

660660
### Event: `'close'`
661661
<!-- YAML
@@ -1079,6 +1079,9 @@ added: v0.1.93
10791079

10801080
* Extends {stream.Writable}
10811081

1082+
Instances of `fs.WriteStream` are created and returned using the
1083+
[`fs.createWriteStream()`][] function.
1084+
10821085
### Event: `'close'`
10831086
<!-- YAML
10841087
added: v0.1.93
@@ -5898,6 +5901,7 @@ the file contents.
58985901
[`fs.chmod()`]: #fs_fs_chmod_path_mode_callback
58995902
[`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
59005903
[`fs.copyFile()`]: #fs_fs_copyfile_src_dest_mode_callback
5904+
[`fs.createReadStream()`]: #fs_fs_createreadstream_path_options
59015905
[`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options
59025906
[`fs.exists()`]: fs.html#fs_fs_exists_path_callback
59035907
[`fs.fstat()`]: #fs_fs_fstat_fd_options_callback

0 commit comments

Comments
 (0)