BuildDocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
FcreateConnection
Bun

function

net.createConnection

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:

  • createConnection
  • createConnection for IPC connections.
  • createConnection for TCP connections.

The connect function is an alias to this function.

port: number,
host?: string,
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:

  • createConnection
  • createConnection for IPC connections.
  • createConnection for TCP connections.

The connect function is an alias to this function.

path: string,
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:

  • createConnection
  • createConnection for IPC connections.
  • createConnection for TCP connections.

The connect function is an alias to this function.