Skip to content

docs: add example of respecting backpressure in Readable stream #7854

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

Merged
mikeesto merged 3 commits into from
Jun 11, 2025
Merged

docs: add example of respecting backpressure in Readable stream #7854

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6b3475
docs: add example of respecting backpressure in Readable stream
0hmX Jun 9, 2025
3ceb028
Update apps/site/pages/en/learn/modules/backpressuring-in-streams.md
0hmX Jun 11, 2025
f67580e
fix: correct indentation in MyReadable class example
0hmX Jun 11, 2025
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
14 changes: 14 additions & 0 deletions apps/site/pages/en/learn/modules/backpressuring-in-streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,20 @@ class MyReadable extends Readable {
}
```

Here is an example of good practice, where the `Readable` stream respects backpressure by checking the return value of `this.push()`:

```js
class MyReadable extends Readable {
_read(size) {
let chunk;
let canPushMore = true;
while (canPushMore && null !== (chunk = getNextChunk())) {
canPushMore = this.push(chunk);
}
}
}
```

Additionally, from outside the custom stream, there are pitfalls to ignoring
backpressure. In this counter-example of good practice, the application's code
forces data through whenever it is available (signaled by the
Expand Down
Loading