summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Nagy <ronagy@icloud.com>2019-07-23 09:40:13 +0200
committerRich Trott <rtrott@gmail.com>2019-08-19 22:03:07 -0700
commit317fa3a7574e90e83bbd09acc9b9ab61defccf3d (patch)
tree004ed9b4ee24fb72e59c05ed560a3ea7731a4ac8 /doc
parent0d7acfac82a20fceb7aa91c61abc18b711edba28 (diff)
downloadandroid-node-v8-317fa3a7574e90e83bbd09acc9b9ab61defccf3d.tar.gz
android-node-v8-317fa3a7574e90e83bbd09acc9b9ab61defccf3d.tar.bz2
android-node-v8-317fa3a7574e90e83bbd09acc9b9ab61defccf3d.zip
stream: add readableEnded
Adds a readableEnded property and improved finished compat with possible stream-like objects. PR-URL: https://github.com/nodejs/node/pull/28814 Refs: https://github.com/nodejs/node/issues/28813 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/stream.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 14f5a9032e..d670c7bc6f 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1129,6 +1129,15 @@ added: v12.7.0
Getter for the property `encoding` of a given `Readable` stream. The `encoding`
property can be set using the [`readable.setEncoding()`][] method.
+##### readable.readableEnded
+<!-- YAML
+added: REPLACEME
+-->
+
+* {boolean}
+
+Becomes `true` when [`'end'`][] event is emitted.
+
##### readable.readableHighWaterMark
<!-- YAML
added: v9.3.0