From 382788a2d8a86ed5885ef814c7fa0a7185ed367a Mon Sep 17 00:00:00 2001 From: Thomas Watson Date: Fri, 27 Mar 2020 16:00:43 +0100 Subject: [PATCH] doc: document that server.address() can return null PR-URL: https://github.com/nodejs/node/pull/32519 Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen Reviewed-By: Evan Lucas Reviewed-By: Rich Trott --- doc/api/net.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/net.md b/doc/api/net.md index a7b6eff6008136..51a1b8b48ec4f6 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -114,7 +114,7 @@ Emitted when the server has been bound after calling [`server.listen()`][]. added: v0.1.90 --> -* Returns: {Object|string} +* Returns: {Object|string|null} Returns the bound `address`, the address `family` name, and `port` of the server as reported by the operating system if listening on an IP socket @@ -138,7 +138,8 @@ server.listen(() => { }); ``` -Don't call `server.address()` until the `'listening'` event has been emitted. +`server.address()` returns `null` before the `'listening'` event has been +emitted or after calling `server.close()`. ### `server.close([callback])`