Skip to content

Commit

Permalink
doc,stream: remove wrong remark on readable.read
Browse files Browse the repository at this point in the history
The returned chunk is *never* longer than `size`.

PR-URL: #15014
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
jscissr authored and MylesBorins committed Sep 20, 2017
1 parent 4c26913 commit f0328f6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ in object mode.
The optional `size` argument specifies a specific number of bytes to read. If
`size` bytes are not available to be read, `null` will be returned *unless*
the stream has ended, in which case all of the data remaining in the internal
buffer will be returned (*even if it exceeds `size` bytes*).
buffer will be returned.

If the `size` argument is not specified, all of the data contained in the
internal buffer will be returned.
Expand Down

0 comments on commit f0328f6

Please sign in to comment.