From 68a2d8f048ca76bf1561602dbee92e54658f5c30 Mon Sep 17 00:00:00 2001 From: Vladimir Guguiev Date: Thu, 11 Dec 2014 00:06:01 +0100 Subject: [PATCH] docs: improve Writable/Transform stream docs Slightly fix and supplement the documentation for Writable#write and Transform#transform methods. Make it more consistent. Mention passing 'buffer' as an encoding param in case chunk is a Buffer. PR: https://github.com/iojs/io.js/pull/142 Reviewed-by: Bert Belder Reviewed-by: Rod Vagg --- doc/api/stream.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index 1029c43c943841..d4b585afea0662 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -1038,12 +1038,11 @@ initialized. #### writable.\_write(chunk, encoding, callback) -* `chunk` {Buffer | String} The chunk to be written. Will always +* `chunk` {Buffer | String} The chunk to be written. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. * `encoding` {String} If the chunk is a string, then this is the - encoding type. Ignore if chunk is a buffer. Note that chunk will - **always** be a buffer unless the `decodeStrings` option is - explicitly set to `false`. + encoding type. If chunk is a buffer, then this is the special + value - 'buffer', ignore it in this case. * `callback` {Function} Call this function (optionally with an error argument) when you are done processing the supplied chunk. @@ -1150,10 +1149,11 @@ initialized. #### transform.\_transform(chunk, encoding, callback) -* `chunk` {Buffer | String} The chunk to be transformed. Will always +* `chunk` {Buffer | String} The chunk to be transformed. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. * `encoding` {String} If the chunk is a string, then this is the - encoding type. (Ignore if `decodeStrings` chunk is a buffer.) + encoding type. If chunk is a buffer, then this is the special + value - 'buffer', ignore it in this case. * `callback` {Function} Call this function (optionally with an error argument and data) when you are done processing the supplied chunk.