Skip to content

Commit

Permalink
doc: explicitly document highWaterMark option
Browse files Browse the repository at this point in the history
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 Dec 11, 2017
1 parent 2776816 commit 2f34d35
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -865,6 +865,7 @@ changes:
* `autoClose` {boolean}
* `start` {integer}
* `end` {integer}
* `highWaterMark` {integer}

Returns a new [`ReadStream`][] object. (See [Readable Stream][]).

Expand All @@ -880,7 +881,8 @@ const defaults = {
encoding: null,
fd: null,
mode: 0o666,
autoClose: true
autoClose: true,
highWaterMark: 64 * 1024
};
```

Expand Down

0 comments on commit 2f34d35

Please sign in to comment.