Netcheck NPM | npm.io

netcheck

Will monitor Internet and local network connectivity and inform about their state.

Install

Install the module using NPM:

npm install netcheck --save

Overview

Netcheck will provide methods and events to notify you of changes in network connectivity.

Quick Example

var netcheck = require('netcheck');

// Launch monitors, you only need to invoke this once.
netcheck.init();

netcheck.on('internet', function(isConnected) {
    // handle internet connectivity state change
});

netcheck.on('local', function(isConnected) {
    // handle local conntivity state change
});

netcheck.hasInternet()
    .then(function(isConnected) {
        if (isConnected) {
            // We have internet connectivity
        }
    });

netcheck.hasLocal()
    .then(function(isConnected) {
        if (isConnected) {
            // We have connectivity with the local network
        }
    });

API

Methods

init() Starts the connectivity monitor, you only need to invoke this once.
hasInternet() Returns a bluebird Promise and informs if Internet is accessible.
hasLocal() Returns a bluebird Promise and informs if node server is connected to a local network.
reset() Resets the state of netcheck.
setup(options) Define options for the monitor operation:
- customHostname Type: String Default: null By defining this option you are instructing netcheck to check this hostname for online determination, values can be www.google.com, www.google.com:80.
- monitorInternet Type: Boolean Default: true Enable or disable Internet monitor.
- monitorLocal Type: Boolean Default: true Enable or disable local network monitor.
- intervalInternet Type: Number Default: 60000 Define the monitor interval in milliseconds for Internet check, default is 1min.
- intervalLocal Type: Number Default: 60000 Define the monitor interval in milliseconds for local network check, default is 1min.

You may not trigger the connectivity monitor by not calling the netcheck.init() method, when any of the hasInternet() or hasLocal() methods are called they will perform the tests on the spot.

Events

netcheck extends Node's native EventEmitter and provides the following methods:

on(event, cb)
once(event, cb)
removeListener(event, cb)
removeAllListeners()

Read on for more on their definition and behavior.

Events emitted:

internet Gets emitted whenever a state change has occurred on the Internet connectivity.
- isConnected, Type: Boolean A single argument indicating connectivity.
local Gets emitted whenever a state change has occurred on the Local Network connectivity.
- isConnected, Type: Boolean A single argument indicating connectivity.

Release History

v1.1.0, 19 Apr 2016
- Introduced the customHostname option to ping a specific hostname.
- Added the reset() method.
v1.0.0, 15 Feb 2016
- Fixed problem with is-online dependency 5.1.0 being broken.
- Updated all packages to latest and locked versions.
- Lib is now considered stable and reliable.
v0.0.1, 04 Sep 2015
- Big Bang