diff options
| author | Tobias Nießen <tniessen@tnie.de> | 2020-09-04 12:53:16 +0300 |
|---|---|---|
| committer | Myles Borins <mylesborins@github.com> | 2020-10-14 23:21:27 +0300 |
| commit | 41d7500bf946f18ef8478597101c36867f21d42a (patch) | |
| tree | d3eb0541aabeda80e3a52ca3f80f573c2c1a6062 /doc | |
| parent | 00eff4a534f0a1f502dce6d548cbadfb122744cb (diff) | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index d4b05610295..eed68fcc54e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1127,7 +1127,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 |