From: Anton Andesen <a.andersen@readyforsky.com>
Date: Tue, 9 Feb 2016 08:31:07 +0000 (+0000)
Subject: doc: add note for binary safe string reading
X-Git-Tag: v4.4.1~88
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ca17f91ba88c66929595cb6546542aa3faea86aa;p=platform%2Fupstream%2Fnodejs.git

doc: add note for binary safe string reading

`readable.setEncoding(null)` - may be the most preferable way to proxy
a binary data without any encoding/decoding overhead

PR-URL: https://github.com/nodejs/node/pull/5155
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
---

diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index 72b6834..71f0e7d 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -416,6 +416,10 @@ potentially mangled if you simply pulled the Buffers directly and
 called [`buf.toString(encoding)`][] on them. If you want to read the data
 as strings, always use this method.
 
+Also you can disable any encoding at all with `readable.setEncoding(null)`.
+This approach is very useful if you deal with binary data or with large
+multi-byte strings spread out over multiple chunks.
+
 ```js
 var readable = getReadableStreamSomehow();
 readable.setEncoding('utf8');