From 722118df6cb1dcf839980976c81fc07eea0c86e2 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Mon, 26 Jun 2017 13:36:01 -0700 Subject: [PATCH] external/gcs: docs. --- lib/net/external.js | 15 ++++++--------- lib/net/index.js | 1 + lib/utils/gcs.js | 3 +++ 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/lib/net/external.js b/lib/net/external.js index a39f4a41..29d36e43 100644 --- a/lib/net/external.js +++ b/lib/net/external.js @@ -8,6 +8,11 @@ var request = require('../http/request'); var IP = require('../utils/ip'); + +/** + * @exports net/external + */ + var external = exports; /** @@ -19,9 +24,6 @@ var external = exports; external.getIPv4 = async function getIPv4() { var res, ip; - if (request.unsupported) - throw new Error('Could not find IP.'); - try { res = await request({ method: 'GET', @@ -47,15 +49,13 @@ external.getIPv4 = async function getIPv4() { /** * Attempt to retrieve external IP from dyndns.org. * @method + * @ignore * @returns {Promise} */ external.getIPv42 = async function getIPv42() { var res, match, ip, raw; - if (request.unsupported) - throw new Error('Could not find IP.'); - res = await request({ method: 'GET', uri: 'http://checkip.dyndns.org', @@ -86,9 +86,6 @@ external.getIPv42 = async function getIPv42() { external.getIPv6 = async function getIPv6() { var res, ip; - if (request.unsupported) - throw new Error('Could not find IP.'); - res = await request({ method: 'GET', uri: 'http://ipv6.icanhazip.com', diff --git a/lib/net/index.js b/lib/net/index.js index b8b33975..a89dce7a 100644 --- a/lib/net/index.js +++ b/lib/net/index.js @@ -9,6 +9,7 @@ exports.BIP151 = require('./bip151'); exports.bip152 = require('./bip152'); exports.common = require('./common'); exports.dns = require('./dns'); +exports.external = require('./external'); exports.Framer = require('./framer'); exports.HostList = require('./hostlist'); exports.packets = require('./packets'); diff --git a/lib/utils/gcs.js b/lib/utils/gcs.js index 97eb4a76..cfe1f8a2 100644 --- a/lib/utils/gcs.js +++ b/lib/utils/gcs.js @@ -16,6 +16,7 @@ var EOF = new Int64(-1); /** * GCSFilter + * @alias module:utils.GCSFilter * @constructor */ @@ -348,6 +349,7 @@ GCSFilter.fromExtended = function fromExtended(block) { /** * BitWriter * @constructor + * @ignore */ function BitWriter() { @@ -434,6 +436,7 @@ BitWriter.prototype.render = function render() { /** * BitReader * @constructor + * @ignore */ function BitReader(data) {