diff options
| author | Gil Pedersen <git@gpost.dk> | 2020-09-24 13:27:06 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-09-27 17:33:02 +0300 |
| commit | 7fcbeb4e7e63a11bf9de91ccf54a7d745b73c9d1 (patch) | |
| tree | 44c737f2578fe5cd8b6170f2314cc028756e66f4 /doc/api/stream.md | |
| parent | c3ab062ae50a8d2ab51d4b30441dca3d21b1e5a7 (diff) | |
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>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 97e848f56fa..8a69c5835be 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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} |