From f27566f0f24d06e95d7c2189a5fdea6b51e09d13 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 30 Apr 2018 21:50:35 -0700 Subject: [PATCH] doc: edit fs.createReadStream() highWaterMark MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Vse Mozhet Byt Reviewed-By: Colin Ihrig Reviewed-By: Tobias Nießen Reviewed-By: Trivikram Kamat Reviewed-By: James M Snell --- doc/api/fs.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 283ed7e2dd8..61a587dc42a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1316,9 +1316,8 @@ changes: * `highWaterMark` {integer} **Default:** `64 * 1024` * Returns: {fs.ReadStream} See [Readable Streams][]. -Be aware that, unlike the default value set for `highWaterMark` on a -readable stream (16 kb), the stream returned by this method has a -default value of 64 kb for the same parameter. +Unlike the 16 kb default `highWaterMark` for a readable stream, the stream +returned by this method has a default `highWaterMark` of 64 kb. `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