From abbde2fafab5d722e156aa6fadd343e671446ace Mon Sep 17 00:00:00 2001 From: Raynos Date: Tue, 21 May 2013 15:10:34 -0600 Subject: [PATCH] doc: mention objectMode for Writable streams --- doc/api/stream.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index 5826c71afd6..be3aacfebec 100644 --- 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