tcp-ping
A simple promise-based TCP ping util, written in Typescript, to test the reachability and latency of a host.
Installation
$ npm install network-utils-tcp-ping --save
Usage
ping(options?: Partial<IPingOptions>, progress?: (progress, total) => void): Promise<IPingResult>
Pings the given host and returns an object containing the latency of the connection and any errors that may have occured.
NOTE: Attempts are not concurrent. As such if a host is unreachable and you provide options { attempts: 60, timeout: 1000 } then
ping
will not resolve for a full minute!
ping, update.then
probe(port: number, address?: string, timeout?: number): Promise<boolean>
Makes one attempt to reach the host and returns a boolean
indicating whether or not it was successful.
If address
is not provided it will default to '127.0.0.1'
.
If timeout
is not provided it will default to 3000
.
probe80, '192.168.1.47', 500.then // Or
Errors
- All methods will throw a
"Negative port"
error ifport < 1
.
Testing
$ git clone https://github.com/justintaddei/tcp-ping.git$ cd tcp-ping$ npm install$ npm test
License
MIT