stream: added note about undocumented API

nodejs · Oct 1, 2019 · 9fbf8a1 · 9fbf8a1
1 parent f663b31
commit 9fbf8a1
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.
+// cb() well be invoked synchronously if _destroy is synchronous.
 function destroy(err, cb) {
   const r = this._readableState;
   const w = this._writableState;