Skip to content
Browse files

Fix the documentation of dns error handling.

These are actually passed as Error objects, not separate "code" and "message"
parameters.
1 parent c4397b8 commit bd4f56c8239aca12b6f7c2016bda51507ba7aec7 @mbrubeck committed Jan 13, 2010
Showing with 10 additions and 8 deletions.
  1. +10 −8 doc/api.txt
View
18 doc/api.txt
@@ -1410,14 +1410,14 @@ resolution.addCallback(function (addresses, ttl, cname) {
reversing.addCallback( function (domains, ttl, cname) {
puts("reverse for " + a + ": " + JSON.stringify(domains));
});
- reversing.addErrback( function (code, msg) {
- puts("reverse for " + a + " failed: " + msg);
+ reversing.addErrback( function (e) {
+ puts("reverse for " + a + " failed: " + e.message);
});
}
});
-resolution.addErrback(function (code, msg) {
- puts("error: " + msg);
+resolution.addErrback(function (e) {
+ puts("error: " + e.message);
});
-------------------------------------------------------------------------
@@ -1430,8 +1430,9 @@ This function returns a promise.
- on success: returns +addresses, ttl, cname+. +ttl+ (time-to-live) is an integer
specifying the number of seconds this result is valid for. +cname+ is the
canonical name for the query.
-- on error: returns +code, msg+. +code+ is one of the error codes listed
- below and +msg+ is a string describing the error in English.
+- on error: Returns an instanceof Error object, where the "errno" field is one
+ of the error codes listed below and the "message" field is a string
+ describing the error in English.
+dns.resolve6(domain)+::
@@ -1444,8 +1445,9 @@ Reverse resolves an ip address to an array of domain names.
- on success: returns +domains, ttl, cname+. +ttl+ (time-to-live) is an integer
specifying the number of seconds this result is valid for. +cname+ is the
canonical name for the query. +domains+ is an array of domains.
-- on error: returns +code, msg+. +code+ is one of the error codes listed
- below and +msg+ is a string describing the error in English.
+- on error: Returns an instanceof Error object, where the "errno" field is one
+ of the error codes listed below and the "message" field is a string
+ describing the error in English.
Each DNS query can return an error code.

0 comments on commit bd4f56c

Please sign in to comment.
Something went wrong with that request. Please try again.