Browse Source

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>
v5.x
Anton Andesen 9 years ago
committed by Jeremiah Senkpiel
parent
commit
0a56e9690b
  1. 4
      doc/api/stream.markdown

4
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');

Loading…
Cancel
Save