diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2019-01-03 16:09:24 -0800 |
|---|---|---|
| committer | Sam Roberts <vieuxtech@gmail.com> | 2019-01-08 19:54:53 -0800 |
| commit | ccc06a3c3291546c777da74cd3bdff903b33c607 (patch) | |
| tree | 61084ca16b53ce4a346f54700096ef748b94840a /doc/api/net.md | |
| parent | 9b7226d66c330f700f1672b34dbc4c2aba1b9592 (diff) | |
| download | android-node-v8-ccc06a3c3291546c777da74cd3bdff903b33c607.tar.gz android-node-v8-ccc06a3c3291546c777da74cd3bdff903b33c607.tar.bz2 android-node-v8-ccc06a3c3291546c777da74cd3bdff903b33c607.zip | |
doc: clarify timing of socket.connecting
Fixes: https://github.com/nodejs/node/issues/25328
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index 4243d68f87..4cc741f7d4 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -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 |