Commit 37b9372
doc: fix types and description for dns.resolveTxt
Backport-PR-URL: #16316
PR-URL: #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>1 parent 6e06d0e commit 37b9372
1 file changed
Lines changed: 7 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -193,7 +193,7 @@ records. The type and structure of individual results varies based on `rrtype`: | |||
| 193 | 193 | | `'PTR'` | pointer records | {string} | [`dns.resolvePtr()`][] | | |
| 194 | 194 | | `'SOA'` | start of authority records | {Object} | [`dns.resolveSoa()`][] | | |
| 195 | 195 | | `'SRV'` | service records | {Object} | [`dns.resolveSrv()`][] | | |
| 196 | - | `'TXT'` | text records | {string} | [`dns.resolveTxt()`][] | | ||
| 196 | + | `'TXT'` | text records | {string[]} | [`dns.resolveTxt()`][] | | ||
| 197 | 197 | ||
| 198 | 198 | On error, `err` is an [`Error`][] object, where `err.code` is one of the | |
| 199 | 199 | [DNS error codes](#dns_error_codes). | |
@@ -359,10 +359,14 @@ be an array of strings containing the reply records. | |||
| 359 | 359 | <!-- YAML | |
| 360 | 360 | added: v0.1.27 | |
| 361 | 361 | --> | |
| 362 | + - `hostname` {string} | ||
| 363 | + - `callback` {Function} | ||
| 364 | + - `err` {Error} | ||
| 365 | + - `records` {string[][]} | ||
| 362 | 366 | ||
| 363 | 367 | Uses the DNS protocol to resolve text queries (`TXT` records) for the | |
| 364 | - `hostname`. The `addresses` argument passed to the `callback` function is | ||
| 365 | - is a two-dimensional array of the text records available for `hostname` (e.g., | ||
| 368 | + `hostname`. The `records` argument passed to the `callback` function is a | ||
| 369 | + two-dimensional array of the text records available for `hostname` (e.g., | ||
| 366 | 370 | `[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of | |
| 367 | 371 | one record. Depending on the use case, these could be either joined together or | |
| 368 | 372 | treated separately. | |
0 commit comments