Skip to content

docs: fix stream async iterator sample #31252

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
ronag wants to merge 3 commits into from
Closed

docs: fix stream async iterator sample #31252

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a778098
docs: fix stream async iterator sample
ronag Jan 7, 2020
3fda730
docs: rename iterator to iterable in examples
ronag Jan 7, 2020
f1d486a
fixup! docs: fix stream async iterator sample
ronag Jan 7, 2020
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
Next Next commit
docs: fix stream async iterator sample 
The for await loop into writable loop could cause an unhandled exception
in the case where we are waiting for data from the async iterable and
this no `'error'` handler is registered on the writable.

Fixes: #31222
  • Loading branch information
@ronag
ronag committed Jan 7, 2020
commit a778098c87907606b17d006bb81252f322d9267d
12 changes: 10 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2647,15 +2647,23 @@ const finished = util.promisify(stream.finished);

const writable = fs.createWriteStream('./file');

(async function() {
async function pump(iterator, writable) {
for await (const chunk of iterator) {
// Handle backpressure on write().
if (writable.destroyed) return;
if (!writable.write(chunk))
await once(writable, 'drain');
if (writable.destroyed) return;
}
writable.end();
}

(async function() {
// Ensure completion without errors.
await finished(writable);
await Promise.all([
pump(iterator, writable),
finished(writable)
]);
})();
```

Expand Down