{ "source": "dns.markdown", "modules": [ { "textRaw": "DNS", "name": "dns", "desc": "
稳定度: 3 - 稳定
\n

Use require('dns') to access this module. All methods in the dns module\nuse C-Ares except for dns.lookup which uses getaddrinfo(3) in a thread\npool. C-Ares is much faster than getaddrinfo but the system resolver is\nmore constant with how other programs operate. When a user does\nnet.connect(80, 'google.com') or http.get({ host: 'google.com' }) the\ndns.lookup method is used. Users who need to do a large number of lookups\nquickly should use the methods that go through C-Ares.\n\n

\n

使用 require('dns') 引入此模块。dns 模块中的所有方法都使用了 C-Ares，除了 dns.lookup 使用了线程池中的 getaddrinfo(3)。C-Ares 比 getaddrinfo 要快得多，但系统解析器相对于其它程序的操作要更固定。当一个用户使用 net.connect(80, 'google.com') 或 http.get({ host: 'google.com' }) 时会使用 dns.lookup 方法。如果用户需要进行大量的快速查询，则最好使用 C-Ares 提供的方法。\n\n

\n

Here is an example which resolves 'www.google.com' then reverse\nresolves the IP addresses which are returned.\n\n

\n

下面是一个解析 'www.google.com' 并反向解析所返回 IP 地址的例子。\n\n

\n
      console.log('反向解析 ' + a + ': ' + JSON.stringify(domains));\n    });\n  });\n});
\n", "methods": [ { "textRaw": "dns.lookup(domain, [family], callback)", "type": "method", "name": "lookup", "desc": "

Resolves a domain (e.g. 'google.com') into the first found A (IPv4) or\nAAAA (IPv6) record.\nThe family can be the integer 4 or 6. Defaults to null that indicates\nboth Ip v4 and v6 address family.\n\n

\n

将一个域名（比如 'google.com'）解析为第一个找到的 A 记录（IPv4）或 AAAA 记录（IPv6）。地址族 family 可以是数字 4 或 6，缺省为 null 表示同时允许 IPv4 和 IPv6 地址族。\n\n

\n

The callback has arguments (err, address, family). The address argument\nis a string representation of a IP v4 or v6 address. The family argument\nis either the integer 4 or 6 and denotes the family of address (not\nnecessarily the value initially passed to lookup).\n\n

\n

回调参数为 (err, address, family)。地址 address 参数为一个代表 IPv4 或 IPv6 地址的字符串。地址族 family 参数为数字 4 或 6，地表 address 的地址族（不一定是之前传入 lookup 的值）。\n\n

\n

On error, err is an Error object, where err.code is the error code.\nKeep in mind that err.code will be set to 'ENOENT' not only when\nthe domain does not exist but also when the lookup fails in other ways\nsuch as no available file descriptors.\n\n

\n

当错误发生时，err 为一个 Error 对象，其中 err.code 为错误代码。请记住 err.code 被设定为 'ENOENT' 的情况不仅是域名不存在，也可能是查询在其它途径出错，比如没有可用文件描述符时。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "family", "optional": true }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolve(domain, [rrtype], callback)", "type": "method", "name": "resolve", "desc": "

Resolves a domain (e.g. 'google.com') into an array of the record types\nspecified by rrtype. Valid rrtypes are 'A' (IPV4 addresses, default),\n'AAAA' (IPV6 addresses), 'MX' (mail exchange records), 'TXT' (text\nrecords), 'SRV' (SRV records), 'PTR' (used for reverse IP lookups),\n'NS' (name server records) and 'CNAME' (canonical name records).\n\n

\n

将一个域名（比如 'google.com'）解析为一个 rrtype 指定记录类型的数组。有效 rrtypes 取值有 'A'（IPv4 地址，缺省）、'AAAA'（IPv6 地址）、'MX'（邮件交换记录）、'TXT'（文本记录）、'SRV'（SRV 记录）、'PTR'（用于 IP 反向查找）、'NS'（域名服务器记录）和 'CNAME'（别名记录）。\n\n

\n

The callback has arguments (err, addresses). The type of each item\nin addresses is determined by the record type, and described in the\ndocumentation for the corresponding lookup methods below.\n\n

\n

回调参数为 (err, addresses)。其中 addresses 中每一项的类型取决于记录类型，详见下文对应的查找方法。\n\n

\n

On error, err is an Error object, where err.code is\none of the error codes listed below.\n\n

\n

当出错时，err 参数为一个 Error 对象，其中 err.code 为下文所列出的错误代码之一。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "rrtype", "optional": true }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolve4(domain, callback)", "type": "method", "name": "resolve4", "desc": "

The same as dns.resolve(), but only for IPv4 queries (A records).\naddresses is an array of IPv4 addresses (e.g.\n['74.125.79.104', '74.125.79.105', '74.125.79.106']).\n\n

\n

于 dns.resolve() 一样，但只用于查询 IPv4（A 记录）。addresses 是一个 IPv4 地址的数组（比如 ['74.125.79.104', '74.125.79.105', '74.125.79.106']）。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolve6(domain, callback)", "type": "method", "name": "resolve6", "desc": "

