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`.
  • Loading branch information
jscissr committed Aug 24, 2017
1 parent 43029da commit a560ae8
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 @@ -894,7 +894,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 a560ae8

Please sign in to comment.