Skip to content

Commit

Permalink
doc: server close event does not have an argument
Browse files Browse the repository at this point in the history
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: #1025
  • Loading branch information
sam-github committed Jul 28, 2015
1 parent a4b4600 commit 54627a9
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions doc/api/net.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Expand Down Expand Up @@ -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()

Expand Down Expand Up @@ -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.

Copy link
@ronkorving

ronkorving Jul 29, 2015

Contributor

Suggest changing "called" to "emitted".

This comment has been minimized.

Copy link
@sam-github

sam-github Jul 29, 2015

Author Contributor

@ronkorving This PR does not introduce the text you are commenting on, so this comment seems out of place. Please PR any contributions you would like to make to the node docs, they can surely use improvements.

following this event. See example in discussion of `server.listen`.

## Class: net.Socket
Expand Down Expand Up @@ -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.

Copy link
@ronkorving

ronkorving Jul 29, 2015

Contributor

false otherwise? (requires confirmation)
Also, what if it had a connection error? That's not a transmission error, is it? But I still expect had_error to be true.


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.
Expand All @@ -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
Expand Down

0 comments on commit 54627a9

Please sign in to comment.