Commit f3d8639
doc: clarify timing of socket.connecting
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>1 parent e9b4d24 commit f3d8639
1 file changed
Lines changed: 5 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -666,11 +666,12 @@ added: v6.1.0 | |||
| 666 | 666 | --> | |
| 667 | 667 | ||
| 668 | 668 | If `true`, | |
| 669 | + [`socket.connect(options[, connectListener])`][`socket.connect(options)`] was | ||
| 670 | + called and has not yet finished. It will stay `true` until the socket becomes | ||
| 671 | + connected, then it is set to `false` and the `'connect'` event is emitted. Note | ||
| 672 | + that the | ||
| 669 | 673 | [`socket.connect(options[, connectListener])`][`socket.connect(options)`] | |
| 670 | - was called and has not yet finished. Will be set to `true` before emitting | ||
| 671 | - `'connect'` event and/or calling | ||
| 672 | - [`socket.connect(options[, connectListener])`][`socket.connect(options)`]'s | ||
| 673 | - callback. | ||
| 674 | + callback is a listener for the `'connect'` event. | ||
| 674 | 675 | ||
| 675 | 676 | ### socket.destroy([exception]) | |
| 676 | 677 | <!-- YAML | |
0 commit comments