Skip to content

Commit

Permalink
doc: update to match changed --dns-result-order default
Browse files Browse the repository at this point in the history
Update documentation to match the changed `--dns-result-order` default
value in Node.js 17.0.0.

PR-URL: #46148
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
tikotzky authored and RafaelGSS committed Jan 20, 2023
1 parent 5cf5956 commit 2d32835
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions doc/api/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,10 @@ one of the [DNS error codes][].
added:
- v16.4.0
- v14.18.0
changes:
- version: v17.0.0
pr-url: https://github.com/nodejs/node/pull/39987
description: Changed default value to `verbatim`.
-->

* `order` {string} must be `'ipv4first'` or `'verbatim'`.
Expand All @@ -783,7 +787,7 @@ Set the default value of `verbatim` in [`dns.lookup()`][] and
* `ipv4first`: sets default `verbatim` `false`.
* `verbatim`: sets default `verbatim` `true`.

The default is `ipv4first` and [`dns.setDefaultResultOrder()`][] have higher
The default is `verbatim` and [`dns.setDefaultResultOrder()`][] have higher
priority than [`--dns-result-order`][]. When using [worker threads][],
[`dns.setDefaultResultOrder()`][] from the main thread won't affect the default
dns orders in workers.
Expand Down Expand Up @@ -1328,6 +1332,10 @@ is one of the [DNS error codes][].
added:
- v16.4.0
- v14.18.0
changes:
- version: v17.0.0
pr-url: https://github.com/nodejs/node/pull/39987
description: Changed default value to `verbatim`.
-->

* `order` {string} must be `'ipv4first'` or `'verbatim'`.
Expand All @@ -1338,7 +1346,7 @@ Set the default value of `verbatim` in [`dns.lookup()`][] and
* `ipv4first`: sets default `verbatim` `false`.
* `verbatim`: sets default `verbatim` `true`.

The default is `ipv4first` and [`dnsPromises.setDefaultResultOrder()`][] have
The default is `verbatim` and [`dnsPromises.setDefaultResultOrder()`][] have
higher priority than [`--dns-result-order`][]. When using [worker threads][],
[`dnsPromises.setDefaultResultOrder()`][] from the main thread won't affect the
default dns orders in workers.
Expand Down

0 comments on commit 2d32835

Please sign in to comment.