NODE-PING
a ping wrapper for nodejs
@last-modified: 2016-10-21 12:43
LICENSE MIT
(C) Daniel Zelisko
http://github.com/danielzzz/node-ping
DESCRIPTION
node-ping is a simple wrapper for the system ping utility
INSTALLATION
npm install ping
USAGE
Below are examples extracted from examples
Tradition calls
var ping = require('ping');
var hosts = ['192.168.1.1', 'google.com', 'yahoo.com'];
hosts.forEach(function(host){
ping.sys.probe(host, function(isAlive){
var msg = isAlive ? 'host ' + host + ' is alive' : 'host ' + host + ' is dead';
console.log(msg);
});
});
Tradition calls with configuration
var cfg = {
timeout: 10,
// WARNING: -i 2 may not work in other platform like window
extra: ["-i 2"],
};
hosts.forEach(function(host){
ping.sys.probe(host, function(isAlive){
var msg = isAlive ? 'host ' + host + ' is alive' : 'host ' + host + ' is dead';
console.log(msg);
}, cfg);
});
Promise wrapper
var ping = require('ping');
var hosts = ['192.168.1.1', 'google.com', 'yahoo.com'];
hosts.forEach(function (host) {
ping.promise.probe(host)
.then(function (res) {
console.log(res);
});
});
Promise Wrapper with configable ping options
hosts.forEach(function (host) {
// WARNING: -i 2 argument may not work in other platform like window
ping.promise.probe(host, {
timeout: 10,
extra: ["-i 2"],
}).then(function (res) {
console.log(res);
});
});
Support configuration
Below is the possible configuration
/**
* Cross platform config representation
* @typedef {Object} PingConfig
* @property {boolean} numeric - Map IP address to hostname or not
* @property {number} timeout - Time duration for ping command to exit
* @property {number} min_reply - Exit after sending number of ECHO_REQUEST
* @property {boolean} v6 - Ping via ipv6 or not. Default is false
* @property {string[]} extra - Optional options does not provided
*/
Output specification
- For callback based implementaiton:
/**
* Callback after probing given host
* @callback probeCallback
* @param {boolean} isAlive - Whether target is alive or not
* @param {Object} error - Null if no error occurs
*/
- For promise based implementation
/**
* Parsed response
* @typedef {object} PingResponse
* @param {string} host - The input IP address or HOST
* @param {string} numeric_host - Target IP address
* @param {boolean} alive - True for existed host
* @param {string} output - Raw stdout from system ping
* @param {number} time - Time (float) in ms for first successful ping response
* @param {string} min - Minimum time for collection records
* @param {string} max - Maximum time for collection records
* @param {string} avg - Average time for collection records
* @param {string} stddev - Standard deviation time for collected records
*/
Note
-
Since
ping
in this module relies on theping
from underlying platform, arguments inPingConfig.extra
will definitely be varied across different platforms. -
However,
numeric
,timeout
andmin_reply
have been abstracted. Values for them are expected to be cross platform. -
By setting
numeric
,timeout
ormin_reply
to false, you can runping
without corresponding arguments.
Contributing
Before opening a pull request please make sure your changes follow the contribution guidelines.