updated documentation for fs.createReadStream

skypjack · jasnell · commit 59c67fe3cda1 · 2015-08-03T20:44:40.000-07:00
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25591
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown
@@ -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',
