jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-21 23:23:32 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

doc: edit fs.createReadStream() highWaterMark

Browse Source 
Shorten the text about the `highWaterMark` value for the stream returned
by `fs.createReadStream()`.

PR-URL: https://github.com/nodejs/node/pull/20450
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2018-04-30 21:50:35 -07:00
parent d3abb60b05
commit f27566f0f2
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/fs.md
View File

@ -1316,9 +1316,8 @@ changes:
* `highWaterMark` {integer} **Default:** `64 * 1024` * `highWaterMark` {integer} **Default:** `64 * 1024`
* Returns: {fs.ReadStream} See [Readable Streams][]. * Returns: {fs.ReadStream} See [Readable Streams][].
Be aware that, unlike the default value set for `highWaterMark` on a Unlike the 16 kb default `highWaterMark` for a readable stream, the stream
readable stream (16 kb), the stream returned by this method has a returned by this method has a default `highWaterMark` of 64 kb.
default value of 64 kb for the same parameter.
`options` can include `start` and `end` values to read a range of bytes from `options` can include `start` and `end` values to read a range of bytes from
the file instead of the entire file. Both `start` and `end` are inclusive and the file instead of the entire file. Both `start` and `end` are inclusive and