Commit 00f7cc6
doc: add note of caution about non-conforming streams
PR-URL: #29895
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 84f7b5c commit 00f7cc6
1 file changed
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1692,6 +1692,13 @@ of a stream that are intended for use by consumers (as described in the | |||
| 1692 | 1692 | [API for Stream Consumers][] section). Doing so may lead to adverse side effects | |
| 1693 | 1693 | in application code consuming the stream. | |
| 1694 | 1694 | ||
| 1695 | + Avoid overriding public methods such as `write()`, `end()`, `cork()`, | ||
| 1696 | + `uncork()`, `read()` and `destroy()`, or emitting internal events such | ||
| 1697 | + as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` through `.emit()`. | ||
| 1698 | + Doing so can break current and future stream invariants leading to behavior | ||
| 1699 | + and/or compatibility issues with other streams, stream utilities, and user | ||
| 1700 | + expectations. | ||
| 1701 | + | ||
| 1695 | 1702 | ### Simplified Construction | |
| 1696 | 1703 | <!-- YAML | |
| 1697 | 1704 | added: v1.2.0 | |
0 commit comments