Skip to content
This repository has been archived by the owner on Oct 16, 2021. It is now read-only.

Commit

Permalink
updated documentation for fs.createReadStream
Browse files Browse the repository at this point in the history
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#25591
  • Loading branch information
skypjack authored and jBarz committed Nov 4, 2016
1 parent 2724a79 commit 0eb8960
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/api/fs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,10 @@ on Unix systems, it never was.

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

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

`options` is an object with the following defaults:

{ flags: 'r',
Expand Down

0 comments on commit 0eb8960

Please sign in to comment.