43
GitHub - sindresorhus/is-online: Check if the internet connection is up
source link: https://github.com/sindresorhus/is-online
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
readme.md
is-online 
Check if the internet connection is up
Works in Node.js and the browser (with a bundler).
In the browser you have 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-online
Usage
const isOnline = require('is-online'); (async () => { console.log(await isOnline()); //=> true })();
API
isOnline([options])
options
Type: Object
timeout
Type: number
Default: 5000
Milliseconds to wait for a server to respond.
version
Type: string
Values: v4 v6
Default: v4
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 via HTTPS
- Query
myip.opendns.comon 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.
Maintainers
Related
- is-online-cli - CLI for this module
- is-reachable - Check if servers are reachable
License
MIT © Sindre Sorhus
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK