Skip to content

Commit

Permalink
fixup
Browse files Browse the repository at this point in the history
  • Loading branch information
ronag committed Oct 20, 2019
1 parent 7ce4453 commit e2207eb
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -1667,11 +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. As well as emitting
`'error'` events manually through `.emit(err)` instead of using API provided
callbacks or `.destroy(err)`. Doing so can break current and future stream
invariants leading to behaviour and/or compatibility issues with other streams,
stream utilities and user expectations.
It is highly discouraged to override any public method. As well as emitting any
internal events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
manually through `.emit(err)` instead of using API provided callbacks or
`.destroy(err)`. Doing so can break current and future stream invariants
leading to behaviour and/or compatibility issues with other streams, stream
utilities and user expectations.

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

0 comments on commit e2207eb

Please sign in to comment.