Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c2964b7

Browse filesBrowse 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 f174288 commit c2964b7
Copy full SHA for c2964b7

File tree

Expand file treeCollapse file tree

1 file changed

+6
-2
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+6
-2
lines changed
Open diff view settings
Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md
+6-2Lines changed: 6 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.