Skip to content

Commit 938de33

Browse files
jasnellMylesBorins
authored andcommitted
doc: specify how fs.WriteStream/ReadStreams are created
Alternative to #33841 Co-authored-by: zombieleet <zombieleetnca@gmail.com> PR-URL: #34188 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 326b854 commit 938de33

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/api/fs.md

+6-2
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
@@ -5874,6 +5877,7 @@ the file contents.
58745877
[`fs.chmod()`]: #fs_fs_chmod_path_mode_callback
58755878
[`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
58765879
[`fs.copyFile()`]: #fs_fs_copyfile_src_dest_mode_callback
5880+
[`fs.createReadStream()`]: #fs_fs_createreadstream_path_options
58775881
[`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options
58785882
[`fs.exists()`]: fs.html#fs_fs_exists_path_callback
58795883
[`fs.fstat()`]: #fs_fs_fstat_fd_options_callback

0 commit comments

Comments
 (0)