Skip to content

docs: clarify writableNeedDrain behavior and usage in streams #56419

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
oussamaBGZ wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −0
Open

docs: clarify writableNeedDrain behavior and usage in streams #56419

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
1 change: 1 addition & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -964,6 +964,7 @@ added:
* {boolean}

Is `true` if the stream's buffer has been full and stream will emit `'drain'`.
This flag does not update immediately after each write and remains `true` until the writable stream drains and the `drain` event is emitted.

##### `writable.writableObjectMode`

Expand Down