doc: add history entry for breaking destroy() change

Refs: https://github.com/nodejs/node/pull/29197#issuecomment-698252186

PR-URL: https://github.com/nodejs/node/pull/35326
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Gil Pedersen authored and Rich Trott committed 2020-09-27 07:33:02 -07:00
1 parent c3ab062ae5
commit 7fcbeb4e7e
1 file changed
+12
+12
View File
@@ -386,6 +386,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.
@@ -968,6 +972,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
@@ -1531,6 +1539,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}