Skip to content

Commit

Permalink
doc: fixup errors in stream.md
Browse files Browse the repository at this point in the history
When decodeStrings is false and given data is string, _write() function
receives the string data not `Buffer`.

PR-URL: #10411
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
fmy authored and evanlucas committed Jan 4, 2017
1 parent 11ed800 commit cf3f75f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -1273,8 +1273,8 @@ If the `decodeStrings` property is set in the constructor options, then
indicate the character encoding of the string. This is to support
implementations that have an optimized handling for certain string
data encodings. If the `decodeStrings` property is explicitly set to `false`,
the `encoding` argument can be safely ignored, and `chunk` will always be a
`Buffer`.
the `encoding` argument can be safely ignored, and `chunk` will remain the same
object that is passed to `.write()`.

The `writable._write()` method is prefixed with an underscore because it is
internal to the class that defines it, and should never be called directly by
Expand Down Expand Up @@ -1503,9 +1503,9 @@ Implementers, and only from within the `readable._read()` method.
It is recommended that errors occurring during the processing of the
`readable._read()` method are emitted using the `'error'` event rather than
being thrown. Throwing an Error from within `readable._read()` can result in
expected and inconsistent behavior depending on whether the stream is operating
in flowing or paused mode. Using the `'error'` event ensures consistent and
predictable handling of errors.
unexpected and inconsistent behavior depending on whether the stream is
operating in flowing or paused mode. Using the `'error'` event ensures
consistent and predictable handling of errors.

```js
const Readable = require('stream').Readable;
Expand Down

0 comments on commit cf3f75f

Please sign in to comment.