external/gcs: docs.

This commit is contained in:
Christopher Jeffrey 2017-06-26 13:36:01 -07:00
parent e02d645c07
commit 722118df6c
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
3 changed files with 10 additions and 9 deletions

View File

@ -8,6 +8,11 @@
var request = require('../http/request'); var request = require('../http/request');
var IP = require('../utils/ip'); var IP = require('../utils/ip');
/**
* @exports net/external
*/
var external = exports; var external = exports;
/** /**
@ -19,9 +24,6 @@ var external = exports;
external.getIPv4 = async function getIPv4() { external.getIPv4 = async function getIPv4() {
var res, ip; var res, ip;
if (request.unsupported)
throw new Error('Could not find IP.');
try { try {
res = await request({ res = await request({
method: 'GET', method: 'GET',
@ -47,15 +49,13 @@ external.getIPv4 = async function getIPv4() {
/** /**
* Attempt to retrieve external IP from dyndns.org. * Attempt to retrieve external IP from dyndns.org.
* @method * @method
* @ignore
* @returns {Promise} * @returns {Promise}
*/ */
external.getIPv42 = async function getIPv42() { external.getIPv42 = async function getIPv42() {
var res, match, ip, raw; var res, match, ip, raw;
if (request.unsupported)
throw new Error('Could not find IP.');
res = await request({ res = await request({
method: 'GET', method: 'GET',
uri: 'http://checkip.dyndns.org', uri: 'http://checkip.dyndns.org',
@ -86,9 +86,6 @@ external.getIPv42 = async function getIPv42() {
external.getIPv6 = async function getIPv6() { external.getIPv6 = async function getIPv6() {
var res, ip; var res, ip;
if (request.unsupported)
throw new Error('Could not find IP.');
res = await request({ res = await request({
method: 'GET', method: 'GET',
uri: 'http://ipv6.icanhazip.com', uri: 'http://ipv6.icanhazip.com',

View File

@ -9,6 +9,7 @@ exports.BIP151 = require('./bip151');
exports.bip152 = require('./bip152'); exports.bip152 = require('./bip152');
exports.common = require('./common'); exports.common = require('./common');
exports.dns = require('./dns'); exports.dns = require('./dns');
exports.external = require('./external');
exports.Framer = require('./framer'); exports.Framer = require('./framer');
exports.HostList = require('./hostlist'); exports.HostList = require('./hostlist');
exports.packets = require('./packets'); exports.packets = require('./packets');

View File

@ -16,6 +16,7 @@ var EOF = new Int64(-1);
/** /**
* GCSFilter * GCSFilter
* @alias module:utils.GCSFilter
* @constructor * @constructor
*/ */
@ -348,6 +349,7 @@ GCSFilter.fromExtended = function fromExtended(block) {
/** /**
* BitWriter * BitWriter
* @constructor * @constructor
* @ignore
*/ */
function BitWriter() { function BitWriter() {
@ -434,6 +436,7 @@ BitWriter.prototype.render = function render() {
/** /**
* BitReader * BitReader
* @constructor * @constructor
* @ignore
*/ */
function BitReader(data) { function BitReader(data) {