Skip to content

Commit

Permalink
doc: improve server.address() doc text
Browse files Browse the repository at this point in the history
PR-URL: #7001
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
  • Loading branch information
Trott authored and rvagg committed Jun 2, 2016
1 parent ae1bf83 commit 3ae9f14
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 3ae9f14

Please sign in to comment.