Skip to content

doc: explicitly document highWaterMark option #17049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
eps1lon wants to merge 1 commit into from
Closed

doc: explicitly document highWaterMark option #17049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: explicitly document highWaterMark option
  • Loading branch information
@eps1lon
eps1lon committed Nov 15, 2017
commit 6190ef80e64f4836312645a94b5000272ea66197
4 changes: 3 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
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