# vprikol-ts

> The best wrapper for Vprikol API you can find

Latest version **1.0.6** (published 2023-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install vprikol-ts
pnpm add vprikol-ts
yarn add vprikol-ts
bun add vprikol-ts
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-08-29 |
| First published | 2022-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Damir Modyarov |
| Maintainers | otomir23 |

## Links

- npm: https://www.npmjs.com/package/vprikol-ts
- Repository: https://github.com/otomir23/vprikol-ts
- npm.io page: https://npm.io/package/vprikol-ts

## Dependencies (2)

- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.0
- [tsimportlib](https://npm.io/package/tsimportlib.md) ^0.0.3

## Recent versions

- 1.0.6 (latest) — 2023-08-29
- 1.0.5 — 2023-04-18
- 1.0.4 — 2023-02-26
- 1.0.3 — 2023-02-22
- 1.0.2 — 2023-01-18
- 1.0.1 — 2022-11-22
- 1.0.0 — 2022-11-22

## README

# vprikol-ts

Wrapper for Vprikol API with types, written in TypeScript.

## 📦 Installation

```bash
npm i vprikol-ts
```

or

```bash
yarn add vprikol-ts
```

## 📚 Example

```typescript
import { VprikolAPI } from 'vprikol-ts';

// Create an instance of the API
const api = new VprikolAPI({ token: 'your_token' });

// Get a list of players in the fraction with ID 1 on the server with ID 1
api.members(1, 1).then(data => {
    // If the request was successful
    if (data.success === true) {
        // Print the list of players
        console.log(`
            List of players in the fraction '${data.data.fractionLabel}' on the server '${data.data.server}':
            ${Object.entries(data.data.players).map(([username, player]) => `${username} - ${player.rankLabel}`).join('\n')}
        `);
    } else {
        // Print the error message
        console.error(data.error.message);
    }
});

// You can also use async/await
```

## ⚙️ API

You can get your token [here](https://vprikol.ru/forms/get_token/)

You can find the full documentation [here](https://docs.vprikol.ru/)

## ⚖️ License

This project is licensed under the [MIT License](LICENSE.md).

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