lukechilds/node - node - Gitea: Git with a cup of tea

History

Kevin Locke 0830bb4950 doc: clarify when writable.write callback is called The current documentation for writable.write only specifies that the callback is called "once the data has been fully handled". It is ambiguous whether this means "successfully handled" and, if so, whether the callback is called if the data can not be successfully handled (i.e. an error occurs). The ambiguity is not only in the documentation. The stream class implementations differ on this point. stream.Writable invokes the callback with any errors that occur during parameter checking or during calls to _write. However, not all classes return all errors to _write. zlib.Zlib does pass argument and state errors to the _write (_transform) callback, but does not pass data errors. http.OutgoingMessage passes argument type errors and some other types of errors, but not all. This inconsistency is behind issue #1746 and, I suspect, other issues in client code which passes a callback to write. This commit takes no position on whether the callback error behavior should changed, but simply attempts to document the current behavior in a way that is open to changes so that users are not caught by surprise. PR-URL: https://github.com/nodejs/node/pull/4810 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremy Whitlock <jwhitlock@apache.org> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>		9 years ago
..
api	doc: clarify when writable.write callback is called	9 years ago
api_assets	doc: improve scrolling, various CSS tweaks	9 years ago
ctc-meetings	doc: add CTC meeting minutes 2015-10-28	9 years ago
guides	doc: add "building node with ninja" guide	9 years ago
tsc-meetings	doc: add TSC meeting minutes 2015-10-21	9 years ago
full-white-stripe.jpg	installer: fix installers for node.js rename	9 years ago
node.1	tools: add --prof-process flag to node binary	9 years ago
onboarding-extras.md	doc: add onboarding resources	9 years ago
onboarding.md	doc: add onboarding resources	9 years ago
osx_installer_logo.png	installer: fix installers for node.js rename	9 years ago
releases.md	doc: update branch-diff arguments in release doc	9 years ago
template.html	doc: improve scrolling, various CSS tweaks	9 years ago
thin-white-stripe.jpg	installer: fix installers for node.js rename	9 years ago