UnixSocketOptions

interface UnixSocketOptions<Data = undefined>

• 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, the socket automatically closes both ends of the connection when either side closes.

• data?: Data

  The per-instance data context

• socket: SocketHandler<Data>

  Handlers for socket events

• tls?: boolean | TLSOptions

  TLS Configuration with which to create the socket

• unix: string

  The unix socket to listen on or connect to