Skip to content

Commit 86ac749

Browse files
kanongilMylesBorins
authored andcommitted
doc: add history entry for breaking destroy() change
Refs: #29197 (comment) PR-URL: #35326 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent 857e321 commit 86ac749

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/api/stream.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,10 @@ See also: [`writable.uncork()`][], [`writable._writev()`][stream-_writev].
379379
##### `writable.destroy([error])`
380380
<!-- YAML
381381
added: v8.0.0
382+
changes:
383+
- version: v14.0.0
384+
pr-url: https://github.com/nodejs/node/pull/29197
385+
description: Work as noop when called on an already `destroyed` stream.
382386
-->
383387

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

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

15301542
* `error` {Error}

0 commit comments

Comments
 (0)