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 9, 2019 · 320f649 · 320f649
1 parent ab4c53e
commit 320f649
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/internal/streams/destroy.js b/lib/internal/streams/destroy.js
@@ -1,6 +1,7 @@
 'use strict';
 
-// 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 readableDestroyed = this._readableState &&
     this._readableState.destroyed;