is-online
Check if the internet connection is up
Works in Node.js and the browser (with a bundler).
In the browser, there is already navigator.onLine, but it's useless as it only tells you if there's a local connection, and not whether the internet is accessible.
Install
npm install is-onlineUsage
import isOnline from 'is-online';
console.log(await isOnline());
//=> trueAPI
isOnline(options?)
options
Type: object
timeout
Type: number
Default: 5000
Milliseconds to wait for a server to respond.
ipVersion
Type: number
Values: 4 | 6
Default: 4
The 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.
How it works
The following checks are run in parallel:
- Retrieve icanhazip.com (or ipify.org as fallback) via HTTPS.
- Query
myip.opendns.comando-o.myaddr.l.google.comDNS entries. (Node.js only) - Retrieve Apple's Captive Portal test page (this is what iOS does). (Node.js only)
When any check succeeds, the returned Promise is resolved to true.
Proxy support
To make it work through proxies, you need to set up global-agent.
Maintainers
Related
- is-online-cli - CLI for this module
- is-reachable - Check if servers are reachable