external-ip - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

examples/basic.js

 'use strict';
 
-var getIP = require('../index')();
+const getIP = require('../index')();
 
-getIP(function (err, ip) {
+getIP((err, ip) => {
     if (err) {
@@ -10,2 +10,2 @@ throw err;
     console.log(ip);
-});
+});

examples/customConfig.js

 'use strict';
 
-var extIP = require('../index');
+const extIP = require('../index');
 
-var getIP = extIP({
+const getIP = extIP({
     replace: true, // true: replace the default services list, false: extend it, default: false
-    services: ['http://ifconfig.co/x-real-ip', 'http://ifconfig.io/ip'],
+    services: ['http://icanhazip.com/', 'http://ident.me/'],
     timeout: 600, // set timeout per request, default: 500ms
-    'getIP': 'parallel'
+    getIP: 'parallel'
 });
 
-getIP(function (err, ip) {
+getIP((err, ip) => {
     if (err) {
@@ -17,2 +17,2 @@ throw err;
     console.log(ip);
-});
+});

package.json

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

README.md

@@ -31,3 +31,2 @@ # external-ip
 ```
-
 with configuration
@@ -56,2 +55,42 @@
 ```
+### Promises
+The API of this library is designed around the classic node.js error-first callback. 
+As of node.js V8, converting this type of callback into a promise is pretty straight forward and
+requires one more line of code.
+
+basic
+```javascript
+'use strict';
+
+const {promisify} = require('util'); //<-- Require promisify
+const getIP = promisify(require('external-ip')()); // <-- And then wrap the library
+
+getIP().then((ip)=> {
+    console.log(ip);
+}).catch((error) => {
+    console.error(error);
+});
+
+```
+with configuration
+
+```javascript
+'use strict';
+const { promisify } = require('util'); //<-- Require promisify
+const getIP = promisify(require('external-ip')({
+    replace: true,
+    services: ['http://icanhazip.com/', 'http://ident.me/'],
+    timeout: 600,
+    getIP: 'parallel',
+    verbose: true
+})); // <-- And then wrap the library
+
+getIP().then((ip) => {
+    console.log(ip);
+}).catch((error) => {
+    console.error(error);
+});
+```
+If you believe this extra step shouldn be there, feel free to open an issue and/or a pull request
+
 ## Configuration
@@ -58,0 +97,0 @@

test/TODO.md

@@ -6,4 +6,3 @@ more tests
 eliminate nasty IFs
-verbose mode
 
 

No alert changes

Improved metrics

Total package byte prevSize

24385

increased by7.33%

Number of package files

19

increased by11.76%

Lines of code

461

increased by4.3%

Number of lines in readme file

158

increased by32.77%

No dependency changes