Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
doc: streams: document default objectMode setting
Browse files Browse the repository at this point in the history
  • Loading branch information
mscdex authored and tjfontaine committed Oct 25, 2013
1 parent 9c6e06b commit 21265e2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/stream.markdown
Expand Up @@ -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
Expand Down

0 comments on commit 21265e2

Please sign in to comment.