-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: server close event does not have an argument
Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com> PR-URL: #1025
- Loading branch information
1 parent
a4b4600
commit 54627a9
Showing
1 changed file
with
8 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -193,7 +193,7 @@ Listening on a file descriptor is not supported on Windows. | |
|
||
This function is asynchronous. When the server has been bound, | ||
['listening'][] event will be emitted. | ||
the last parameter `callback` will be added as an listener for the | ||
The last parameter `callback` will be added as an listener for the | ||
['listening'][] event. | ||
|
||
### server.listen(options[, callback]) | ||
|
@@ -228,10 +228,10 @@ shown below. | |
|
||
Stops the server from accepting new connections and keeps existing | ||
connections. This function is asynchronous, the server is finally | ||
closed when all connections are ended and the server emits a `'close'` | ||
event. Optionally, you can pass a callback to listen for the `'close'` | ||
event. If present, the callback is invoked with any potential error | ||
as the first and only argument. | ||
closed when all connections are ended and the server emits a ['close'][] event. | ||
The optional `callback` will be called once the `'close'` event occurs. Unlike | ||
that event, it will be called with an Error as its only argument if the server | ||
was not open when it was closed. | ||
|
||
### server.address() | ||
|
||
|
@@ -317,7 +317,7 @@ event is not emitted until all connections are ended. | |
|
||
* {Error Object} | ||
|
||
Emitted when an error occurs. The `'close'` event will be called directly | ||
Emitted when an error occurs. The ['close'][] event will be called directly | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
sam-github
Author
Contributor
|
||
following this event. See example in discussion of `server.listen`. | ||
|
||
## Class: net.Socket | ||
|
@@ -597,7 +597,7 @@ following this event. | |
|
||
### Event: 'close' | ||
|
||
* `had_error` {Boolean} true if the socket had a transmission error | ||
* `had_error` {Boolean} `true` if the socket had a transmission error. | ||
This comment has been minimized.
Sorry, something went wrong.
ronkorving
Contributor
|
||
|
||
Emitted once the socket is fully closed. The argument `had_error` is a boolean | ||
which says if the socket was closed due to a transmission error. | ||
|
@@ -617,6 +617,7 @@ Returns true if input is a version 4 IP address, otherwise returns false. | |
|
||
Returns true if input is a version 6 IP address, otherwise returns false. | ||
|
||
['close']: #net_event_close | ||
['connect']: #net_event_connect | ||
['connection']: #net_event_connection | ||
['end']: #net_event_end | ||
|
Suggest changing "called" to "emitted".