summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorRobert Nagy <ronagy@icloud.com>2019-10-01 20:44:02 +0200
committerRich Trott <rtrott@gmail.com>2019-10-03 13:57:30 -0700
commit4fa1744e1108c34c5cdfba99249346830bb9cbe7 (patch)
tree8c8d16b87b1b851a3e20ada3580095dad827da06 /lib
parent389969ea9247a7bb12d5e595879a7f0f05357dc5 (diff)
downloadandroid-node-v8-4fa1744e1108c34c5cdfba99249346830bb9cbe7.tar.gz
android-node-v8-4fa1744e1108c34c5cdfba99249346830bb9cbe7.tar.bz2
android-node-v8-4fa1744e1108c34c5cdfba99249346830bb9cbe7.zip
stream: add comment about undocumented API
PR-URL: https://github.com/nodejs/node/pull/29805 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Masashi Hirano <shisama07@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/internal/streams/destroy.js3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/internal/streams/destroy.js b/lib/internal/streams/destroy.js
index 8708ca022c..ded75b2559 100644
--- a/lib/internal/streams/destroy.js
+++ b/lib/internal/streams/destroy.js
@@ -22,7 +22,8 @@ function needError(stream, err) {
return true;
}
-// Undocumented cb() API, needed for core, not for public API
+// Undocumented cb() API, needed for core, not for public API.
+// The cb() will be invoked synchronously if _destroy is synchronous.
function destroy(err, cb) {
const r = this._readableState;
const w = this._writableState;