Skip to content

Commit 31b2cbb

Browse files
watsontargos
authored andcommitted
doc: document that server.address() can return null
PR-URL: #32519 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent cede0cb commit 31b2cbb

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/net.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Emitted when the server has been bound after calling [`server.listen()`][].
114114
added: v0.1.90
115115
-->
116116

117-
* Returns: {Object|string}
117+
* Returns: {Object|string|null}
118118

119119
Returns the bound `address`, the address `family` name, and `port` of the server
120120
as reported by the operating system if listening on an IP socket
@@ -138,7 +138,8 @@ server.listen(() => {
138138
});
139139
```
140140

141-
Don't call `server.address()` until the `'listening'` event has been emitted.
141+
`server.address()` returns `null` before the `'listening'` event has been
142+
emitted or after calling `server.close()`.
142143

143144
### `server.close([callback])`
144145
<!-- YAML

0 commit comments

Comments
 (0)