Skip to main content

connect

method Socket.prototype.connect
Jump to headingSocket.prototype.connect(
connectionListener?: () => void,
): this

Initiate a connection on a given socket.

Possible signatures:

  • socket.connect(options[, connectListener])
  • socket.connect(path[, connectListener]) for IPC connections.
  • socket.connect(port[, host][, connectListener]) for TCP connections.
  • Returns: net.Socket The socket itself.

This function is asynchronous. When the connection is established, the 'connect' event will be emitted. If there is a problem connecting, instead of a 'connect' event, an 'error' event will be emitted with the error passed to the 'error' listener. The last parameter connectListener, if supplied, will be added as a listener for the 'connect' event once.

This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

Parameters Jump to heading

optional
Jump to headingconnectionListener: () => void

Return Type Jump to heading

this
Jump to headingSocket.prototype.connect(
port: number,
host: string,
connectionListener?: () => void,
): this

Parameters Jump to heading

Jump to headingport: number
Jump to headinghost: string
optional
Jump to headingconnectionListener: () => void

Return Type Jump to heading

this
Jump to headingSocket.prototype.connect(
port: number,
connectionListener?: () => void,
): this

Parameters Jump to heading

Jump to headingport: number
optional
Jump to headingconnectionListener: () => void

Return Type Jump to heading

this
Jump to headingSocket.prototype.connect(
path: string,
connectionListener?: () => void,
): this

Parameters Jump to heading

Jump to headingpath: string
optional
Jump to headingconnectionListener: () => void

Return Type Jump to heading

this
Back to top