doc: add note for binary safe string reading
authorAnton Andesen <a.andersen@readyforsky.com>
Tue, 9 Feb 2016 08:31:07 +0000 (08:31 +0000)
committerMyles Borins <mborins@us.ibm.com>
Mon, 21 Mar 2016 19:57:54 +0000 (12:57 -0700)
`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>
doc/api/stream.markdown

index 72b6834..71f0e7d 100644 (file)
@@ -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');