Skip to content

doc: add note to readable stream async iterator docs #19331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
prog1dev wants to merge 4 commits into from
Closed

doc: add note to readable stream async iterator docs #19331

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d124874
doc: add note to readable stream async iterator docs
prog1dev Mar 13, 2018
042cf85
doc: rephrase the note to make it clearer
prog1dev Mar 13, 2018
3aa49be
doc: generalize the note after rewiew suggestions
prog1dev Mar 16, 2018
3088fb2
Update stream.md
Trott Mar 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,7 +1197,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

Expand Down