Symbol

listen

function listen<Data = undefined>(): TCPSocketListener<Data>;

Create a TCP server that listens on a port

function listen<Data = undefined>(): UnixSocketListener<Data>;

Create a TCP server that listens on a unix socket

Referenced types

allowHalfOpen?: boolean
Whether to allow half-open connections.
A half-open connection occurs when one end of the connection has called close() or sent a FIN packet, while the other end remains open. When set to true:
The socket won't automatically send FIN when the remote side closes its end
The local side can continue sending data even after the remote side has closed
The application must explicitly call end() to fully close the connection
When false (default), the socket automatically closes both ends of the connection when either side closes.
data?: Data
The per-instance data context
exclusive?: boolean
Whether to use exclusive mode.
When set to true, the socket binds exclusively to the specified address:port combination, preventing other processes from binding to the same port.
When false (default), other sockets may be able to bind to the same port depending on the operating system's socket sharing capabilities and settings.
Exclusive mode is useful in scenarios where you want to ensure only one instance of your server can bind to a specific port at a time.
hostname: string
The hostname to listen on
port: number
The port to listen on
socket: SocketHandler<Data>
Handlers for socket events
tls?: TLSOptions
The TLS configuration object with which to create the server