From ff1da17e362062c304ab720de1dc8d4a0c9f8a5b Mon Sep 17 00:00:00 2001 From: Sebastian Silbermann Date: Wed, 15 Nov 2017 16:59:22 +0100 Subject: [PATCH] doc: explicitly document highWaterMark option PR-URL: https://github.com/nodejs/node/pull/17049 Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen --- doc/api/fs.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 1723b1b45dc870..3506afd3cae8c3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -865,6 +865,7 @@ changes: * `autoClose` {boolean} * `start` {integer} * `end` {integer} + * `highWaterMark` {integer} Returns a new [`ReadStream`][] object. (See [Readable Stream][]). @@ -880,7 +881,8 @@ const defaults = { encoding: null, fd: null, mode: 0o666, - autoClose: true + autoClose: true, + highWaterMark: 64 * 1024 }; ```