systeminformation 5.10.7 → 5.11.0

package/README.md

@@ -101,6 +101,7 @@ si.cpu()
 
 (last 7 major and minor version releases)
 
+- Version 5.11.0: `networkInterfaces()` added default property and default parameter
 - Version 5.10.0: basic `android` support
 - Version 5.9.0: `graphics()` added properties (macOS)
 - Version 5.8.0: `disksIO()` added waitTime, waitPercent (linux)
@@ -539,9 +540,10 @@ Full function reference with examples can be found at [https://systeminformation
 
 | Function        | Result object | Linux | BSD | Mac | Win | Sun | Comments |
 | --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
-| si.networkInterfaces(cb) | [{...}] | X | X | X | X | X | array of network interfaces |
+| si.networkInterfaces(cb) | [{...}] | X | X | X | X | X | array of network interfaces<br>With the 'default' parameter it returns<br>only the default interface |
 | | [0].iface | X | X | X | X | X | interface |
 | | [0].ifaceName | X | X | X | X | X | interface name (differs on Windows) |
+| | [0].default | X | X | X | X | X | true if this is the default interface |
 | | [0].ip4 | X | X | X | X | X | ip4 address |
 | | [0].ip4subnet | X | X | X | X | X | ip4 subnet mask |
 | | [0].ip6 | X | X | X | X | X | ip6 address |

package/lib/network.js

@@ -692,17 +692,29 @@ function testVirtualNic(iface, ifaceName, mac) {
   } else { return false; }
 }
 
-function networkInterfaces(callback, rescan) {
+function networkInterfaces(callback, rescan, defaultString) {
+
+  if (typeof callback === 'string') {
+    defaultString = callback;
+    rescan = true;
+    callback = null;
+  }
 
   if (typeof callback === 'boolean') {
     rescan = callback;
     callback = null;
+    defaultString = '';
   }
   if (typeof rescan === 'undefined') {
     rescan = true;
   }
+  defaultString = defaultString || '';
+  defaultString = '' + defaultString;
+
   return new Promise((resolve) => {
     process.nextTick(() => {
+      const defaultInterface = getDefaultNetworkInterface();
+
       let ifaces = os.networkInterfaces();
 
       let result = [];
@@ -730,6 +742,7 @@ function networkInterfaces(callback, rescan) {
           result.push({
             iface: nic.iface,
             ifaceName: nic.iface,
+            default: nic.iface === defaultInterface,
             ip4: nic.ip4,
             ip4subnet: nic.ip4subnet || '',
             ip6: nic.ip6,
@@ -750,6 +763,14 @@ function networkInterfaces(callback, rescan) {
           });
         });
         _networkInterfaces = result;
+        if (defaultString.toLowerCase().indexOf('default') >= 0) {
+          result = result.filter(item => item.default);
+          if (result.length > 0) {
+            result = result[0];
+          } else {
+            result = [];
+          }
+        }
         if (callback) { callback(result); }
         resolve(result);
       }
@@ -863,6 +884,7 @@ function networkInterfaces(callback, rescan) {
               result.push({
                 iface,
                 ifaceName,
+                default: iface === defaultInterface,
                 ip4,
                 ip4subnet,
                 ip6,
@@ -884,6 +906,14 @@ function networkInterfaces(callback, rescan) {
             }
           }
           _networkInterfaces = result;
+          if (defaultString.toLowerCase().indexOf('default') >= 0) {
+            result = result.filter(item => item.default);
+            if (result.length > 0) {
+              result = result[0];
+            } else {
+              result = [];
+            }
+          }
           if (callback) { callback(result); }
           resolve(result);
         }
@@ -990,6 +1020,7 @@ function networkInterfaces(callback, rescan) {
                 result.push({
                   iface,
                   ifaceName,
+                  default: iface === defaultInterface,
                   ip4,
                   ip4subnet,
                   ip6,
@@ -1011,6 +1042,14 @@ function networkInterfaces(callback, rescan) {
               }
             }
             _networkInterfaces = result;
+            if (defaultString.toLowerCase().indexOf('default') >= 0) {
+              result = result.filter(item => item.default);
+              if (result.length > 0) {
+                result = result[0];
+              } else {
+                result = [];
+              }
+            }
             if (callback) { callback(result); }
             resolve(result);
           });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systeminformation",
-  "version": "5.10.7",
+  "version": "5.11.0",
   "description": "Advanced, lightweight system and OS information library",
   "license": "MIT",
   "author": "Sebastian Hildebrandt <hildebrandt@plus-innovations.com> (https://plus-innovations.com)",