Browse Source

doc: mention objectMode for Writable streams

v0.10.26-release
Raynos 12 years ago
committed by Timothy J Fontaine
parent
commit
abbde2fafa
  1. 3
      doc/api/stream.markdown

3
doc/api/stream.markdown

@ -961,6 +961,9 @@ how to implement Writable streams in your programs.
returning false. Default=16kb returning false. Default=16kb
* `decodeStrings` {Boolean} Whether or not to decode strings into * `decodeStrings` {Boolean} Whether or not to decode strings into
Buffers before passing them to [`_write()`][]. Default=true Buffers before passing them to [`_write()`][]. Default=true
* `objectMode` {Boolean} Whether or not the `write(anyObj)` is
a valid operation. If set you can write arbitrary data instead
of only `Buffer` / `String` data. Default=false
In classes that extend the Writable class, make sure to call the In classes that extend the Writable class, make sure to call the
constructor so that the buffering settings can be properly constructor so that the buffering settings can be properly

Loading…
Cancel
Save