Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

doc: supplement docs for Writable and Transform streams #8769

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/api/stream.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -975,12 +975,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 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 @@ -1066,10 +1065,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