daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: streams: document default objectMode setting

pull/5010/head
Brian White 2013-10-23 22:43:23 -04:00 committed by Timothy J Fontaine
parent 9c6e06bed3
commit 21265e20d3
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/stream.markdown
View File

@ -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