diff --git a/doc/api/dns.md b/doc/api/dns.md index e930892cedc927..53af8491a7ef22 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -183,7 +183,7 @@ corresponding lookup methods. On error, `err` is an [`Error`][] object, where `err.code` is one of the error codes listed [here](#dns_error_codes). -## dns.resolve4(hostname, callback) +## dns.resolve4(hostname[, options], callback) @@ -193,7 +193,14 @@ Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the will contain an array of IPv4 addresses (e.g. `['74.125.79.104', '74.125.79.105', '74.125.79.106']`). -## dns.resolve6(hostname, callback) +* `hostname` {String} Hostname to resolve. +* `options` {Object} + * `ttl` {Boolean} Retrieve the Time-To-Live value (TTL) of each record. + The callback receives an array of `{ address: '1.2.3.4', ttl: 60 }` objects + rather than an array of strings. The TTL is expressed in seconds. +* `callback` {Function} An `(err, result)` callback function. + +## dns.resolve6(hostname[, options], callback) @@ -202,6 +209,13 @@ Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the `hostname`. The `addresses` argument passed to the `callback` function will contain an array of IPv6 addresses. +* `hostname` {String} Hostname to resolve. +* `options` {Object} + * `ttl` {Boolean} Retrieve the Time-To-Live value (TTL) of each record. + The callback receives an array of `{ address: '0:1:2:3:4:5:6:7', ttl: 60 }` + objects rather than an array of strings. The TTL is expressed in seconds. +* `callback` {Function} An `(err, result)` callback function. + ## dns.resolveCname(hostname, callback)