Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 00f7cc6

Browse filesBrowse files
ronagaddaleax
authored andcommitted
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
Copy full SHA for 00f7cc6

File tree

Expand file treeCollapse file tree

1 file changed

+7
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+7
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.md‎

Copy file name to clipboardExpand all lines: doc/api/stream.md
+7Lines changed: 7 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1692,6 +1692,13 @@ of a stream that are intended for use by consumers (as described in the
16921692
[API for Stream Consumers][] section). Doing so may lead to adverse side effects
16931693
in application code consuming the stream.
16941694

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+
16951702
### Simplified Construction
16961703
<!-- YAML
16971704
added: v1.2.0

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.