Skip to content

doc: multiple minor fixes to fs.md #20450

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
Trott wants to merge 3 commits into from
Closed

doc: multiple minor fixes to fs.md #20450

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83c5b2f
doc: edit fs.createReadStream() highWaterMark
Trott May 1, 2018
e24566c
doc: remove unclear text from fs.write()
Trott May 1, 2018
4187290
doc: clarify FileHandle text
Trott May 1, 2018
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
Next Next commit
doc: edit fs.createReadStream() highWaterMark 
Shorten the text about the `highWaterMark` value for the stream returned
by `fs.createReadStream()`.
  • Loading branch information
@Trott
Trott committed May 1, 2018
commit 83c5b2f7dcf56e3de0b344458910f1de3d9f57ac
5 changes: 2 additions & 3 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1316,9 +1316,8 @@ changes:
* `highWaterMark` {integer} **Default:** `64 * 1024`
* Returns: {fs.ReadStream} See [Readable Streams][].

Be aware that, unlike the default value set for `highWaterMark` on a
readable stream (16 kb), the stream returned by this method has a
default value of 64 kb for the same parameter.
Unlike the 16 kb default `highWaterMark` for a readable stream, the stream
returned by this method has a default `highWaterMark` of 64 kb.

`options` can include `start` and `end` values to read a range of bytes from
the file instead of the entire file. Both `start` and `end` are inclusive and
Expand Down