Browse Source

doc: streams: document default objectMode setting

v0.10.22-release
Brian White 11 years ago
committed by Timothy J Fontaine
parent
commit
21265e20d3
  1. 2
      doc/api/stream.markdown

2
doc/api/stream.markdown

@ -843,7 +843,7 @@ SimpleProtocol.prototype._read = function(n) {
strings using the specified encoding. Default=null strings using the specified encoding. Default=null
* `objectMode` {Boolean} Whether this stream should behave * `objectMode` {Boolean} Whether this stream should behave
as a stream of objects. Meaning that stream.read(n) returns 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 In classes that extend the Readable class, make sure to call the
Readable constructor so that the buffering settings can be properly Readable constructor so that the buffering settings can be properly

Loading…
Cancel
Save