Skip to content

Commit

Permalink
http: add note about clientError event
Browse files Browse the repository at this point in the history
PR-URL: #46584
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
ShogunPanda authored and MylesBorins committed Feb 20, 2023

Verified

This commit was signed with the committer’s verified signature.
targos Michaël Zasso
1 parent 217f2f6 commit 7f2cdd3
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/api/http.md
Original file line number Diff line number Diff line change
@@ -1310,7 +1310,8 @@ changes:
If a client connection emits an `'error'` event, it will be forwarded here.
Listener of this event is responsible for closing/destroying the underlying
socket. For example, one may wish to more gracefully close the socket with a
custom HTTP response instead of abruptly severing the connection.
custom HTTP response instead of abruptly severing the connection. The socket
**must be closed or destroyed** before the listener ends.

This event is guaranteed to be passed an instance of the {net.Socket} class,
a subclass of {stream.Duplex}, unless the user specifies a socket

0 comments on commit 7f2cdd3

Please sign in to comment.