Permalink
Browse files

doc: explicitly document highWaterMark option

PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information...
eps1lon authored and MylesBorins committed Nov 15, 2017
1 parent fe21886 commit b16e6d29f180e66ad37556bd855a74106aa7ec78
Showing with 3 additions and 1 deletion.
  1. +3 −1 doc/api/fs.md
View
@@ -589,6 +589,7 @@ added: v0.1.31
* `autoClose` {boolean}
* `start` {integer}
* `end` {integer}
* `highWaterMark` {integer}
Returns a new [`ReadStream`][] object. (See [Readable Stream][]).
@@ -604,7 +605,8 @@ const defaults = {
encoding: null,
fd: null,
mode: 0o666,
autoClose: true
autoClose: true,
highWaterMark: 64 * 1024
};
```

0 comments on commit b16e6d2

Please sign in to comment.