# netcheck

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

Latest version **1.1.0** (published 2016-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install netcheck
pnpm add netcheck
yarn add netcheck
bun add netcheck
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-04-19 |
| First published | 2015-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+10 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Thanasis Polychronakis |
| Maintainers | thanpolas |

## Links

- npm: https://www.npmjs.com/package/netcheck
- Repository: https://github.com/INSIGHTReplay/netcheck
- Issues: https://github.com/INSIGHTReplay/netcheck/issues
- npm.io page: https://npm.io/package/netcheck

## Dependencies (6)

- [cip](https://npm.io/package/cip.md) 1.0.0
- [lodash](https://npm.io/package/lodash.md) 4.11.1
- [network](https://npm.io/package/network.md) 0.1.3
- [bluebird](https://npm.io/package/bluebird.md) 3.3.5
- [is-online](https://npm.io/package/is-online.md) 5.1.1
- [is-reachable](https://npm.io/package/is-reachable.md) ^1.3.0

## Recent versions

- 1.1.0 (latest) — 2016-04-19
- 1.0.0 — 2016-02-15
- 0.0.1 — 2015-09-04

## README

# netcheck

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

[![Build Status](https://circleci.com/gh/INSIGHTReplay/netcheck.png?circle-token=9328f7b12294ef23a8772ff9e43f10fd899f9735)](https://circleci.com/gh/INSIGHTReplay/netcheck)


## Install

Install the module using NPM:

```
npm install netcheck --save
```

## <a name='TOC'>Table of Contents</a>

1. [Overview](#overview)
1. [API](#api)

## Overview

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

### Quick Example

```js
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][Bluebird] Promise and informs if Internet is accessible.
* `hasLocal()` Returns a [bluebird][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](https://nodejs.org/api/events.html).

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

## Contributors

* [Thanasis Polychronakis](https://github.com/thanpolas)

## License

Copyright ©2016 Insight Replay, Inc. Licensed under the MIT license.

[Bluebird]: https://github.com/petkaantonov/bluebird

---
_Source: https://npm.io/package/netcheck · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._