0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00

doc: improve server.address() doc text

PR-URL: https://github.com/nodejs/node/pull/7001
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
This commit is contained in:
Rich Trott 2016-05-26 10:58:35 -07:00 committed by James M Snell
parent d5339b352c
commit 2783978847

View File

@ -37,10 +37,10 @@ Emitted when the server has been bound after calling `server.listen`.
### server.address()
Returns the bound address, the address family name and port of the server
Returns the bound address, the address family name, and port of the server
as reported by the operating system.
Useful to find which port was assigned when giving getting an OS-assigned address.
Returns an object with three properties, e.g.
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' }`
Example: