From f5fc412092ede910d60da847a8433032dc634028 Mon Sep 17 00:00:00 2001 From: Shivang Saxena Date: Fri, 22 Jun 2018 13:37:15 -0400 Subject: [PATCH] doc: clarify setServers() methods in dns.md Added a note that that clarifies the fact that setServers() does not check subsequent servers when the first one produces a NOTFOUND error. PR-URL: https://github.com/nodejs/node/pull/21469 Refs: https://github.com/nodejs/node/issues/21391 Reviewed-By: Vse Mozhet Byt Reviewed-By: Trivikram Kamat Reviewed-By: James M Snell --- doc/api/dns.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/api/dns.md b/doc/api/dns.md index 921c097a9a98a8..804c39e3a3c510 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -568,6 +568,13 @@ An error will be thrown if an invalid address is provided. The `dns.setServers()` method must not be called while a DNS query is in progress. +Note that this method works much like +[resolve.conf](http://man7.org/linux/man-pages/man5/resolv.conf.5.html). +That is, if attempting to resolve with the first server provided results in a +`NOTFOUND` error, the `resolve()` method will *not* attempt to resolve with +subsequent servers provided. Fallback DNS servers will only be used if the +earlier ones time out or result in some other error. + ## DNS Promises API > Stability: 1 - Experimental @@ -1010,6 +1017,13 @@ An error will be thrown if an invalid address is provided. The `dnsPromises.setServers()` method must not be called while a DNS query is in progress. +Note that this method works much like +[resolve.conf](http://man7.org/linux/man-pages/man5/resolv.conf.5.html). +That is, if attempting to resolve with the first server provided results in a +`NOTFOUND` error, the `resolve()` method will *not* attempt to resolve with +subsequent servers provided. Fallback DNS servers will only be used if the +earlier ones time out or result in some other error. + ## Error codes Each DNS query can return one of the following error codes: