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.
Note: The only change in this repo is import os from 'node:os'
changing to import os from 'os'
npm install is-online
import isOnline from 'is-online';
console.log(await isOnline());
//=> true
Type: object
Type: number
Default: 5000
Milliseconds to wait for a server to respond.
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.
The following checks are run in parallel:
- Retrieve icanhazip.com (or ipify.org as fallback) via HTTPS.
- Query
myip.opendns.com
ando-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)
When any check succeeds, the returned Promise is resolved to true
.
To make it work through proxies, you need to set up global-agent
.
- is-online-cli - CLI for this module
- is-reachable - Check if servers are reachable