Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

check-network-status

1.2.3 • Public • Published

Build Status GitHub license Twitter

check-network-status

A Node.js Module to check whether you are connected to network or not. Returns a promise resolves to true with network access and to false without network access.

Install Module

    npm install check-network-status

Note: Requires Node >= 8.0.0

Usage

With Default Options

{
    timeout: 4500,
    backUpURL: null,
    pingDomain: 'google.com',
    method: 'GET'
}
    const { checkNetworkStatus } = require('check-network-status');
    checkNetworkStatus().then(value => console.log(value));
    // prints 'true' or 'false' depending on networking connectivity

With Options

  • timeout: milliseconds
  • url: string with protocol
    const { checkNetworkStatus } = require('check-network-status');
    checkNetworkStatus({
        timeout: 3000,
        backUpURL: 'https://example.com',
        pingDomain: 'github.com',
        method: 'GET'
    }).then(value => console.log(value));
    // prints 'true' or 'false' depending on networking connectivity

ChangeLog

v1.2.0 -> v1.2.3 includes following changes

  • fixes unhandled timeout error
  • stopped printing debug logs

v1.1.3 -> v1.2.0 breaking changes include

Renamed option url to backUpURL

Added option method that accepts HTTP methods to be used while requesting backUpURL. It defaults to GET.

We updated the network check API to cloudflare DNS query API, you need to pass the pingDomain option if you don't want to use default value google.com

Install

npm i check-network-status

DownloadsWeekly Downloads

19

Version

1.2.3

License

MIT

Unpacked Size

6.74 kB

Total Files

4

Last publish

Collaborators

  • avatar