# @types/mcping-js

> TypeScript definitions for mcping-js

Latest version **1.5.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/mcping-js
pnpm add @types/mcping-js
yarn add @types/mcping-js
bun add @types/mcping-js
```

## Health

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

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.5.4 |
| Published | 2023-11-07 |
| First published | 2021-03-07 |
| 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 | 51378 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.5.4 (latest) — 2023-11-07
- 1.5.1 (ts3.6) — 2021-07-08
- 1.5.0 (ts3.5) — 2021-03-07
- 1.5.3 — 2023-10-18
- 1.5.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/mcping-js`

# Summary
This package contains type definitions for mcping-js (https://github.com/Cryptkeeper/mcping-js).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mcping-js.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mcping-js/index.d.ts)
````ts
// TypeScript Version: 3.8
export interface PingResponse {
    version: {
        name: string;
        protocol: number;
    };

    players: {
        max: number;
        online: number;
        sample?:
            | Array<{
                name: string;
                id: string;
            }>
            | undefined;
    };

    description: {
        text: string;
    };

    favicon: string;
}

export class MinecraftServer {
    constructor(host: string, port?: number);
    ping(
        timeout: number,
        protocolVersion: number | undefined,
        callback: (err?: Error, res?: PingResponse) => void,
    ): void;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Inrix](https://github.com/Inrixia).

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