is-online - npm Package Compare versions

Comparing version 8.5.1 to 9.0.0

browser.js

@@ -8,3 +8,3 @@ /* eslint-env browser */
 		timeout: 5000,
-		version: 'v4',
+		ipVersion: 4,
 		...options
@@ -17,4 +17,6 @@ };
 
+	const publicIpFunctionName = options.ipVersion === 4 ? 'v4' : 'v6';
+
 	try {
-		await publicIp[options.version](options);
+		await publicIp[publicIpFunctionName](options);
 		return true;
@@ -27,3 +29,1 @@ } catch (_) {
 module.exports = isOnline;
-// TODO: Remove this for the next major release
-module.exports.default = isOnline;

index.d.ts

@@ -13,37 +13,30 @@ declare namespace isOnline {
 
-		@default 'v4'
+		@default 4
 		*/
-		readonly version?: 'v4' | 'v6';
+		readonly ipVersion?: 4 | 6;
 	}
 }
 
-declare const isOnline: {
-	/**
-	Check if the internet connection is up.
+/**
+Check if the internet connection is up.
 
-	The following checks are run in parallel:
-	- Retrieve [icanhazip.com](https://github.com/major/icanhaz) via HTTPS
-	- Query `myip.opendns.com` on OpenDNS (Node.js only)
-	- Retrieve Apple's Captive Portal test page (Node.js only)
+The following checks are run in parallel:
+- Retrieve [icanhazip.com](https://github.com/major/icanhaz) via HTTPS
+- Query `myip.opendns.com` on OpenDNS (Node.js only)
+- Retrieve Apple's Captive Portal test page (Node.js only)
 
-	When the first check succeeds, the returned Promise is resolved to `true`.
+When the first check succeeds, the returned Promise is resolved to `true`.
 
-	@example
-	```
-	import isOnline = require('is-online');
+@example
+```
+import isOnline = require('is-online');
 
-	(async () => {
-		console.log(await isOnline());
-		//=> true
-	})();
-	```
-	*/
-	(options?: isOnline.Options): Promise<boolean>;
+(async () => {
+	console.log(await isOnline());
+	//=> true
+})();
+```
+*/
+declare function isOnline(options?: isOnline.Options): Promise<boolean>;
 
-	// TODO: Remove this for the next major release, refactor the whole definition to:
-	// declare function isOnline(options?: isOnline.Options): Promise<boolean>;
-	// export = isOnline;
-	default: typeof isOnline;
-};
-
 export = isOnline;

index.js

@@ -14,3 +14,3 @@ 'use strict';
 		timeout: options.timeout,
-		family: options.version === 'v4' ? 4 : 6,
+		dnsLookupIpVersion: options.ipVersion === 6 ? 'ipv6' : 'ipv4',
 		headers: {
@@ -42,3 +42,3 @@ 'user-agent': 'CaptiveNetworkSupport/1.0 wispr'
 		timeout: 5000,
-		version: 'v4',
+		ipVersion: 4,
 		...options
@@ -51,2 +51,8 @@ };
 
+	if (![4, 6].includes(options.ipVersion)) {
+		throw new TypeError('`ipVersion` must be 4 or 6');
+	}
+
+	const publicIpFunctionName = options.ipVersion === 4 ? 'v4' : 'v6';
+
 	const queries = [];
@@ -56,3 +62,3 @@
 		(async () => {
-			const query = publicIp[options.version](options);
+			const query = publicIp[publicIpFunctionName](options);
 			queries.push(query);
@@ -63,3 +69,3 @@ await query;
 		(async () => {
-			const query = publicIp[options.version]({...options, onlyHttps: true});
+			const query = publicIp[publicIpFunctionName]({...options, onlyHttps: true});
 			queries.push(query);
@@ -87,3 +93,1 @@ await query;
 module.exports = isOnline;
-// TODO: Remove this for the next major release
-module.exports.default = isOnline;

package.json

 {
 	"name": "is-online",
-	"version": "8.5.1",
+	"version": "9.0.0",
 	"description": "Check if the internet connection is up",
@@ -17,3 +17,3 @@ "license": "MIT",
 	"engines": {
-		"node": ">=8"
+		"node": ">=10"
 	},
@@ -51,13 +51,18 @@ "scripts": {
 	"dependencies": {
-		"got": "^9.6.0",
-		"p-any": "^2.0.0",
-		"p-timeout": "^3.0.0",
-		"public-ip": "^4.0.1"
+		"got": "^11.8.0",
+		"p-any": "^3.0.0",
+		"p-timeout": "^3.2.0",
+		"public-ip": "^4.0.2"
 	},
 	"devDependencies": {
 		"ava": "^2.4.0",
-		"tsd": "^0.11.0",
-		"xo": "^0.25.3"
+		"tsd": "^0.13.1",
+		"xo": "^0.34.1"
 	},
-	"browser": "browser.js"
+	"browser": "browser.js",
+	"xo": {
+		"rules": {
+			"unicorn/prefer-optional-catch-binding": "off"
+		}
+	}
 }

readme.md

@@ -41,7 +41,7 @@ # is-online [![Build Status](https://travis-ci.com/sindresorhus/is-online.svg?branch=master)](https://travis-ci.com/github/sindresorhus/is-online)
 
-##### version
+##### ipVersion
 
-Type: `string`\
-Values: `'v4'` `'v6'`\
-Default: `'v4'`
+Type: `number`\
+Values: `4 | 6`\
+Default: `4`
 
@@ -54,5 +54,5 @@ Internet Protocol version to use. This is an advanced option that is usually not necessary to be set, but it can prove useful to specifically assert IPv6 connectivity.
 
-- Retrieve [icanhazip.com](https://github.com/major/icanhaz) via HTTPS
-- Query `myip.opendns.com` on OpenDNS *(Node.js only)*
-- Retrieve Apple's Captive Portal test page *(Node.js only)*
+- Retrieve [icanhazip.com](https://github.com/major/icanhaz) (or [ipify.org](https://www.ipify.org) as fallback) via HTTPS.
+- Query `myip.opendns.com` and `o-o.myaddr.l.google.com` DNS entries. *(Node.js only)*
+- Retrieve Apple's Captive Portal test page (this is what iOS does). *(Node.js only)*
 
@@ -59,0 +59,0 @@ When the first check succeeds, the returned Promise is resolved to `true`.

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7476

0.73%

Worsened metrics

Lines of code

126

-3.82%

Dependency changes

• + Added

  @sindresorhus/is@4.6.0
  (transitive)

• + Added

  @szmarczak/http-timer@4.0.6
  (transitive)

• + Added

  @types/cacheable-request@6.0.3
  (transitive)

• + Added

  @types/http-cache-semantics@4.2.0
  (transitive)

• + Added

  @types/keyv@3.1.4
  (transitive)

• + Added

  @types/node@25.4.0
  (transitive)

• + Added

  @types/responselike@1.0.3
  (transitive)

• + Added

  cacheable-lookup@5.0.4
  (transitive)

• + Added

  cacheable-request@7.0.4
  (transitive)

• + Added

  decompress-response@6.0.0
  (transitive)

• + Added

  defer-to-connect@2.0.1
  (transitive)

• + Added

  got@11.8.6
  (transitive)

• + Added

  http2-wrapper@1.0.3
  (transitive)

• + Added

  json-buffer@3.0.1
  (transitive)

• + Added

  keyv@4.5.4
  (transitive)

• + Added

  mimic-response@3.1.0
  (transitive)

• + Added

  normalize-url@6.1.0
  (transitive)

• + Added

  p-any@3.0.0
  (transitive)

• + Added

  p-some@5.0.0
  (transitive)

• + Added

  quick-lru@5.1.1
  (transitive)

• + Added

  resolve-alpn@1.2.1
  (transitive)

• + Added

  responselike@2.0.1
  (transitive)

• + Added

  undici-types@7.18.2
  (transitive)

• - Removed

  p-any@2.1.0
  (transitive)

• - Removed

  p-some@4.1.0
  (transitive)

• - Removed

  type-fest@0.3.1
  (transitive)

• Updated

  got@^11.8.0

• Updated

  p-any@^3.0.0

• Updated

  p-timeout@^3.2.0

• Updated

  public-ip@^4.0.2