Skip to content

Commit

Permalink
doc: clarify changes in readableFlowing
Browse files Browse the repository at this point in the history
PR-URL: #45554
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
  • Loading branch information
cola119 authored and danielleadams committed Jan 3, 2023
1 parent 3f6f8f9 commit 6a36159
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -880,8 +880,10 @@ pass.unpipe(writable);
// readableFlowing is now false.

pass.on('data', (chunk) => { console.log(chunk.toString()); });
// readableFlowing is still false.
pass.write('ok'); // Will not emit 'data'.
pass.resume(); // Must be called to make stream emit 'data'.
// readableFlowing is now true.
```

While `readable.readableFlowing` is `false`, data may be accumulating
Expand Down

0 comments on commit 6a36159

Please sign in to comment.