diff options
author | Tobias Nießen <tniessen@tnie.de> | 2017-09-19 14:51:28 +0200 |
---|---|---|
committer | Tobias Nießen <tniessen@tnie.de> | 2017-09-22 02:54:00 +0200 |
commit | 3888a576ac83239d8d3d2fc985e7ea1856dac83e (patch) | |
tree | 54105c07d0a9044f3e786a9120364abf2a102316 /doc | |
parent | 60460bf80dbba313759b0c6f73f8c17831b17e11 (diff) | |
download | android-node-v8-3888a576ac83239d8d3d2fc985e7ea1856dac83e.tar.gz android-node-v8-3888a576ac83239d8d3d2fc985e7ea1856dac83e.tar.bz2 android-node-v8-3888a576ac83239d8d3d2fc985e7ea1856dac83e.zip |
doc: fix types and description for dns.resolveTxt
PR-URL: https://github.com/nodejs/node/pull/15472
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/dns.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/dns.md b/doc/api/dns.md index 5e9fc97bbc..d564aea424 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -266,7 +266,7 @@ records. The type and structure of individual results varies based on `rrtype`: | `'PTR'` | pointer records | {string} | [`dns.resolvePtr()`][] | | `'SOA'` | start of authority records | {Object} | [`dns.resolveSoa()`][] | | `'SRV'` | service records | {Object} | [`dns.resolveSrv()`][] | -| `'TXT'` | text records | {string} | [`dns.resolveTxt()`][] | +| `'TXT'` | text records | {string[]} | [`dns.resolveTxt()`][] | | `'ANY'` | any records | {Object} | [`dns.resolveAny()`][] | On error, `err` is an [`Error`][] object, where `err.code` is one of the @@ -479,11 +479,11 @@ added: v0.1.27 - `hostname` {string} - `callback` {Function} - `err` {Error} - - `addresses` {string[]} + - `records` {string[][]} Uses the DNS protocol to resolve text queries (`TXT` records) for the -`hostname`. The `addresses` argument passed to the `callback` function is -is a two-dimensional array of the text records available for `hostname` (e.g., +`hostname`. The `records` argument passed to the `callback` function is a +two-dimensional array of the text records available for `hostname` (e.g., `[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of one record. Depending on the use case, these could be either joined together or treated separately. |