Skip to content

Commit

Permalink
docs: improve Writable/Transform stream docs
Browse files Browse the repository at this point in the history
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: #142
Reviewed-by: Bert Belder <bertbelder@gmail.com>
Reviewed-by: Rod Vagg <rod@vagg.org>
  • Loading branch information
vovacodes authored and piscisaureus committed Jan 12, 2015
1 parent 43e4c90 commit 68a2d8f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/stream.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 68a2d8f

Please sign in to comment.