Skip to content

Commit

Permalink
doc: update for 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.

Refs: #39987

PR-URL: #40538
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
richardlau authored and targos committed Oct 23, 2021
1 parent acc22c7 commit 404730a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,10 @@ code from strings throw an exception instead. This does not affect the Node.js
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`.
-->

Set the default value of `verbatim` in [`dns.lookup()`][] and
Expand All @@ -215,7 +219,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`.

### `--enable-fips`
Expand Down
2 changes: 1 addition & 1 deletion doc/api/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ changes:
* `verbatim` {boolean} When `true`, the callback receives IPv4 and IPv6
addresses in the order the DNS resolver returned them. When `false`,
IPv4 addresses are placed before IPv6 addresses.
**Default:** `true` (addresses are reordered). Default value is
**Default:** `true` (addresses are not reordered). Default value is
configurable using [`dns.setDefaultResultOrder()`][] or
[`--dns-result-order`][].
* `callback` {Function}
Expand Down

0 comments on commit 404730a

Please sign in to comment.