From 3ae9f1469d655ae838ca0fbde5e818de84a0dfb9 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 26 May 2016 10:58:35 -0700 Subject: [PATCH] doc: improve `server.address()` doc text PR-URL: https://github.com/nodejs/node/pull/7001 Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Santiago Gimeno --- doc/api/net.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/net.md b/doc/api/net.md index 02eeb26f5c4ca7..d1cc825fbc17d9 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -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: