Skip to content

doc: clarify forEach concurrency and ordering #66291

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

Open
mmustafasenoglu wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

doc: clarify forEach concurrency and ordering #66291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2326,6 +2326,11 @@ stopped by having passed a `signal` option and aborting the related
`AbortController` while `for await...of` can be stopped with `break` or
`return`. In either case the stream will be destroyed.

When `concurrency` is greater than `1`, `fn` may be invoked on multiple chunks
at once, but the calls are still awaited in chunk order (like
[`readable.map`][]), so a slow `fn` call on an early chunk delays completion
of the calls on later chunks.

This method is different from listening to the [`'data'`][] event in that it
uses the [`readable`][] event in the underlying machinery and can limit the
number of concurrent `fn` calls.
Expand Down
Loading