diff options
| author | Robert Nagy <ronagy@icloud.com> | 2019-08-02 08:09:06 +0200 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-08-17 00:28:06 -0700 |
| commit | 6f613d8abb05619e35c828b665a76215861bbf04 (patch) | |
| tree | 18a904d44299c6564c5c83adc0051076f27bb922 /doc/api/stream.md | |
| parent | e4bbbcc84bd10be1e9e8e66d42542c70c1a02056 (diff) | |
| download | android-node-v8-6f613d8abb05619e35c828b665a76215861bbf04.tar.gz android-node-v8-6f613d8abb05619e35c828b665a76215861bbf04.tar.bz2 android-node-v8-6f613d8abb05619e35c828b665a76215861bbf04.zip | |
http,stream: add writableEnded
This is work towards resolving the response.finished confusion and
future deprecation.
Note that implementation-wise, streams have both an ending and ended
state. However, in this case (in order to avoid confusion in user space)
writableEnded is equal to writable.ending. The ending vs ended situation
is internal state required for internal stream logic.
PR-URL: https://github.com/nodejs/node/pull/28934
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 07755e05dc..14f5a9032e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -494,6 +494,17 @@ added: v11.4.0 Is `true` if it is safe to call [`writable.write()`][stream-write]. +##### writable.writableEnded +<!-- YAML +added: REPLACEME +--> + +* {boolean} + +Is `true` after [`writable.end()`][] has been called. This property +does not indicate whether the data has been flushed, for this use +[`writable.writableFinished`][] instead. + ##### writable.writableFinished <!-- YAML added: v12.6.0 @@ -2707,7 +2718,9 @@ contain multi-byte characters. [`stream.unpipe()`]: #stream_readable_unpipe_destination [`stream.wrap()`]: #stream_readable_wrap_stream [`writable.cork()`]: #stream_writable_cork +[`writable.end()`]: #stream_writable_end_chunk_encoding_callback [`writable.uncork()`]: #stream_writable_uncork +[`writable.writableFinished`]: #stream_writable_writablefinished [`zlib.createDeflate()`]: zlib.html#zlib_zlib_createdeflate_options [API for Stream Consumers]: #stream_api_for_stream_consumers [API for Stream Implementers]: #stream_api_for_stream_implementers |