Skip to content
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

doc: clarify when writable.end callback is called #4810

Closed
wants to merge 1 commit into from
Closed

doc: clarify when writable.end callback is called #4810

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
4 changes: 3 additions & 1 deletion doc/api/stream.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,9 @@ Flush all data, buffered since `.cork()` call.
* Returns: {Boolean} True if the data was handled completely.

This method writes some data to the underlying system, and calls the
supplied callback once the data has been fully handled.
supplied callback once the data has been fully handled. If an error
occurs, the callback may or may not be called with the error as its
first argument. To detect write errors, listen for the `'error'` event.

The return value indicates if you should continue writing right now.
If the data had to be buffered internally, then it will return
Expand Down