doc: explicitly document highWaterMark option

PR-URL: https://github.com/nodejs/node/pull/17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
Sebastian Silbermann 2017-11-15 16:59:22 +01:00 committed by Anna Henningsen
parent 707cd3f615
commit 2c0acc0bc1
No known key found for this signature in database
GPG Key ID: 9C63F3A6CD2AD8F9

View File

@ -865,6 +865,7 @@ changes:
* `autoClose` {boolean} * `autoClose` {boolean}
* `start` {integer} * `start` {integer}
* `end` {integer} * `end` {integer}
* `highWaterMark` {integer}
Returns a new [`ReadStream`][] object. (See [Readable Stream][]). Returns a new [`ReadStream`][] object. (See [Readable Stream][]).
@ -880,7 +881,8 @@ const defaults = {
encoding: null, encoding: null,
fd: null, fd: null,
mode: 0o666, mode: 0o666,
autoClose: true autoClose: true,
highWaterMark: 64 * 1024
}; };
``` ```