From 02d8c3bc9c4a1e0f6c11ea97f903c50f66813122 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Fri, 15 Apr 2022 00:09:19 +0200 Subject: [PATCH] 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 Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: Akhil Marsonya Reviewed-By: Mestery --- doc/api/http.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/api/http.md b/doc/api/http.md index fbc8cefec86576..67339c7bfc22c4 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -434,6 +434,15 @@ deprecated: v16.12.0 Emitted when the request has been aborted by the client. This event is only emitted on the first call to `abort()`. +### Event: `'close'` + + + +Indicates that the request is completed, or its underlying connection was +terminated prematurely (before the response completion). + ### Event: `'connect'` + +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'`