Browse Source

Fix the documentation of dns error handling.

These are actually passed as Error objects, not separate "code" and "message"
parameters.
v0.7.4-release
Matt Brubeck 15 years ago
committed by Ryan Dahl
parent
commit
1737cdc112
  1. 18
      doc/api.txt

18
doc/api.txt

@ -1459,14 +1459,14 @@ resolution.addCallback(function (addresses, ttl, cname) {
reversing.addCallback( function (domains, ttl, cname) { reversing.addCallback( function (domains, ttl, cname) {
sys.puts("reverse for " + a + ": " + JSON.stringify(domains)); sys.puts("reverse for " + a + ": " + JSON.stringify(domains));
}); });
reversing.addErrback( function (code, msg) { reversing.addErrback( function (e) {
sys.puts("reverse for " + a + " failed: " + msg); puts("reverse for " + a + " failed: " + e.message);
}); });
} }
}); });
resolution.addErrback(function (code, msg) { resolution.addErrback(function (e) {
sys.puts("error: " + msg); puts("error: " + e.message);
}); });
------------------------------------------------------------------------- -------------------------------------------------------------------------
@ -1482,8 +1482,9 @@ This function returns a promise.
canonical name for the query. canonical name for the query.
The type of each item in +addresses+ is determined by the record type, and The type of each item in +addresses+ is determined by the record type, and
described in the documentation for the corresponding lookup methods below. described in the documentation for the corresponding lookup methods below.
- on error: returns +code, msg+. +code+ is one of the error codes listed - on error: Returns an instanceof Error object, where the "errno" field is one
below and +msg+ is a string describing the error in English. of the error codes listed below and the "message" field is a string
describing the error in English.
+dns.resolve4(domain)+:: +dns.resolve4(domain)+::
@ -1521,8 +1522,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 - 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 specifying the number of seconds this result is valid for. +cname+ is the
canonical name for the query. +domains+ is an array of domains. canonical name for the query. +domains+ is an array of domains.
- on error: returns +code, msg+. +code+ is one of the error codes listed - on error: Returns an instanceof Error object, where the "errno" field is one
below and +msg+ is a string describing the error in English. 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. Each DNS query can return an error code.

Loading…
Cancel
Save