doc: add notes about non-confirming streams

nodejs · Oct 9, 2019 · 7ce4453 · 7ce4453
1 parent 064e111
commit 7ce4453
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1667,6 +1667,12 @@ 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.
 
+It is highly discouraged to override any public method. As well as emitting
+`'error'` events manually through `.emit(err)` instead of using API provided
+callbacks or `.destroy(err)`. Doing so can break current and future stream
+invariants leading to behaviour and/or compatibility issues with other streams,
+stream utilities and user expectations.
+
 ### Simplified Construction
 <!-- YAML
 added: v1.2.0