We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent d9d6da4 commit 2eaa940Copy full SHA for 2eaa940
doc/api/stream.md
@@ -1678,6 +1678,13 @@ of a stream that are intended for use by consumers (as described in the
1678
[API for Stream Consumers][] section). Doing so may lead to adverse side effects
1679
in application code consuming the stream.
1680
1681
+Avoid overriding public methods such as `write()`, `end()`, `cork()`,
1682
+`uncork()`, `read()` and `destroy()`, or emitting internal events such
1683
+as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` through `.emit()`.
1684
+Doing so can break current and future stream invariants leading to behavior
1685
+and/or compatibility issues with other streams, stream utilities, and user
1686
+expectations.
1687
+
1688
### Simplified Construction
1689
<!-- YAML
1690
added: v1.2.0
0 commit comments