Skip to content

Commit 6abfcd5

Browse files
jjqq2013MylesBorins
authored andcommitted
doc: add comment for net.Server's error event
Fixes: #9710 PR-URL: #11136 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
1 parent fa681ea commit 6abfcd5

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/api/net.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ added: v0.1.90
4040

4141
* {Error}
4242

43-
Emitted when an error occurs. The [`'close'`][] event will be called directly
44-
following this event. See example in discussion of `server.listen`.
43+
Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][]
44+
event will **not** be emitted directly following this event unless
45+
[`server.close()`][] is manually called. See the example in discussion of
46+
[`server.listen()`][`server.listen(port, host, backlog, callback)`].
4547

4648
### Event: 'listening'
4749
<!-- YAML
@@ -899,6 +901,7 @@ Returns true if input is a version 6 IP address, otherwise returns false.
899901
[`resume()`]: #net_socket_resume
900902
[`server.getConnections()`]: #net_server_getconnections_callback
901903
[`server.listen(port, host, backlog, callback)`]: #net_server_listen_port_hostname_backlog_callback
904+
[`server.close()`]: #net_server_close_callback
902905
[`socket.connect(options, connectListener)`]: #net_socket_connect_options_connectlistener
903906
[`socket.connect`]: #net_socket_connect_options_connectlistener
904907
[`socket.setTimeout()`]: #net_socket_settimeout_timeout_callback

0 commit comments

Comments
 (0)