From be85d5a6eb42514dfecff231c0bf72b993b23c90 Mon Sep 17 00:00:00 2001 From: Mordy Tikotzky Date: Mon, 16 Jan 2023 18:56:07 -0500 Subject: [PATCH] doc: update to match changed `--dns-result-order` default Update documentation to match the changed `--dns-result-order` default value in Node.js 17.0.0. PR-URL: https://github.com/nodejs/node/pull/46148 Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: Matteo Collina Reviewed-By: Paolo Insogna Reviewed-By: Colin Ihrig --- doc/api/dns.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/api/dns.md b/doc/api/dns.md index 5c7a9f16bb1239..59a56c7d1c2aa8 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -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'`. @@ -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. @@ -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'`. @@ -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.