Permalink
Browse files

doc: add docs for server.address() for pipe case

Add documentation for net.server.address() for the case it is listening
on a pipe or unix domain socket instead an IP socket.

PR-URL: #12907
Fixes: #12895
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information...
Flarna authored and jasnell committed May 8, 2017
1 parent cfe7b34 commit 13487c437cea783a91db775dd003b24a147b112e
Showing with 4 additions and 1 deletion.
  1. +4 −1 doc/api/net.md
View
@@ -99,11 +99,14 @@ added: v0.1.90
-->
Returns the bound address, the address family name, and port of the server
as reported by the operating system.
as reported by the operating system if listening on an IP socket.
Useful to find which port was assigned when getting an OS-assigned address.
Returns an object with `port`, `family`, and `address` properties:
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`
For a server listening on a pipe or UNIX domain socket, the name is returned
as a string.
Example:
```js

0 comments on commit 13487c4

Please sign in to comment.