method Socket.prototype.connect

Overload 1

#Socket.prototype.connect(options: SocketConnectOpts,
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 #

#options: SocketConnectOpts

#connectionListener: () => void

optional

Return Type #

this

Overload 2

#Socket.prototype.connect(port: number,
host: string,
connectionListener?: () => void,
): this

Parameters #

#port: number

#host: string

#connectionListener: () => void

optional

Return Type #

this

Overload 3

#Socket.prototype.connect(port: number,
connectionListener?: () => void,
): this

Parameters #

#port: number

#connectionListener: () => void

optional

Return Type #

this

Overload 4

#Socket.prototype.connect(path: string,
connectionListener?: () => void,
): this

Parameters #

#path: string

#connectionListener: () => void

optional

Return Type #

this