https://github.com/shigma/ping-minecraft-server

Ping Minecraft Server
https://github.com/shigma/ping-minecraft-server

Last synced: 2 months ago
JSON representation

Ping Minecraft Server

• Host: GitHub
• URL: https://github.com/shigma/ping-minecraft-server
• Owner: shigma
• License: mit
• Created: 2022-05-10T18:10:49.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-04T17:33:30.000Z (almost 3 years ago)
• Last Synced: 2024-10-05T11:41:40.115Z (8 months ago)
• Language: TypeScript
• Size: 5.86 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ping-minecraft-server

[![npm](https://img.shields.io/npm/v/ping-minecraft-server?style=flat-square)](https://www.npmjs.com/package/ping-minecraft-server)

Ping Minecraft Server.

- **Well-typed.** Written in TypeScript.

- **Lightweight.** Zero dependencies.

## Usage

```ts

import ping from 'ping-minecraft-server'

ping(host, port, options?)

/* {

  version: ...,

  players: ...,

  description: ...,

  favicon: ...,

} */

```

## Options

### timeout

- **type:** `number`

- **default:** `5000`

Connect timeout in milliseconds.