Commit 9c700f3
doc: clarify dns.lookup() callback signature when all is true
Document the `addresses` argument returned by the callback when
`options.all` is true, and note that `address` and `family` are
not provided in that case. Fixes #57355
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
PR-URL: #62800
Fixes: #57355
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Tim Perry <pimterry@gmail.com>1 parent bfc1319 commit 9c700f3
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -277,9 +277,15 @@ changes: | |||
| 277 | 277 | * `callback` {Function} | |
| 278 | 278 | * `err` {Error} | |
| 279 | 279 | * `address` {string} A string representation of an IPv4 or IPv6 address. | |
| 280 | + Not provided when `options.all` is `true`. | ||
| 280 | 281 | * `family` {integer} `4` or `6`, denoting the family of `address`, or `0` if | |
| 281 | 282 | the address is not an IPv4 or IPv6 address. `0` is a likely indicator of a | |
| 282 | 283 | bug in the name resolution service used by the operating system. | |
| 284 | + Not provided when `options.all` is `true`. | ||
| 285 | + * `addresses` {Object\[]} An array of address objects when `options.all` is | ||
| 286 | + `true`. Each object has the following properties: | ||
| 287 | + * `address` {string} A string representation of an IPv4 or IPv6 address. | ||
| 288 | + * `family` {integer} `4` or `6`, denoting the family of `address`. | ||
| 283 | 289 | ||
| 284 | 290 | Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or | |
| 285 | 291 | AAAA (IPv6) record. All `option` properties are optional. If `options` is an | |
0 commit comments