Skip to content

Commit e111d71

Browse files
watsoncodebytere
authored andcommitted
doc: document http request.finished boolean
PR-URL: #24319 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 1ca3c9d commit e111d71

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
@@ -569,6 +569,17 @@ If `data` is specified, it is equivalent to calling
569569
If `callback` is specified, it will be called when the request stream
570570
is finished.
571571

572+
### request.finished
573+
<!-- YAML
574+
added: v0.0.1
575+
-->
576+
577+
* {boolean}
578+
579+
The `request.finished` property will be `true` if [`request.end()`][]
580+
has been called. `request.end()` will automatically be called if the
581+
request was initiated via [`http.get()`][].
582+
572583
### request.flushHeaders()
573584
<!-- YAML
574585
added: v1.6.0
@@ -2106,6 +2117,7 @@ not abort the request or do anything besides add a `'timeout'` event.
21062117
[`http.ClientRequest`]: #http_class_http_clientrequest
21072118
[`http.IncomingMessage`]: #http_class_http_incomingmessage
21082119
[`http.Server`]: #http_class_http_server
2120+
[`http.get()`]: #http_http_get_options_callback
21092121
[`http.globalAgent`]: #http_http_globalagent
21102122
[`http.request()`]: #http_http_request_options_callback
21112123
[`message.headers`]: #http_message_headers

0 commit comments

Comments
 (0)