The same as dns.resolve4() except for IPv6 queries (an AAAA query).\n\n

\n

类似于 dns.resolve4()，但用于 IPv6（AAAA）查询。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolveMx(domain, callback)", "type": "method", "name": "resolveMx", "desc": "

The same as dns.resolve(), but only for mail exchange queries (MX records).\n\n

\n

类似于 dns.resolve()，但用于邮件交换查询（MX 记录）。\n\n

\n

addresses is an array of MX records, each with a priority and an exchange\nattribute (e.g. [{'priority': 10, 'exchange': 'mx.example.com'},...]).\n\n

\n

addresses 为一个 MX 记录的数组，每一项包含优先级和交换属性（比如 [{'priority': 10, 'exchange': 'mx.example.com'},...]）。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolveTxt(domain, callback)", "type": "method", "name": "resolveTxt", "desc": "

The same as dns.resolve(), but only for text queries (TXT records).\naddresses is an array of the text records available for domain (e.g.,\n['v=spf1 ip4:0.0.0.0 ~all']).\n\n

\n

与 dns.resolve() 相似，但用于文本查询（TXT 记录）。addresses 为 domain 可用文本记录的数组（比如 ['v=spf1 ip4:0.0.0.0 ~all']）。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolveSrv(domain, callback)", "type": "method", "name": "resolveSrv", "desc": "

The same as dns.resolve(), but only for service records (SRV records).\naddresses is an array of the SRV records available for domain. Properties\nof SRV records are priority, weight, port, and name (e.g.,\n[{'priority': 10, {'weight': 5, 'port': 21223, 'name': 'service.example.com'}, ...]).\n\n

\n

查询 SRV 记录，与 dns.resolve() 相似。\naddresses 是域名 domain 可用的 SRV 记录数组，\n每一条记录都包含优先级（priority）、权重（weight）、端口号（port）、服务名称（name）等属性\n(比如： [{'priority': 10, {'weight': 5, 'port': 21223, 'name': 'service.example.com'}, ...])。\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolveNs(domain, callback)", "type": "method", "name": "resolveNs", "desc": "

The same as dns.resolve(), but only for name server records (NS records).\naddresses is an array of the name server records available for domain\n(e.g., ['ns1.example.com', 'ns2.example.com']).\n\n

\n

查询 NS 记录，与 dns.resolve() 相似。\naddresses 是域名 domain 可用的 NS 记录数组，\n(比如： ['ns1.example.com', 'ns2.example.com']).\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.resolveCname(domain, callback)", "type": "method", "name": "resolveCname", "desc": "

The same as dns.resolve(), but only for canonical name records (CNAME\nrecords). addresses is an array of the canonical name records available for\ndomain (e.g., ['bar.example.com']).\n\n

\n

查询 CNAME 记录，与 dns.resolve() 相似。\naddresses 是域名 domain 可用的 CNAME 记录数组，\n(比如： ['bar.example.com']).\n\n

\n", "signatures": [ { "params": [ { "name": "domain" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.reverse(ip, callback)", "type": "method", "name": "reverse", "desc": "

Reverse resolves an ip address to an array of domain names.\n\n

\n

反向解析 IP 地址，返回指向该 IP 地址的域名数组。\n\n

\n

The callback has arguments (err, domains).\n\n

\n

回调函数接收两个参数： (err, domains).\n\n

\n

On error, err is an Error object, where err.code is\none of the error codes listed below.\n\n

\n

当出错时，err 参数为一个 Error 对象，其中 err.code 为下文所列出的错误代码之一。\n\n

\n", "signatures": [ { "params": [ { "name": "ip" }, { "name": "callback" } ] } ] }, { "textRaw": "dns.getServers()", "type": "method", "name": "getServers", "desc": "

Returns an array of IP addresses as strings that are currently being used for\nresolution\n\n

\n

已字符串返回一个当前用于解析的 IP 地址的数组。\n\n

\n", "signatures": [ { "params": [] } ] }, { "textRaw": "dns.setServers(servers)", "type": "method", "name": "setServers", "desc": "

Given an array of IP addresses as strings, set them as the servers to use for\nresolving\n\n

\n

指定一个 IP 地址字符串数组，将它们作为解析所用的服务器。\n\n

\n

If you specify a port with the address it will be stripped, as the underlying\nlibrary doesn't support that.\n\n

\n

如果您在地址中指定了端口，则端口会被忽略，因为底层库并不支持。\n\n

\n

This will throw if you pass invalid input.\n\n

\n

如果您传入无效参数，则会抛出异常。\n\n

\n", "signatures": [ { "params": [ { "name": "servers" } ] } ] } ], "modules": [ { "textRaw": "错误代码", "name": "错误代码", "desc": "

Each DNS query can return one of the following error codes:\n\n

\n

每个 DNS 查询都可能返回下列错误代码之一：\n\n

\n\n", "type": "module", "displayName": "错误代码" } ], "type": "module", "displayName": "DNS" } ] }