doc: streams: document default objectMode setting
authorBrian White <mscdex@mscdex.net>
Thu, 24 Oct 2013 02:43:23 +0000 (22:43 -0400)
committerTimothy J Fontaine <tjfontaine@gmail.com>
Fri, 25 Oct 2013 17:33:22 +0000 (10:33 -0700)
doc/api/stream.markdown

index 76aa4e8..d750dbf 100644 (file)
@@ -843,7 +843,7 @@ SimpleProtocol.prototype._read = function(n) {
     strings using the specified encoding.  Default=null
   * `objectMode` {Boolean} Whether this stream should behave
     as a stream of objects. Meaning that stream.read(n) returns
-    a single value instead of a Buffer of size n
+    a single value instead of a Buffer of size n.  Default=false
 
 In classes that extend the Readable class, make sure to call the
 Readable constructor so that the buffering settings can be properly