daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix unit of size argument of readable.read 

"GB" refers to 10**9 bytes, whereas the actual limit is 2**30. The
correct unit symbol is "GiB".

PR-URL: https://github.com/nodejs/node/pull/35051
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
pull/35636/head
Tobias Nießen 2020-09-04 11:53:16 +02:00 committed by Node.js GitHub Bot
parent 2cfdf28413
commit d7e5d656ea
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/stream.md
View File

@ -1134,7 +1134,7 @@ buffer will be returned.
If the `size` argument is not specified, all of the data contained in the
internal buffer will be returned.
The `size` argument must be less than or equal to 1 GB.
The `size` argument must be less than or equal to 1 GiB.
The `readable.read()` method should only be called on `Readable` streams
operating in paused mode. In flowing mode, `readable.read()` is called