ip-monitor
Advanced tools
Comparing version 0.1.0 to 0.1.1
{ | ||
"name": "ip-monitor", | ||
"version": "0.1.0", | ||
"version": "0.1.1", | ||
"description": "A node.js library to monitor your external ip", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -7,4 +7,5 @@ #ip-monitor [![Build Status](https://travis-ci.org/J-Chaniotis/ip-monitor.svg)](https://travis-ci.org/J-Chaniotis/ip-monitor) [![Dependency Status](https://david-dm.org/j-Chaniotis/ip-monitor.svg)](https://david-dm.org/j-Chaniotis/ip-monitor) | ||
## Installation | ||
`npm install ip-monitor` | ||
using [npm](https://www.npmjs.org/package/ip-monitor): `npm install ip-monitor` | ||
## Usage | ||
@@ -67,10 +68,2 @@ basic | ||
### Events | ||
//todo | ||
* <b>`IP:success` :</b> | ||
* <b>`IP:change`:</b> | ||
* <b>`IP:error`:</b> | ||
### Methods | ||
@@ -80,2 +73,8 @@ * <b>`.start()`:</b> start watching | ||
* <b>`.poll()`:</b> poll for ip manually | ||
* <b>`.isWatching()`:</b> check if ip-monitor has started | ||
* <b>`.isWatching()`:</b> check if ip-monitor has started | ||
### Events | ||
* <b>`IP:success` :</b> fired every time `.poll()` yields an ip | ||
* <b>`IP:error`:</b> fired when `.poll()` encounters an error, usually if the connection is down | ||
* <b>`IP:change`:</b> fired when the external ip has changed. it will also fire the first time `.start()` or `.poll()` are invoked. | ||
* <b>`error`:</b> typical error handling here |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
13121
0