Skip to content

Commit a01e829

Browse files
watsonBridgeAR
authored andcommittedNov 15, 2018
doc: document http request.finished boolean
PR-URL: #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>
1 parent 2aa23cd commit a01e829

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed
 

‎doc/api/http.md

+12
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,17 @@ If `data` is specified, it is equivalent to calling
575575
If `callback` is specified, it will be called when the request stream
576576
is finished.
577577

578+
### request.finished
579+
<!-- YAML
580+
added: v0.0.1
581+
-->
582+
583+
* {boolean}
584+
585+
The `request.finished` property will be `true` if [`request.end()`][]
586+
has been called. `request.end()` will automatically be called if the
587+
request was initiated via [`http.get()`][].
588+
578589
### request.flushHeaders()
579590
<!-- YAML
580591
added: v1.6.0
@@ -2079,6 +2090,7 @@ not abort the request or do anything besides add a `'timeout'` event.
20792090
[`http.ClientRequest`]: #http_class_http_clientrequest
20802091
[`http.IncomingMessage`]: #http_class_http_incomingmessage
20812092
[`http.Server`]: #http_class_http_server
2093+
[`http.get()`]: #http_http_get_options_callback
20822094
[`http.globalAgent`]: #http_http_globalagent
20832095
[`http.request()`]: #http_http_request_options_callback
20842096
[`message.headers`]: #http_message_headers

0 commit comments

Comments
 (0)