1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add note to readable stream async iterator

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/19331
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Ivan Filenko 2018-03-13 23:45:51 +03:00 committed by Rich Trott
parent 897f7b6c6b
commit 45c86e33e1
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/stream.md
View File

@ -1208,7 +1208,10 @@ print(fs.createReadStream('file')).catch(console.log);
If the loop terminates with a `break` or a `throw`, the stream will be
destroyed. In other terms, iterating over a stream will consume the stream
fully.
fully. The stream will be read in chunks of size equal to the `highWaterMark`
option. In the code example above, data will be in a single chunk if the file
has less then 64kb of data because no `highWaterMark` option is provided to
[`fs.createReadStream()`][].
### Duplex and Transform Streams