doc: mention objectMode for Writable streams

nodejs · Feb 18, 2014 · abbde2f · abbde2f
1 parent 562b015
commit abbde2f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
@@ -961,6 +961,9 @@ how to implement Writable streams in your programs.
     returning false. Default=16kb
   * `decodeStrings` {Boolean} Whether or not to decode strings into
     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
 constructor so that the buffering settings can be properly