Skip to content

Commit 459c20c

Browse files
TrottMylesBorins
authored andcommitted
doc: edit fs.createReadStream() highWaterMark
Shorten the text about the `highWaterMark` value for the stream returned by `fs.createReadStream()`. PR-URL: #20450 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent f36a5e3 commit 459c20c

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/api/fs.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1316,9 +1316,8 @@ changes:
13161316
* `highWaterMark` {integer} **Default:** `64 * 1024`
13171317
* Returns: {fs.ReadStream} See [Readable Streams][].
13181318

1319-
Be aware that, unlike the default value set for `highWaterMark` on a
1320-
readable stream (16 kb), the stream returned by this method has a
1321-
default value of 64 kb for the same parameter.
1319+
Unlike the 16 kb default `highWaterMark` for a readable stream, the stream
1320+
returned by this method has a default `highWaterMark` of 64 kb.
13221321

13231322
`options` can include `start` and `end` values to read a range of bytes from
13241323
the file instead of the entire file. Both `start` and `end` are inclusive and

0 commit comments

Comments
 (0)