Skip to content

doc: clarify setServer method #21469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Shivang44 wants to merge 4 commits into from
Closed

doc: clarify setServer method #21469

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0600ad4
doc: clarify setServer method
Shivang44 Jun 22, 2018
de47fb7
doc: Update dns.md to be under 80 lines
Shivang44 Jun 22, 2018
4088a4d
doc: Update dns.md to expand on setServers
Shivang44 Jun 22, 2018
e586357
doc: Update dns.md to reflect style guide
Shivang44 Jun 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: Update dns.md to be under 80 lines 
Lint was failing because doc was not under 80 lines.
  • Loading branch information
@Shivang44
Shivang44 authored Jun 22, 2018
commit de47fb77d108a874380553a74cc4030c87804dbd
7 changes: 6 additions & 1 deletion doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1010,7 +1010,12 @@ 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 in Linux](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.
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

@vsemozhetbyt vsemozhetbyt Jun 22, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: `resolve` -> `resolve()`?
(see STYLE_GUIDE.md about references to methods format)

@Shivang44 Shivang44 Jun 22, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, did not see that.

subsequent servers provided. Fallback DNS servers will only be used if the
earlier ones time out or result in some other error.

## Error codes

Expand Down