diff options
| author | Matteo Collina <hello@matteocollina.com> | 2019-01-09 13:07:59 +0100 |
|---|---|---|
| committer | Matteo Collina <hello@matteocollina.com> | 2019-01-12 11:43:07 +0100 |
| commit | 18d3aebb06903a0151bdecbad2b6b7077b965d03 (patch) | |
| tree | 997a21ed3fb0b068b25c1760dec692fcb88101d6 /doc | |
| parent | 91ef9c4c3f7d8acc21ad934dd520071b8bdfcab8 (diff) | |
| download | android-node-v8-18d3aebb06903a0151bdecbad2b6b7077b965d03.tar.gz android-node-v8-18d3aebb06903a0151bdecbad2b6b7077b965d03.tar.bz2 android-node-v8-18d3aebb06903a0151bdecbad2b6b7077b965d03.zip | |
doc: document that stream.on('close') was changed in Node 10
See: https://github.com/nodejs/node/issues/25373
See: https://github.com/nodejs/node/pull/18438
PR-URL: https://github.com/nodejs/node/pull/25413
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index b8b456f043..6518b45e8b 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -219,13 +219,19 @@ added: v0.9.4 ##### Event: 'close' <!-- YAML added: v0.9.4 +changes: + - version: v10.0.0 + pr-url: https://github.com/nodejs/node/pull/18438 + description: Add `emitClose` option to specify if `'close'` is emitted on + destroy. --> The `'close'` event is emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. The event indicates that no more events will be emitted, and no further computation will occur. -Not all `Writable` streams will emit the `'close'` event. +A [`Writable`][] stream will always emit the `'close'` event if it is +created with the `emitClose` option. ##### Event: 'drain' <!-- YAML @@ -704,13 +710,19 @@ added: v0.9.4 ##### Event: 'close' <!-- YAML added: v0.9.4 +changes: + - version: v10.0.0 + pr-url: https://github.com/nodejs/node/pull/18438 + description: Add `emitClose` option to specify if `'close'` is emitted on + destroy. --> The `'close'` event is emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. The event indicates that no more events will be emitted, and no further computation will occur. -Not all [`Readable`][] streams will emit the `'close'` event. +A [`Readable`][] stream will always emit the `'close'` event if it is +created with the `emitClose` option. ##### Event: 'data' <!-- YAML |