nodejs-tcp-ping

TCP Ping is a Node.JS based TCP ping utility written in Typescript

Getting Started

$3

``sh
yarn add nodejs-tcp-ping
`

$3

`sh
npm install nodejs-tcp-ping --save
`

Using with JavaScript

`javascript
const nodejsTcpPing = require('nodejsTcpPing');

// If you are not specify any options
// then ping localhost:80 five times
// with 5000ms timeout
nodejsTcpPing.tcpPing().then(results => {
// It return an array of ping data
// The returned data array (result) is looks like this,
// if everthing was successful: [{ ping: number }, ...]
// if some attempts timedout: [ { ping: null, error: 'Connection timed out' } ]
}).catch(reason => {
// Or a reason why it failed
});

// There is the full specification of options
nodejsTcpPing.tcpPing({
attempts: 5,
host: 'localhost',
port: 80,
timeout: 5000
}).then(results => {
// It return an array of ping data
}).catch(reason => {
// Or a reason why it failed
});
`

Using with TypeScript

`typescript
import { tcpPing, IPingData } from 'nodejsTcpPing';

tcpPing().then((result: IPingData[]) => {
// ...
}).catch((reason: any) => {
// ...
});

// Or

tcpPing({
attempts: 5,
host: 'localhost',
port: 80,
timeout: 5000
}).then((result: IPingData[]) => {
// ...
}).catch((reason: any) => {
// ...
});
`

Testing with yarn

$3

`sh
yarn
`

$3

`sh
yarn build
`

$3

`sh
yarn test
`

Testing with npm

$3

`sh
npm install
`

$3

`sh
npm run build
`

$3

`sh
npm test
``