# @types/tcp-ping

> TypeScript definitions for tcp-ping

Latest version **0.1.6** (published 2024-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/tcp-ping
pnpm add @types/tcp-ping
yarn add @types/tcp-ping
bun add @types/tcp-ping
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2024-07-05 |
| First published | 2017-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/tcp-ping
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tcp-ping
- npm.io page: https://npm.io/package/@types/tcp-ping

## Recent versions

- 0.1.6 (latest) — 2024-07-05
- 0.1.5 (ts4.5) — 2023-11-07
- 0.1.3 (ts3.8) — 2021-07-02
- 0.1.2 (ts3.5) — 2021-05-24
- 0.1.1 (ts2.9) — 2020-04-06
- 0.1.0 (ts2.1) — 2017-10-25
- 0.1.4 — 2023-10-18

## README

# Installation
> `npm install --save @types/tcp-ping`

# Summary
This package contains type definitions for tcp-ping (https://github.com/wesolyromek/tcp-ping).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tcp-ping.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tcp-ping/index.d.ts)
````ts
export interface Options {
    address?: string | undefined;
    port?: number | undefined;
    attempts?: number | undefined;
    timeout?: number | undefined;
}

export interface Results {
    seq: number;
    time: number | undefined;
    err?: Error | undefined;
}

export interface Result {
    address: string;
    port: number;
    attempts: number;
    avg: number;
    max: number;
    min: number;
    results: Results[];
}

export function ping(options: Options, callback: (error: Error, result: Result) => void): void;
export function probe(address: string, port: number, callback: (error: Error, result: boolean) => void): void;

````

### Additional Details
 * Last updated: Fri, 05 Jul 2024 20:08:00 GMT
 * Dependencies: none

# Credits
These definitions were written by [JUNG YONG WOO](https://github.com/stegano).

---
_Source: https://npm.io/package/@types/tcp-ping · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._