diff --git a/doc/api/net.md b/doc/api/net.md index 0a3800f3b90..3bf4f5659af 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -1602,6 +1602,10 @@ If the socket is `ref`ed calling `ref` again will have no effect. * Type: {string} @@ -1610,6 +1614,14 @@ The string representation of the remote IP address. For example, `'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if the socket is destroyed (for example, if the client disconnected). +For a [Unix domain socket][IPC], this is the path the peer is bound to: the +listening path on the connecting side, and on the accepting side the path of a +client that was bound before connecting (see [`BoundSocket`][]). It is +`undefined` if the peer is not bound to a path, which is the case for most +clients. [`socket.remoteFamily`][] and [`socket.remotePort`][] are always +`undefined` for these connections, as is `socket.remoteAddress` for a Windows +named pipe. + ### `socket.remoteFamily`