doc: add note of caution about non-conforming streams

PR-URL: #29895 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Yorkie Liu <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Nov 25, 2019 · d67c377 · d67c377
1 parent a50cc2e
commit d67c377
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1692,6 +1692,13 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
+Avoid overriding public methods such as `write()`, `end()`, `cork()`,
+`uncork()`, `read()` and `destroy()`, or emitting internal events such
+as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` through `.emit()`.
+Doing so can break current and future stream invariants leading to behavior
+and/or compatibility issues with other streams, stream utilities, and user
+expectations.
+
 ### Simplified Construction
 <!-- YAML
 added: v1.2.0