Skip to content

doc: dns.resolve wrong callback addresses argument description #6506

Closed
Closed
doc: dns.resolve wrong callback addresses argument description#6506
Labels
dnsIssues and PRs related to the dns subsystem.docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

Description

@MrQubo
MrQubo
opened on May 1, 2016

The dns.resolve(hostname[, rrtype], callback) description says:

The callback function has arguments (err, addresses). When successful, addresses will be an array.

But it's not true for SOA record.

dns.resolve documentation:
https://nodejs.org/docs/latest-v6.x/api/dns.html#dns_dns_resolve_hostname_rrtype_callback

Activity

  1. addaleax
    added
    docIssues and PRs related to Node.js documentation.
    dnsIssues and PRs related to the dns subsystem.
    on May 1, 2016

  2. silverwind commented on May 2, 2016

    @silverwind
    silverwind
    on May 2, 2016
    Contributor

    SOA returns objects. Should be an easy doc addition.

  3. silverwind
    added
    good first issueIssues that are suitable for first-time contributors.
    on May 2, 2016
  4. JungMinu
    self-assigned this
    on May 3, 2016

  5. tarungarg546 commented on Jun 27, 2016

    @tarungarg546
    tarungarg546
    on Jun 27, 2016
    Contributor

    Any update. What exactly needs to be done.

  6. Fishrock123
    unassigned
    JungMinu
    on Jul 2, 2016

  7. qheaden commented on Jul 4, 2016

    @qheaden
    qheaden
    on Jul 4, 2016
    Contributor

    I would like to work on this one. Feel free to make me an assignee on this so others will know I am working on it. I will update the DNS module docs.

  8. qheaden commented on Jul 4, 2016

    @qheaden
    qheaden
    on Jul 4, 2016
    Contributor

    I see that the dns.resolveSoa() method documents the object correctly. Should that information be copied to the dns.resolve() documentation, or should it just point users to dns.resolveSoa() to explain the SOA record object?

  9. silverwind commented on Jul 4, 2016

    @silverwind
    silverwind
    on Jul 4, 2016
    Contributor

    Should that information be copied to the dns.resolve() documentation, or should it just point users to dns.resolveSoa() to explain the SOA record object?

    No need to duplicate that information, just point (link) to it.

  10. addaleax
    closed this as completedin fcae5e2on Jul 11, 2016
  11. evanlucas
    added a commit that references this issue on Jul 15, 2016

    doc: dns.resolve fix callback argument description

    a81ff70
  12. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: dns.resolve fix callback argument description

    fcae5e2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    dnsIssues and PRs related to the dns subsystem.docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions