diff options
author | Thomas Watson <w@tson.dk> | 2018-11-12 12:36:32 +0100 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-11-14 18:20:49 +0200 |
commit | fab97ee6232dc4263321b22aa6d0a26234ecaab7 (patch) | |
tree | 400d89bd3434554cb3210fdd0138660a3eec3578 /doc | |
parent | 0e06b350b6d7c80875321531593efc6f273620e5 (diff) | |
download | android-node-v8-fab97ee6232dc4263321b22aa6d0a26234ecaab7.tar.gz android-node-v8-fab97ee6232dc4263321b22aa6d0a26234ecaab7.tar.bz2 android-node-v8-fab97ee6232dc4263321b22aa6d0a26234ecaab7.zip |
doc: document http request.finished boolean
PR-URL: https://github.com/nodejs/node/pull/24319
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/http.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/http.md b/doc/api/http.md index 442cfc22de..1c6b5717e0 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -575,6 +575,17 @@ If `data` is specified, it is equivalent to calling If `callback` is specified, it will be called when the request stream is finished. +### request.finished +<!-- YAML +added: v0.0.1 +--> + +* {boolean} + +The `request.finished` property will be `true` if [`request.end()`][] +has been called. `request.end()` will automatically be called if the +request was initiated via [`http.get()`][]. + ### request.flushHeaders() <!-- YAML added: v1.6.0 @@ -2079,6 +2090,7 @@ not abort the request or do anything besides add a `'timeout'` event. [`http.ClientRequest`]: #http_class_http_clientrequest [`http.IncomingMessage`]: #http_class_http_incomingmessage [`http.Server`]: #http_class_http_server +[`http.get()`]: #http_http_get_options_callback [`http.globalAgent`]: #http_http_globalagent [`http.request()`]: #http_http_request_options_callback [`message.headers`]: #http_message_headers |