external-ip - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "external-ip",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A node.js library to get your external ip from multiple services",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,16 +0,14 @@
-#external-ip [![Build Status](https://travis-ci.org/J-Chaniotis/external-ip.svg?branch=master)](https://travis-ci.org/J-Chaniotis/external-ip) [![Dependency Status](https://david-dm.org/j-Chaniotis/external-ip.svg)](https://david-dm.org/j-Chaniotis/external-ip)
+# external-ip 
+[![Build Status](https://travis-ci.org/J-Chaniotis/external-ip.svg?branch=master)](https://travis-ci.org/J-Chaniotis/external-ip) 
+[![Dependency Status](https://david-dm.org/j-Chaniotis/external-ip.svg)](https://david-dm.org/j-Chaniotis/external-ip)
 
 ![XKCD 865](http://imgs.xkcd.com/comics/nanobots.png)
 
-
-
 `external-ip` is a node.js library to get your external ip from multiple services. 
 
+## Installation
 
-
-##Installation
-
 `npm install external-ip`
 
-##Usage
+## Usage
 
@@ -22,5 +20,5 @@ basic
 
-var getIP = require('external-ip')();
+const getIP = require('external-ip')();
 
-getIP(function (err, ip) {
+getIP((err, ip) => {
     if (err) {
@@ -40,12 +38,13 @@ // every service in the list has failed
 
-var extIP = require('external-ip');
+const extIP = require('external-ip');
 
-var getIP = extIP({
+let getIP = extIP({
     replace: true,
     services: ['http://ifconfig.co/x-real-ip', 'http://ifconfig.io/ip'],
     timeout: 600,
-    getIP: 'parallel'
+    getIP: 'parallel',
+    userAgent: 'Chrome 15.0.874 / Mac OS X 10.8.1'
 });
 
-getIP(function (err, ip) {
+getIP((err, ip) => {
     if (err) {
@@ -58,12 +57,18 @@ throw err;
 ```
-##extIP([config])
-external-ip exposes a constructor function that accepts a configuration object with the following optional properties:
+## Configuration
+
+### extIP([config])
+
+`require('external-ip')` returns a constructor function that accepts an optional configuration object.
+ It can be used to create multiple instances with different configuration if necessary
+
 * **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'`
+* **getIP:** `'sequential'` Makes a request to the first url in the list, if that fails sends to the next and so on. `'parallel'` Makes requests to all the sites in the list, on the first valid response all the pending requests are canceled. default: `'sequential'`
+* **userAgent:** `String` Set a custom `User-Agent` header, default: `curl/`
 
-Returns the configured getIP function.
+Returns the configured getIP instance.
 
-##getIP(callback)
+### getIP(callback)
 The callback gets 2 arguments:
@@ -73,3 +78,3 @@ 1. error: if every service in the list fails to return a valid ip
 
-##CLI
+## CLI
 install as a global package with `npm install -g external-ip`.
@@ -109,8 +114,8 @@ ```
 ```
-##Test
+## Test
 Change your working directory to the project's root, `npm install` to get the development dependencies and then run `npm test`
 
-##Links
+## Links
 * [moira](https://www.npmjs.org/package/moira)
 * [externalip](https://www.npmjs.org/package/externalip)
-* [extip](https://www.npmjs.org/package/extip)
+* [extip](https://www.npmjs.org/package/extip)

test/TODO.md

@@ -1,6 +0,6 @@
-request user agent at config
 more tests
 test coverage badge
-update docs
 npm version badge 
+update examples
+eliminate nasty IFs
 

No alert changes

Improved metrics

Total package byte prevSize

21671

increased by1.01%

Number of lines in readme file

117

increased by5.41%

No dependency changes