lib: add navigator.onLine

Author: Uzlopak

doc/api/globals.md

@@ -629,6 +629,31 @@ logical processors available to the current Node.js instance.
 console.log(`This process is running on ${navigator.hardwareConcurrency}`);
 ```
 
+### `navigator.onLine`
+
+<!-- YAML
+added: v21.0.0
+-->
+
+* {boolean}
+
+The `navigator.onLine` read-only property returns the online status available
+of the current Node.js instance. If the Node.js instance is not able to detect
+to a local area network (LAN) or a router, it is offline; all other conditions
+return true. So while you can assume that the Node.js instance is offline when
+it returns a false value, you cannot assume that a true value necessarily
+means that the Node.js instance can access the internet. You could be getting
+false positives, such as in cases where the computer is running a
+virtualization software that has virtual ethernet adapters that are always
+"connected."
+
+Therefore, if you really want to determine the online status of the Node.js
+instance, you should develop additional means for checking.
+
+```js
+console.log(`This process is ${navigator.onLine ? 'online' : 'offline'}`);
+```
+
 ## `PerformanceEntry`
 
 <!-- YAML

lib/internal/navigator.js

@@ -15,6 +15,7 @@ const {
 
 const {
   getAvailableParallelism,
+  getOnLineStatus,
 } = internalBinding('os');
 
 const kInitialize = Symbol('kInitialize');
@@ -37,10 +38,18 @@ class Navigator {
     this.#availableParallelism ??= getAvailableParallelism();
     return this.#availableParallelism;
   }
+
+  /**
+   * @return {boolean}
+   */
+  get onLine() {
+    return getOnLineStatus();
+  }
 }
 
 ObjectDefineProperties(Navigator.prototype, {
   hardwareConcurrency: kEnumerableProperty,
+  onLine: kEnumerableProperty,
 });
 
 module.exports = {

src/node_os.cc

@@ -248,6 +248,33 @@ static void GetInterfaceAddresses(const FunctionCallbackInfo<Value>& args) {
 }
 
 
+static void GetOnLineStatus(const FunctionCallbackInfo<Value>& args) {
+  Environment* env = Environment::GetCurrent(args);
+  uv_interface_address_t* interfaces;
+  int count, i;
+
+  int err = uv_interface_addresses(&interfaces, &count);
+
+  if (err == UV_ENOSYS) return args.GetReturnValue().Set(false);
+
+  if (err) {
+    CHECK_GE(args.Length(), 1);
+    env->CollectUVExceptionInfo(
+        args[args.Length() - 1], errno, "uv_interface_addresses");
+    return args.GetReturnValue().Set(false);
+  }
+
+  for (i = 0; i < count; i++) {
+    if (interfaces[i].is_internal == false) {
+      return args.GetReturnValue().Set(true);
+    }
+  }
+
+  uv_free_interface_addresses(interfaces, count);
+  return args.GetReturnValue().Set(false);
+}
+
+
 static void GetHomeDirectory(const FunctionCallbackInfo<Value>& args) {
   Environment* env = Environment::GetCurrent(args);
   char buf[PATH_MAX];
@@ -403,6 +430,7 @@ void Initialize(Local<Object> target,
   SetMethod(context, target, "getPriority", GetPriority);
   SetMethod(
       context, target, "getAvailableParallelism", GetAvailableParallelism);
+  SetMethod(context, target, "getOnLineStatus", GetOnLineStatus);
   SetMethod(context, target, "getOSInformation", GetOSInformation);
   target
       ->Set(context,
@@ -419,6 +447,7 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
   registry->Register(GetFreeMemory);
   registry->Register(GetCPUInfo);
   registry->Register(GetInterfaceAddresses);
+  registry->Register(GetOnLineStatus);
   registry->Register(GetHomeDirectory);
   registry->Register(GetUserInfo);
   registry->Register(SetPriority);

test/parallel/test-navigator.js

@@ -13,3 +13,5 @@ const is = {
 is.number(+navigator.hardwareConcurrency, 'hardwareConcurrency');
 is.number(navigator.hardwareConcurrency, 'hardwareConcurrency');
 assert.ok(navigator.hardwareConcurrency > 0);
+
+assert.strictEqual(typeof navigator.onLine, 'boolean');

typings/internalBinding/os.d.ts

@@ -9,7 +9,8 @@ export interface OSBinding {
   getTotalMem(): number;
   getFreeMem(): number;
   getCPUs(): Array<string | number>;
-  getInterfaceAddresses(ctx: InternalOSBinding.OSContext): Array<string | number | boolean> | undefined;
+  getInterfaceAddresses(ctx: InternalOSBinding.OSContext): boolean;
+  getOnLineStatus(ctx: InternalOSBinding.OSContext): Array<string | number | boolean> | undefined;
   getHomeDirectory(ctx: InternalOSBinding.OSContext): string | undefined;
   getUserInfo(options: { encoding?: string } | undefined, ctx: InternalOSBinding.OSContext): {
     uid: number;