# ts-hypixel

> A Hypixel API wrapper made in Typescript

Latest version **0.0.3** (published 2023-04-05) · ISC license · 0 weekly downloads

## Install

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

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-04-05 |
| First published | 2023-04-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | devepicsterr |

## Links

- npm: https://www.npmjs.com/package/ts-hypixel
- npm.io page: https://npm.io/package/ts-hypixel

## Dependencies (4)

- [ms](https://npm.io/package/ms.md) ^2.1.3
- [tslint](https://npm.io/package/tslint.md) ^6.1.3
- [fetch-json](https://npm.io/package/fetch-json.md) ^3.1.1
- [typescript](https://npm.io/package/typescript.md) ^4.9.5

## Recent versions

- 0.0.3 (latest) — 2023-04-05
- 0.0.2 — 2023-04-04
- 0.0.1 — 2023-04-04

## README

# ts-hypixel
A Hypixel API wrapper made in Typescript

## How to Use
To get started you need to type
```bash
npm install ts-hypixel
```

After you install ts-hypixel, you need to make an **index.ts** file and put the following code within that file.
```typescript
import { Hypixel } from 'ts-hypixel'
const hypixel = new Hypixel('YOUR API KEY')
```
---
## Current Features
```typescript
(async () => {
    // Gets Player Data from a username
    await hypixel.getPlayer("Epicster") // --> (Player Data within Object)
    
    // Gets Guild Data from Guild name
    await hypixel.getGuild("Flexing Chimps") // --> (Guild Data within Object)
    
    // Gets the UUID from the username provided
    await hypixel.usernameToUUID("Epicster") // --> "35482c7a-df59-435e-b079-d2a955ebaa28"
    
    // Gets the username from the UUID provided
    await hypixel.uuidToUsername("35482c7a-df59-435e-b079-d2a955ebaa28") // --> "Epicster"
})();
```
---
## Current Upcoming Features

```

### If you wish to suggest any additional features for this package, head over to the GitHub Issues page and submit your idea.

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