readable: Update docs for a case with a binary safe string reading #5155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mscdex
added
doc
| as strings, always use this method. | ||
| called [`buf.toString(encoding)`][] on them. Also you can disable | ||
| any encoding at all with `readable.setEncoding(null)`. | ||
| If you want to read the data as strings, always use this method. |
There was a problem hiding this comment.
I would flip these last two sentences around, or move the new sentence to a separate paragraph.
|
LGTM with a nit. |
TriAnMan
force-pushed
the
doc-readable-encoding-fix
branch
from
d184b48 to
eb748a2
Compare
|
@jasnell Could you review? |
| @@ -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 wery usefull if you deal with binary data or with large | |||
TriAnMan
force-pushed
the
doc-readable-encoding-fix
branch
from
eb748a2 to
66bb1b4
Compare
|
@silverwind thanks! (: |
| @@ -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 wery useful if you deal with binary data or with large | |||
`readable.setEncoding(null)` - may be the most preferable way to proxy a binary data without any encoding/decoding overhead
TriAnMan
force-pushed
the
doc-readable-encoding-fix
branch
from
66bb1b4 to
174fec5
Compare
|
@silverwind Thanks a lot... Seems I need to install a spell checker for my Sublime. (: |
|
Landed in 8d8fef0. |
silverwind
pushed a commit
that referenced
this pull request
Feb 29, 2016
`readable.setEncoding(null)` - may be the most preferable way to proxy a binary data without any encoding/decoding overhead PR-URL: #5155 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Fishrock123
pushed a commit
that referenced
this pull request
Mar 2, 2016
`readable.setEncoding(null)` - may be the most preferable way to proxy a binary data without any encoding/decoding overhead PR-URL: #5155 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
|
I'm 99% sure this applied to v4. Going to give a day before landing for people to chime in and let me know not to land it |
MylesBorins
pushed a commit
that referenced
this pull request
Mar 17, 2016
`readable.setEncoding(null)` - may be the most preferable way to proxy a binary data without any encoding/decoding overhead PR-URL: #5155 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 21, 2016
`readable.setEncoding(null)` - may be the most preferable way to proxy a binary data without any encoding/decoding overhead PR-URL: #5155 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
readable.setEncoding(null)- may be the most preferable way to proxy a binary data without any encoding/decoding overheadSee nodejs/readable-stream#180 for details