hypixel-ts-library v1.1.1

Hypixel-TS-Library

Repository for Hypixel API TypeScript types and utilities

Installation

npm install hypixel-ts-library

Basic Usage

Using the library is as simple as importing the types, then using those within your code:

import type { BazaarDataItem, BazaarDataBase } from "hypixel-ts-library";
// ...your code.

Read the Quick Start on github for more information on the types available and how to use them:

https://github.com/findlogan/Hypixel-TS-Library/wiki

It is also reccomended and encouraged to take a look into the source for yourself to see what is all included.

Suggestions and Issues

If you have suggestions, put them into issues for now.

Origin of the Project

Hypixel API documentation is not that good, and that is not a secret.

This repository and package will be dedicated to the open source community as both: a pet project, and also a central location for everyone to complete it.

You will find types mostly, but perhaps even a few development functions in the future.

Feel free to contribute to the repository as we grow together!

Notes

• Please note, yes I am aware of typing of "any" -- this is because of a lack of information. Please open a PR that fills the gaps with appropriate typing or that corrects the pre-existing.