diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2019-01-03 16:09:24 -0800 |
|---|---|---|
| committer | Sam Roberts <vieuxtech@gmail.com> | 2019-01-08 10:48:13 -0800 |
| commit | 4e2b920fb00f8b7ab5bd8d4a00ba52dc71c92766 (patch) | |
| tree | f3ca0dd004e50bd8544a41994b7d1e349261d2ae | |
| parent | 9987f1abb92461af5b2da61befe7ce0c1ab19503 (diff) | |
| download | node-new-clarify-socket-connecting.tar.gz | |
doc: clarify timing of socket.connectingclarify-socket-connecting
Fixes: https://github.com/nodejs/node/issues/25328
| -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 |