# pingerminecraft

> A Nodejs library that allows you to get information about the minecraft server using https://api.mcsrvstat.us/

Latest version **2.0.1** (published 2024-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install pingerminecraft
pnpm add pingerminecraft
yarn add pingerminecraft
bun add pingerminecraft
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-07-16 |
| First published | 2023-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | makarasty |
| Maintainers | makarasty |
| Keywords | minecraft, pingerminecraft, minecraftpinger, pinger, fetch, minecraftjava, minecraftbedrock, minecraftje, minecraftbe |

## Links

- npm: https://www.npmjs.com/package/pingerminecraft
- Repository: https://github.com/makarasty/pingerMinecraft
- Homepage: https://github.com/makarasty/pingerMinecraft#readme
- Issues: https://github.com/makarasty/pingerMinecraft/issues
- npm.io page: https://npm.io/package/pingerminecraft

## Dependencies (1)

- [undici](https://npm.io/package/undici.md) ^6.19.2

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-07-16
- 2.0.0 — 2024-07-16
- 1.5.2-h — 2023-06-28
- 1.5.2 — 2023-06-28
- 1.5.1 — 2023-06-28
- 1.5.0 — 2023-06-28
- 1.0.2 — 2023-05-12
- 1.0.1 — 2023-05-12
- 1.0.0 — 2023-05-11

## README

# This library uses https://api.mcsrvstat.us/ !

**Nodejs** library that allows you to get **information** about the minecraft server

# Install
`npm i pingerminecraft`

# OS Dependencies
- Node.js

# Lib Dependencies
- undici

![image](https://github.com/user-attachments/assets/fd7fe3a3-aea5-4bf6-814a-0133ce44ab05)

# Example 1: Async Function
```js
const pingerMinecraft = require("pingerminecraft")

const data = await pingerMinecraft('95.216.62.176:25565')

console.log(data)
```

# Example 2: Then constructs
```js
const pingerMinecraft = require("pingerminecraft")

pingerMinecraft('95.216.62.176:25565')
	.then(data => console.log(data))
	.catch(error => console.error(error))
```

# Example 2: Then constructs, bedrock true
```js
const pingerMinecraft = require("pingerminecraft")

pingerMinecraft('95.216.62.176:25566', true)
	.then(console.log)
	.catch(console.error)
```

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