diff options
| author | James M Snell <jasnell@gmail.com> | 2020-07-03 23:03:56 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-07-06 00:19:42 +0300 |
| commit | e7dadd376ec535e56faf3be75fe23549bf13abc9 (patch) | |
| tree | 470047c964e5743a80b3d3ce80f53cc08c204cfe | |
| parent | 1b1e9854783d51b5157ef6e95416e852e6e1a280 (diff) | |
doc: specify how fs.WriteStream/ReadStreams are created
Alternative to https://github.com/nodejs/node/pull/33841
Co-authored-by: zombieleet <zombieleetnca@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/34188
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
| -rw-r--r-- | doc/api/fs.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 9969412dbdb..3332444aa43 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -654,8 +654,8 @@ added: v0.1.93 * Extends: {stream.Readable} -A successful call to `fs.createReadStream()` will return a new `fs.ReadStream` -object. +Instances of `fs.ReadStream` are created and returned using the +[`fs.createReadStream()`][] function. ### Event: `'close'` <!-- YAML @@ -1079,6 +1079,9 @@ added: v0.1.93 * Extends {stream.Writable} +Instances of `fs.WriteStream` are created and returned using the +[`fs.createWriteStream()`][] function. + ### Event: `'close'` <!-- YAML added: v0.1.93 @@ -5898,6 +5901,7 @@ the file contents. [`fs.chmod()`]: #fs_fs_chmod_path_mode_callback [`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_mode_callback +[`fs.createReadStream()`]: #fs_fs_createreadstream_path_options [`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options [`fs.exists()`]: fs.html#fs_fs_exists_path_callback [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback |