Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justintaddei/tcp-ping
A simple TCP ping util, written in Typescript, to test the connectivity of a device.
https://github.com/justintaddei/tcp-ping
network ping probe tcp tcp-ip tcp-protocol
Last synced: 2 months ago
JSON representation
A simple TCP ping util, written in Typescript, to test the connectivity of a device.
- Host: GitHub
- URL: https://github.com/justintaddei/tcp-ping
- Owner: justintaddei
- License: mit
- Created: 2019-02-12T21:10:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T00:26:40.000Z (3 months ago)
- Last Synced: 2024-10-24T14:33:53.018Z (3 months ago)
- Topics: network, ping, probe, tcp, tcp-ip, tcp-protocol
- Language: TypeScript
- Size: 1.6 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# tcp-ping
[](https://github.com/justintaddei/tcp-ping/actions/workflows/tests.yml)
[](https://github.com/prettier/prettier)
A simple promise-based TCP ping util, written in Typescript, to test the reachability and latency of a host.
## Installation
```bash
$ npm install @network-utils/tcp-ping --save
```
## Usage
### `ping(options?: Partial, progress?: (progress, total) => void): Promise`
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!
```typescript
import { ping } from '@network-utils/tcp-ping'
ping({
// The IP address or hostname of the host you want
// to ping. Defaults to 127.0.0.1 (localhost)
address: '192.168.1.47',
// How many times do you want want to
// attempt to reach the host? Default is 10
attempts: 10,
// What port do you want to connect on?
// Default is 80
port: 80,
// How long do you want to wait (in milliseconds)
// before assuming an attempt has failed?
// Default is 3000 (3 seconds)
timeout: 3000
}, update).then(result => {
console.log('ping result:', result)
// ping result:
{
averageLatency: 19.2753,
errors: [
{
// Which attempt failed
attempt: 3,
error: Error('Request timeout')
}
],
maximumLatency: 35.1978,
minimumLatency: 3.7716,
options: {
address: '192.168.1.47',
attempts: 10,
port: 80,
timeout: 3000
}
}
})
function update(progress, total) {
console.log(progress, '/', total)
/*
1 / 10
2 / 10
3 / 10
...
*/
}
```
### `probe(port: number, address?: string, timeout?: number): Promise`
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`.
```typescript
import { probe } from '@network-utils/tcp-ping'
probe(80, '192.168.1.47', 500).then(hostReachable => {
if (hostReachable) console.log('The host is reachable 🙌')
else console.log('The host is not reachable 🤐')
})
// Or
const hostReachable = await probe(80, '192.168.1.47', 500)
```
## Errors
- All methods will throw a `"Negative port"` error if `port < 1`.
---
## Testing
```bash
$ git clone https://github.com/justintaddei/tcp-ping.git
$ cd tcp-ping
$ npm install
$ npm test
```
## License
MIT