1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: dns examples implied string args were arrays

Browse Source 
Fix: https://github.com/nodejs/node/pull/11334
PR-URL: https://github.com/nodejs/node/pull/11350
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Sam Roberts 2017-02-13 12:04:00 -08:00
parent adf1ed0146
commit 642eec162d
1 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/api/dns.md
View File

@ -15,9 +15,10 @@ For example, looking up `iana.org`.
```js ```js
const dns = require('dns'); const dns = require('dns');
dns.lookup('iana.org', (err, addresses, family) => { dns.lookup('iana.org', (err, address, family) => {
console.log('addresses:', addresses); console.log('address: %j family: IPv%s', address, family);
}); });
// address: "192.0.43.8" family: IPv4
``` ```
2) Functions that connect to an actual DNS server to perform name resolution, 2) Functions that connect to an actual DNS server to perform name resolution,
@ -84,15 +85,7 @@ Alternatively, `options` can be an object containing these properties:
* `all`: {Boolean} - When `true`, the callback returns all resolved addresses * `all`: {Boolean} - When `true`, the callback returns all resolved addresses
in an array, otherwise returns a single address. Defaults to `false`. in an array, otherwise returns a single address. Defaults to `false`.
All properties are optional. An example usage of options is shown below. All properties are optional.
```js
{
family: 4,
hints: dns.ADDRCONFIG | dns.V4MAPPED,
all: false
}
```
The `callback` function has arguments `(err, address, family)`. `address` is a The `callback` function has arguments `(err, address, family)`. `address` is a
string representation of an IPv4 or IPv6 address. `family` is either the string representation of an IPv4 or IPv6 address. `family` is either the
@ -115,6 +108,25 @@ important consequences on the behavior of any Node.js program. Please take some
time to consult the [Implementation considerations section][] before using time to consult the [Implementation considerations section][] before using
`dns.lookup()`. `dns.lookup()`.
Example usage:
```js
const dns = require('dns');
const options = {
family: 6,
hints: dns.ADDRCONFIG | dns.V4MAPPED,
};
dns.lookup('example.com', options, (err, address, family) =>
console.log('address: %j family: IPv%s', address, family));
// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6
// When options.all is true, the result will be an Array.
options.all = true;
dns.lookup('example.com', options, (err, addresses) =>
console.log('addresses: %j', addresses));
// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]
```
### Supported getaddrinfo flags ### Supported getaddrinfo flags
The following flags can be passed as hints to [`dns.lookup()`][]. The following flags can be passed as hints to [`dns.lookup()`][].