external-ip
is a node.js library to get your external ip from multiple services.
##Installation
npm install external-ip
##Usage
basic
'use strict';
var getIP = require('external-ip')();
getIP(function (err, ip) {
if (err) {
// every service in the list has failed
throw err;
}
console.log(ip);
});
with configuration
'use strict';
var extIP = require('external-ip');
var getIP = extIP({
replace: true,
services: ['http://ifconfig.co/x-real-ip', 'http://ifconfig.me/ip'],
timeout: 600,
getIP: 'parallel'
});
getIP(function (err, ip) {
if (err) {
throw err;
}
console.log(ip);
});
##extIP([config]) external-ip exposes a constructor function that accepts a configuration object with the following optional properties:
- services:
Array
of urls that return the ip in the html body, required if replace is set to true - replace:
Boolean
if true, replaces the internal array of services with the user defined, if false, extends it, default:false
- timeout: Timeout per request in ms, default
1000
- getIP:
'sequential'
Sends a request to the first url in the list, if that fails sends to the next and so on.'parallel'
Sends requests to all the sites in the list, on the first valid response all the pending requests are canceled. default:'sequential'
Returns the configured getIP function.
##getIP(callback) The callback gets 2 arguments:
- error: if every service in the list fails to return a valid ip
- ip: your external ip
##CLI
install as a global package with npm install -g external-ip
.
$ external-ip -h
Usage: external-ip [options]
Options:
-h, --help output usage information
-R, --replace replace internal services instead of extending them.
-s, --services <url> service url, see examples, required if using -R
-t, --timeout <msec> set timeout per request
-P, --parallel set to parallel mode
This program prints the external IP of the machine.
All arguments are optional.
Examples:
$ external-ip
$ external-ip -P -t 1500 -R -s http://icanhazip.com/ -s http://ifconfig.me/ip
##Test
Change your working directory to the project's root, npm install
to get the development dependencies and then run npm test
##Links