From 5b2ca85959e295f737d9048d4230d55dbd3b1a8d Mon Sep 17 00:00:00 2001 From: Fumiya KARASAWA Date: Fri, 23 Dec 2016 00:56:31 +0900 Subject: [PATCH] doc: fixup errors in stream.md When decodeStrings is false and given data is string, _write() function receives the string data not `Buffer`. PR-URL: https://github.com/nodejs/node/pull/10411 Reviewed-By: Matteo Collina Reviewed-By: James M Snell --- doc/api/stream.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 6217e8e6dc02d2..121423095edd5d 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1271,8 +1271,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 @@ -1501,9 +1501,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;