Fix ReadStream bufferSize docs
authorFelix Geisendörfer <felix@debuggable.com>
Sun, 20 Feb 2011 12:45:25 +0000 (13:45 +0100)
committerRyan Dahl <ry@tinyclouds.org>
Thu, 24 Feb 2011 20:46:17 +0000 (12:46 -0800)
The default is 64kb buffer, not 4kb.

Closes GH-702.

doc/api/fs.markdown

index 18f12d9..437ba73 100644 (file)
@@ -357,7 +357,8 @@ Returns a new ReadStream object (See `Readable Stream`).
       encoding: null,
       fd: null,
       mode: 0666,
-      bufferSize: 4096 }
+      bufferSize: 64 * 1024
+    }
 
 `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