Skip to content

Commit

Permalink
doc: clarify timing of socket.connecting
Browse files Browse the repository at this point in the history
Fixes: #25328

PR-URL: #25333
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
sam-github authored and addaleax committed Jan 14, 2019
1 parent e9b4d24 commit f3d8639
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -666,11 +666,12 @@ added: v6.1.0
-->

If `true`,
[`socket.connect(options[, connectListener])`][`socket.connect(options)`] was
called and has not yet finished. It will stay `true` until the socket becomes
connected, then it is set to `false` and the `'connect'` event is emitted. Note
that the
[`socket.connect(options[, connectListener])`][`socket.connect(options)`]
was called and has not yet finished. Will be set to `true` before emitting
`'connect'` event and/or calling
[`socket.connect(options[, connectListener])`][`socket.connect(options)`]'s
callback.
callback is a listener for the `'connect'` event.

### socket.destroy([exception])
<!-- YAML
Expand Down

0 comments on commit f3d8639

Please sign in to comment.