Permalink
Browse files

doc: add note to readable stream async iterator

PR-URL: #19331
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
prog1dev authored and Trott committed Mar 13, 2018
1 parent 897f7b6 commit 45c86e33e19e4597108e9c0c0d4b7cef77ad1c73
Showing with 4 additions and 1 deletion.
  1. +4 −1 doc/api/stream.md
View
@@ -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

0 comments on commit 45c86e3

Please sign in to comment.