Skip to content

Commit f0328f6

Browse files
jscissrMylesBorins
authored andcommitted
doc,stream: remove wrong remark on readable.read
The returned chunk is *never* longer than `size`. PR-URL: #15014 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 4c26913 commit f0328f6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/api/stream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,7 @@ in object mode.
863863
The optional `size` argument specifies a specific number of bytes to read. If
864864
`size` bytes are not available to be read, `null` will be returned *unless*
865865
the stream has ended, in which case all of the data remaining in the internal
866-
buffer will be returned (*even if it exceeds `size` bytes*).
866+
buffer will be returned.
867867

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

0 commit comments

Comments
 (0)