stream: add comment about undocumented API

PR-URL: #29805 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Masashi Hirano <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
nodejs · Oct 3, 2019 · 4fa1744 · 4fa1744
1 parent 389969e
commit 4fa1744
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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;