Skip to content

Commit b16e6d2

Browse files
eps1lonMylesBorins
authored andcommitted
doc: explicitly document highWaterMark option
PR-URL: #17049 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent fe21886 commit b16e6d2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/fs.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -589,6 +589,7 @@ added: v0.1.31
589589
* `autoClose` {boolean}
590590
* `start` {integer}
591591
* `end` {integer}
592+
* `highWaterMark` {integer}
592593

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

@@ -604,7 +605,8 @@ const defaults = {
604605
encoding: null,
605606
fd: null,
606607
mode: 0o666,
607-
autoClose: true
608+
autoClose: true,
609+
highWaterMark: 64 * 1024
608610
};
609611
```
610612

0 commit comments

Comments
 (0)