Browse Source

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>
canary-base
Tobias Nießen 7 years ago
parent
commit
3888a576ac
No known key found for this signature in database GPG Key ID: 718207F8FD156B70
  1. 8
      doc/api/dns.md

8
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()`][] | | `'PTR'` | pointer records | {string} | [`dns.resolvePtr()`][] |
| `'SOA'` | start of authority records | {Object} | [`dns.resolveSoa()`][] | | `'SOA'` | start of authority records | {Object} | [`dns.resolveSoa()`][] |
| `'SRV'` | service records | {Object} | [`dns.resolveSrv()`][] | | `'SRV'` | service records | {Object} | [`dns.resolveSrv()`][] |
| `'TXT'` | text records | {string} | [`dns.resolveTxt()`][] | | `'TXT'` | text records | {string[]} | [`dns.resolveTxt()`][] |
| `'ANY'` | any records | {Object} | [`dns.resolveAny()`][] | | `'ANY'` | any records | {Object} | [`dns.resolveAny()`][] |
On error, `err` is an [`Error`][] object, where `err.code` is one of the On error, `err` is an [`Error`][] object, where `err.code` is one of the
@ -479,11 +479,11 @@ added: v0.1.27
- `hostname` {string} - `hostname` {string}
- `callback` {Function} - `callback` {Function}
- `err` {Error} - `err` {Error}
- `addresses` {string[]} - `records` {string[][]}
Uses the DNS protocol to resolve text queries (`TXT` records) for the Uses the DNS protocol to resolve text queries (`TXT` records) for the
`hostname`. The `addresses` argument passed to the `callback` function is `hostname`. The `records` argument passed to the `callback` function is a
is a two-dimensional array of the text records available for `hostname` (e.g., 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 `[ ['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 one record. Depending on the use case, these could be either joined together or
treated separately. treated separately.

Loading…
Cancel
Save