diff options
| author | Robert Nagy <ronagy@icloud.com> | 2020-04-25 22:16:51 +0300 |
|---|---|---|
| committer | Robert Nagy <ronagy@icloud.com> | 2020-04-27 22:31:27 +0300 |
| commit | e5512acfa737b86dac0906414d2b34ab1ca6c6d0 (patch) | |
| tree | c6561ed1111498429e4d545a0b61ee14066d6f3e /doc/api/stream.md | |
| parent | d027f71100be11b21605faf75e83bc1abb9bb86a (diff) | |
doc: document major finished changes in v14
Added description of semver-major changes to finished in v14.
PR-URL: https://github.com/nodejs/node/pull/33065
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 4f155512ac4..0f89b77bc35 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1503,6 +1503,21 @@ further errors except from `_destroy` may be emitted as `'error'`. ### `stream.finished(stream[, options], callback)` <!-- YAML added: v10.0.0 +changes: + - version: v14.0.0 + pr-url: https://github.com/nodejs/node/pull/32158 + description: The `finished(stream, cb)` will wait for the `'close'` event + before invoking the callback. The implementation tries to + detect legacy streams and only apply this behavior to streams + which are expected to emit `'close'`. + - version: v14.0.0 + pr-url: https://github.com/nodejs/node/pull/31545 + description: Emitting `'close'` before `'end'` on a `Readable` stream + will cause an `ERR_STREAM_PREMATURE_CLOSE` error. + - version: v14.0.0 + pr-url: https://github.com/nodejs/node/pull/31509 + description: Callback will be invoked on streams which have already + finished before the call to `finished(stream, cb)`. --> * `stream` {Stream} A readable and/or writable stream. @@ -1580,6 +1595,12 @@ changes: - version: v13.10.0 pr-url: https://github.com/nodejs/node/pull/31223 description: Add support for async generators. + - version: v14.0.0 + pr-url: https://github.com/nodejs/node/pull/32158 + description: The `pipeline(..., cb)` will wait for the `'close'` event + before invoking the callback. The implementation tries to + detect legacy streams and only apply this behavior to streams + which are expected to emit `'close'`. --> * `source` {Stream|Iterable|AsyncIterable|Function} |