Commit 0d6fbe8
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 df91d5f commit 0d6fbe8
1 file changed
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1678,6 +1678,13 @@ of a stream that are intended for use by consumers (as described in the | |||
| 1678 | 1678 | [API for Stream Consumers][] section). Doing so may lead to adverse side effects | |
| 1679 | 1679 | in application code consuming the stream. | |
| 1680 | 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 | + | ||
| 1681 | 1688 | ### Simplified Construction | |
| 1682 | 1689 | <!-- YAML | |
| 1683 | 1690 | added: v1.2.0 | |
0 commit comments