Skip to main content

createConnection

function createConnection
Jump to headingcreateConnection(
options: NetConnectOpts,
connectionListener?: () => void,
): Socket

A factory function, which creates a new Socket, immediately initiates connection with socket.connect(), then returns the net.Socket that starts the connection.

When the connection is established, a 'connect' event will be emitted on the returned socket. The last parameter connectListener, if supplied, will be added as a listener for the 'connect' event once.

Possible signatures:

The connect function is an alias to this function.

Parameters Jump to heading

optional
Jump to headingconnectionListener: () => void

Return Type Jump to heading

Jump to headingcreateConnection(
port: number,
host?: string,
connectionListener?: () => void,
): Socket

Parameters Jump to heading

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

Return Type Jump to heading

Jump to headingcreateConnection(
path: string,
connectionListener?: () => void,
): Socket

Parameters Jump to heading

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

Return Type Jump to heading

Back to top