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 cef9921

Browse filesBrowse files
jasnelladdaleax
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 8d0c21f commit cef9921
Copy full SHA for cef9921

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
@@ -605,8 +605,8 @@ added: v0.1.93
605605

606606
* Extends: {stream.Readable}
607607

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

611611
### Event: `'close'`
612612
<!-- YAML
@@ -1028,6 +1028,9 @@ added: v0.1.93
10281028

10291029
* Extends {stream.Writable}
10301030

1031+
Instances of `fs.WriteStream` are created and returned using the
1032+
[`fs.createWriteStream()`][] function.
1033+
10311034
### Event: `'close'`
10321035
<!-- YAML
10331036
added: v0.1.93
@@ -5798,6 +5801,7 @@ the file contents.
57985801
[`fs.chmod()`]: #fs_fs_chmod_path_mode_callback
57995802
[`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
58005803
[`fs.copyFile()`]: #fs_fs_copyfile_src_dest_flags_callback
5804+
[`fs.createReadStream()`]: #fs_fs_createreadstream_path_options
58015805
[`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options
58025806
[`fs.exists()`]: fs.html#fs_fs_exists_path_callback
58035807
[`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.