From 7813af7f16a61e975d601548dcdffd2f5e1c41ff Mon Sep 17 00:00:00 2001 From: Doug Wade Date: Wed, 4 May 2016 17:45:04 -0700 Subject: [PATCH] doc: Add resolveNaptr and naptr rrtype docs Updates the dns module documentation to include documentation on the resolveNaptr method, and also adds the option NAPTR to the list of valid values for rrtype in dns.resolve(hostname[, rrtype], callback). PR-URL: https://github.com/nodejs/node/pull/6586 Fixes: https://github.com/nodejs/node/issues/6507 Reviewed-By: Anna Henningsen Reviewed-By: James M Snell Reviewed-By: Roman Reiss --- doc/api/dns.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/api/dns.md b/doc/api/dns.md index ee520380aa..3a1535359a 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -155,6 +155,7 @@ Valid values for `rrtype` are: * `'NS'` - name server records * `'CNAME'` - canonical name records * `'SOA'` - start of authority record + * `'NAPTR'` - name authority pointer record The `callback` function has arguments `(err, addresses)`. When successful, `addresses` will be an array. The type of each item in `addresses` is @@ -191,6 +192,33 @@ Uses the DNS protocol to resolve mail exchange records (`MX` records) for the contain an array of objects containing both a `priority` and `exchange` property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`). +## dns.resolveNaptr(hostname, callback) + +Uses the DNS protocol to resolve regular expression based records (`NAPTR` +records) for the `hostname`. The `callback` function has arguments +`(err, addresses)`. The `addresses` argument passed to the `callback` function +will contain an array of objects with the following properties: + +* `flags` +* `service` +* `regexp` +* `replacement` +* `order` +* `preference` + +For example: + +```js +{ + flags: 's', + service: 'SIP+D2U', + regexp: '', + replacement: '_sip._udp.example.com', + order: 30, + preference: 100 +} +``` + ## dns.resolveNs(hostname, callback) Uses the DNS protocol to resolve name server records (`NS` records) for the