diff options
author | Robert Nagy <ronagy@icloud.com> | 2019-08-11 11:23:46 +0200 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-08-14 15:56:20 -0700 |
commit | e505a741e30d7101a0c4b9159d9e48589a76e16c (patch) | |
tree | af1a068a05d4b669ab9957e6096dfec4c75ddf2f /doc/api/stream.md | |
parent | d30354859cb58a5ceaa77fd286a551b932236382 (diff) | |
download | android-node-v8-e505a741e30d7101a0c4b9159d9e48589a76e16c.tar.gz android-node-v8-e505a741e30d7101a0c4b9159d9e48589a76e16c.tar.bz2 android-node-v8-e505a741e30d7101a0c4b9159d9e48589a76e16c.zip |
doc: note that stream error can close stream
PR-URL: https://github.com/nodejs/node/pull/29082
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r-- | doc/api/stream.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index d52b635efa..cb6d23e525 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -277,7 +277,9 @@ added: v0.9.4 The `'error'` event is emitted if an error occurred while writing or piping data. The listener callback is passed a single `Error` argument when called. -The stream is not closed when the `'error'` event is emitted. +The stream is not closed when the `'error'` event is emitted unless the +[`autoDestroy`][writable-new] option was set to `true` when creating the +stream. ##### Event: 'finish' <!-- YAML @@ -2734,4 +2736,5 @@ contain multi-byte characters. [stream-write]: #stream_writable_write_chunk_encoding_callback [writable-_destroy]: #stream_writable_destroy_err_callback [writable-destroy]: #stream_writable_destroy_error +[writable-new]: #stream_constructor_new_stream_writable_options [zlib]: zlib.html |