Node.js module

net

The 'node:net' module provides an asynchronous network API for creating TCP servers and clients. It exposes Socket and Server classes for handling raw network connections.

Works in Bun · notes

Core TCP socket functionality works. The SocketAddress class is implemented internally but not exposed. BlockList exists but is currently a no-op.

Functions 10

net.connect()
Aliases to createConnection.
net.createConnection()
A factory function, which creates a new Socket, immediately initiates connection with socket.connect(), then returns the net.Socket that starts the connection.
net.createServer()
Creates a new TCP or IPC server.
net.getDefaultAutoSelectFamily()
Gets the current default value of the autoSelectFamily option of socket.connect(options).
net.getDefaultAutoSelectFamilyAttemptTimeout()
Gets the current default value of the autoSelectFamilyAttemptTimeout option of socket.connect(options).
net.isIP()
Returns 6 if input is an IPv6 address.
net.isIPv4()
Returns true if input is an IPv4 address in dot-decimal notation with no leading zeroes.
net.isIPv6()
Returns true if input is an IPv6 address.
net.setDefaultAutoSelectFamily()
Sets the default value of the autoSelectFamily option of socket.connect(options).
net.setDefaultAutoSelectFamilyAttemptTimeout()
Sets the default value of the autoSelectFamilyAttemptTimeout option of socket.connect(options).

Classes 5

class net.BlockList
The BlockList object can be used with some network APIs to specify rules for disabling inbound or outbound access to specific IP addresses, IP ranges, or
class net.BoundSocket
Allows for the synchronous creation of a pre-bound socket, that can be passed to listen() or new net.Socket() later on.
class net.Server
This class is used to create a TCP or IPC server.
class net.Socket
This class is an abstraction of a TCP socket or a streaming IPC endpoint (uses named pipes on Windows, and Unix domain sockets otherwise).
class net.SocketAddress

net

Functions 10

Classes 5

Interfaces 15

Types 5