Skip to content

Commit

Permalink
doc: add history entry for breaking destroy() change
Browse files Browse the repository at this point in the history
Refs: #29197 (comment)

PR-URL: #35326
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
kanongil authored and MylesBorins committed Sep 29, 2020
1 parent 857e321 commit 86ac749
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,10 @@ See also: [`writable.uncork()`][], [`writable._writev()`][stream-_writev].
##### `writable.destroy([error])`
<!-- YAML
added: v8.0.0
changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/29197
description: Work as noop when called on an already `destroyed` stream.
-->

* `error` {Error} Optional, an error to emit with `'error'` event.
Expand Down Expand Up @@ -961,6 +965,10 @@ called and `readableFlowing` is not `true`.
##### `readable.destroy([error])`
<!-- YAML
added: v8.0.0
changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/29197
description: Work as noop when called on an already `destroyed` stream.
-->

* `error` {Error} Error which will be passed as payload in `'error'` event
Expand Down Expand Up @@ -1525,6 +1533,10 @@ Examples of `Transform` streams include:
##### `transform.destroy([error])`
<!-- YAML
added: v8.0.0
changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/29197
description: Work as noop when called on an already `destroyed` stream.
-->

* `error` {Error}
Expand Down

0 comments on commit 86ac749

Please sign in to comment.