summaryrefslogtreecommitdiff
path: root/doc/api/stream.md
diff options
context:
space:
mode:
authorzero1five <zerodengyin@gmail.com>2019-06-02 03:04:56 +0800
committerRich Trott <rtrott@gmail.com>2019-06-25 14:46:10 -0700
commit33aef82b42ca689411673784e203e59d3f4eb142 (patch)
tree2d329d20782e537d53507f5fbe98897803149273 /doc/api/stream.md
parent2bb93e11085ea582aea1636f544d900520d479ed (diff)
downloadandroid-node-v8-33aef82b42ca689411673784e203e59d3f4eb142.tar.gz
android-node-v8-33aef82b42ca689411673784e203e59d3f4eb142.tar.bz2
android-node-v8-33aef82b42ca689411673784e203e59d3f4eb142.zip
stream: add writableFinished
add a new getter to duplex stream to replace the property `this .writableState.finished` of the object that inherited duplex. Refs: https://github.com/nodejs/node/issues/445 PR-URL: https://github.com/nodejs/node/pull/28007 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r--doc/api/stream.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index a5c55f5ca1..155e39906b 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -503,6 +503,16 @@ This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding
the status of the `highWaterMark`.
+##### writable.writableFinished
+<!-- YAML
+added: v12.4.0
+-->
+
+* {boolean}
+
+Is `true` if all data has been flushed to the underlying system. After
+the [`'finish'`][] event has been emitted.
+
##### writable.writableObjectMode
<!-- YAML
added: v12.3.0