Skip to content

doc: fix trivial mistakes in stream document. #10411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fmy wants to merge 2 commits into from
Closed

doc: fix trivial mistakes in stream document. #10411

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c62ac3
doc: fix a wrong expression about decodeStrings in stream
fmy Dec 22, 2016
404222a
doc: fix a trivial mistake, expected -> unexpected
fmy Dec 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: fix a wrong expression about decodeStrings in stream 
When decodeStrings is false and given data is string, _write() function
receives the string data not `Buffer`.
  • Loading branch information
@fmy
fmy committed Dec 23, 2016
commit 1c62ac324413e0e23e448db6afd40bb87fa069c4
4 changes: 2 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1273,8 +1273,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
Expand Down