diff options
| author | Luigi Pinca <luigipinca@gmail.com> | 2022-04-15 01:09:19 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-15 01:09:19 +0300 |
| commit | 76e7170a40caf90b49827d156f37e0f3fe56fb2e (patch) | |
| tree | b70a0e4cacac9fa7b17dcd80e4e6dd148045eff2 /doc | |
| parent | c4a736ce12adbe8f97bd7126936d899de2bd002c (diff) | |
doc: document the 'close' and 'finish' events
These events are already documented as events of the
`http.ServerResponse` class. Document that they can also be emitted on
instances of the `http.ClientRequest` class.
PR-URL: https://github.com/nodejs/node/pull/42704
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/http.md b/doc/api/http.md index 8ad131af886..b6df4a24093 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -438,6 +438,15 @@ deprecated: Emitted when the request has been aborted by the client. This event is only emitted on the first call to `abort()`. +### Event: `'close'` + +<!-- YAML +added: v0.5.4 +--> + +Indicates that the request is completed, or its underlying connection was +terminated prematurely (before the response completion). + ### Event: `'connect'` <!-- YAML @@ -523,6 +532,17 @@ Emitted when the server sends a '100 Continue' HTTP response, usually because the request contained 'Expect: 100-continue'. This is an instruction that the client should send the request body. +### Event: `'finish'` + +<!-- YAML +added: v0.3.6 +--> + +Emitted when the request has been sent. More specifically, this event is emitted +when the last segment of the response headers and body have been handed off to +the operating system for transmission over the network. It does not imply that +the server has received anything yet. + ### Event: `'information'` <!-- YAML |