Skip to content

Commit d46261c

Browse files
0xSanyamtargos
authored andcommitted
doc: improve readability of dns.md
PR-URL: #43694 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Harshitha K P <[email protected]>
1 parent ca0fbfd commit d46261c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/api/dns.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The resolver instance will send its requests from the specified IP address.
144144
This allows programs to specify outbound interfaces when used on multi-homed
145145
systems.
146146

147-
If a v4 or v6 address is not specified, it is set to the default, and the
147+
If a v4 or v6 address is not specified, it is set to the default and the
148148
operating system will choose a local address automatically.
149149

150150
The resolver will use the v4 local address when making requests to IPv4 DNS
@@ -239,7 +239,7 @@ such as no available file descriptors.
239239

240240
`dns.lookup()` does not necessarily have anything to do with the DNS protocol.
241241
The implementation uses an operating system facility that can associate names
242-
with addresses, and vice versa. This implementation can have subtle but
242+
with addresses and vice versa. This implementation can have subtle but
243243
important consequences on the behavior of any Node.js program. Please take some
244244
time to consult the [Implementation considerations section][] before using
245245
`dns.lookup()`.
@@ -285,7 +285,7 @@ The following flags can be passed as hints to [`dns.lookup()`][].
285285
returned if the current system has at least one IPv4 address configured.
286286
* `dns.V4MAPPED`: If the IPv6 family was specified, but no IPv6 addresses were
287287
found, then return IPv4 mapped IPv6 addresses. It is not supported
288-
on some operating systems (e.g FreeBSD 10.1).
288+
on some operating systems (e.g. FreeBSD 10.1).
289289
* `dns.ALL`: If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as
290290
well as IPv4 mapped IPv6 addresses.
291291

@@ -387,7 +387,7 @@ changes:
387387

388388
* `hostname` {string} Host name to resolve.
389389
* `options` {Object}
390-
* `ttl` {boolean} Retrieve the Time-To-Live value (TTL) of each record.
390+
* `ttl` {boolean} Retrieves the Time-To-Live value (TTL) of each record.
391391
When `true`, the callback receives an array of
392392
`{ address: '1.2.3.4', ttl: 60 }` objects rather than an array of strings,
393393
with the TTL expressed in seconds.
@@ -426,7 +426,7 @@ changes:
426426
* `err` {Error}
427427
* `addresses` {string\[] | Object\[]}
428428

429-
Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
429+
Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the
430430
`hostname`. The `addresses` argument passed to the `callback` function
431431
will contain an array of IPv6 addresses.
432432

@@ -575,7 +575,7 @@ changes:
575575
* `err` {Error}
576576
* `addresses` {Object\[]}
577577

578-
Uses the DNS protocol to resolve regular expression based records (`NAPTR`
578+
Uses the DNS protocol to resolve regular expression-based records (`NAPTR`
579579
records) for the `hostname`. The `addresses` argument passed to the `callback`
580580
function will contain an array of objects with the following properties:
581581

@@ -901,7 +901,7 @@ added:
901901
-->
902902

903903
Cancel all outstanding DNS queries made by this resolver. The corresponding
904-
promises will be rejected with an error with code `ECANCELLED`.
904+
promises will be rejected with an error with the code `ECANCELLED`.
905905

906906
### `dnsPromises.getServers()`
907907

@@ -965,7 +965,7 @@ such as no available file descriptors.
965965

966966
[`dnsPromises.lookup()`][] does not necessarily have anything to do with the DNS
967967
protocol. The implementation uses an operating system facility that can
968-
associate names with addresses, and vice versa. This implementation can have
968+
associate names with addresses and vice versa. This implementation can have
969969
subtle but important consequences on the behavior of any Node.js program. Please
970970
take some time to consult the [Implementation considerations section][] before
971971
using `dnsPromises.lookup()`.
@@ -1182,7 +1182,7 @@ added: v10.6.0
11821182

11831183
* `hostname` {string}
11841184

1185-
Uses the DNS protocol to resolve regular expression based records (`NAPTR`
1185+
Uses the DNS protocol to resolve regular expression-based records (`NAPTR`
11861186
records) for the `hostname`. On success, the `Promise` is resolved with an array
11871187
of objects with the following properties:
11881188

@@ -1380,11 +1380,11 @@ earlier ones time out or result in some other error.
13801380

13811381
Each DNS query can return one of the following error codes:
13821382

1383-
* `dns.NODATA`: DNS server returned answer with no data.
1383+
* `dns.NODATA`: DNS server returned an answer with no data.
13841384
* `dns.FORMERR`: DNS server claims query was misformatted.
13851385
* `dns.SERVFAIL`: DNS server returned general failure.
13861386
* `dns.NOTFOUND`: Domain name not found.
1387-
* `dns.NOTIMP`: DNS server does not implement requested operation.
1387+
* `dns.NOTIMP`: DNS server does not implement the requested operation.
13881388
* `dns.REFUSED`: DNS server refused query.
13891389
* `dns.BADQUERY`: Misformatted DNS query.
13901390
* `dns.BADNAME`: Misformatted host name.
@@ -1405,7 +1405,7 @@ Each DNS query can return one of the following error codes:
14051405
* `dns.ADDRGETNETWORKPARAMS`: Could not find `GetNetworkParams` function.
14061406
* `dns.CANCELLED`: DNS query cancelled.
14071407

1408-
The above error codes are also exported by the `dnsPromises` API, e.g., `dnsPromises.NODATA`.
1408+
The `dnsPromises` API also exports the above error codes, e.g., `dnsPromises.NODATA`.
14091409

14101410
## Implementation considerations
14111411

@@ -1441,7 +1441,7 @@ allow the default resolver, `dns.lookup()`, to be replaced.
14411441

14421442
These functions are implemented quite differently than [`dns.lookup()`][]. They
14431443
do not use getaddrinfo(3) and they _always_ perform a DNS query on the
1444-
network. This network communication is always done asynchronously, and does not
1444+
network. This network communication is always done asynchronously and does not
14451445
use libuv's threadpool.
14461446

14471447
As a result, these functions cannot have the same negative impact on other

0 commit comments

Comments
 (0)