Skip to content

doc: add notes about non-conforming streams #29895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ronag wants to merge 8 commits into from
+7 −0
Closed

doc: add notes about non-conforming streams #29895

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7ce4453
doc: add notes about non-confirming streams
ronag Oct 9, 2019
e2207eb
fixup
ronag Oct 20, 2019
1ac15d1
fixup
ronag Oct 20, 2019
fc5029d
Update doc/api/stream.md
ronag Nov 19, 2019
fdba619
fixup: provide examples of methods
ronag Nov 24, 2019
6f4b705
Apply suggestions from code review
ronag Nov 25, 2019
50a3d5a
fixup: line wrap
ronag Nov 25, 2019
687ead7
fixup: events plural
ronag Nov 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup: provide examples of methods
  • Loading branch information
@ronag
ronag committed Nov 24, 2019
commit fdba619c45f2863df0e14b9771cc8989215ab905
12 changes: 6 additions & 6 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1667,12 +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 or to emit any internal
events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` manually
through `.emit(eventName)` instead of using API provided callbacks or
`.destroy(err)`. Doing so can break current and future stream invariants
leading to behavior and/or compatibility issues with other streams, stream
utilities and user expectations.
It is highly discouraged to override any public method such as `write()`,
Comment thread
ronag marked this conversation as resolved.
Outdated
`end()`, `cork()`, `uncork()`, `read()` and `destroy()`, or to emit any
Comment thread
ronag marked this conversation as resolved.
Outdated
internal event such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
manually through `.emit()`. Doing so can break current and future stream
Comment thread
ronag marked this conversation as resolved.
Outdated
invariants leading to behavior and/or compatibility issues with other streams,
stream utilities and user expectations.
Comment thread
ronag marked this conversation as resolved.
Outdated
Comment thread
ronag marked this conversation as resolved.
Outdated

### Simplified Construction
<!-- YAML
Expand Down