Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorRobert Nagy <ronagy@icloud.com>2021-07-10 16:03:02 +0300
committerRobert Nagy <ronagy@icloud.com>2021-07-12 13:08:43 +0300
commit09d8c0c8d2c17fc07e9e313c0f35a7b696d18bc8 (patch)
tree359dbba5acedcea721c372c9de4a0d1cd5af6ccb /doc/api
parenta5dec3a4707c8523529fc8446328ec8cf0011fd1 (diff)
stream: destroy readable on read error
PR-URL: https://github.com/nodejs/node/pull/39342 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/stream.md3
1 files changed, 0 insertions, 3 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 603e0407a8c..63f444ec796 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1525,9 +1525,6 @@ added: v16.3.0
* `destroyOnReturn` {boolean} When set to `false`, calling `return` on the
async iterator, or exiting a `for await...of` iteration using a `break`,
`return`, or `throw` will not destroy the stream. **Default:** `true`.
- * `destroyOnError` {boolean} When set to `false`, if the stream emits an
- error while it's being iterated, the iterator will not destroy the stream.
- **Default:** `true`.
* Returns: {AsyncIterator} to consume the stream.
The iterator created by this method gives users the option to cancel the