# minefort

> TypeScript library for the Minefort API

Latest version **0.2.0** (published 2025-02-14) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: has types; no vulnerabilities.

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

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2025-02-14 |
| First published | 2024-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Tarna |
| Maintainers | tarna256 |
| Keywords | minecraft, minefort, servers, blogs |

## Links

- npm: https://www.npmjs.com/package/minefort
- Repository: https://github.com/tarna/minefort
- Homepage: https://github.com/tarna/minefort#readme
- Issues: https://github.com/tarna/minefort/issues
- npm.io page: https://npm.io/package/minefort

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2025-02-14
- 0.1.2 — 2024-11-04
- 0.1.1 — 2024-11-04
- 0.1.0 — 2024-11-04

## README

# Minefort
A TypeScript wrapper for the [Minefort](https://minefort.com) HTTP API

## Installation
Install minefort with [NPM](https://npmjs.com)

```bash
  npm install minefort
```

## Features
- Get a list of online Minefort servers
- Get a list of blog articles

## Basic Usage
```ts
const minefort = new Minefort();

async function main() {
    const minefort = new Minefort();
    const servers = await minefort.servers.getOnlineServers({
        limit: 10,
    });
    console.log(servers);

    const articles = await minefort.blog.getArticles();
    console.log(articles.reduce((acc, article) => acc + article.readingTime, 0));
}

main();
```

For more examples, visit [example.ts](https://github.com/tarna/minefort/blob/master/src/example.ts).

## Contributing
Contributions are always welcome!

See `contributing.md` for ways to get started.

## License
[MIT](https://choosealicense.com/licenses/mit)

## Contributors
- [@tarna](https://www.github.com/tarna)

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