@zikeji/hypixel

node-hypixel

An unopinionated async/await API wrapper for Hypixel's Public API developed in TypeScript complete with documentation, typed interfaces for all API responses, rate-limit handling, a few helpers, and support for undocumented endpoints.

The library aims to replicate the Hypixel API as closely as possible, and as such won't alter the results, merely offering intellisense suggestions, rate-limit handling, and helpers.

Project Status

Development has started, not all features are implemented and not all endpoints explored and typed. This is a relatively small project and I intend to have it done ASAP.

Roadmap

• Add rate limiting support
• Add method, typing, testing, and documentation for:
  • News
  • Profile
  • Profiles
  • Auction
  • Auctions
  • Bazaar
    • Product
    • Products
  • Resources
    • Collections
    • Skills

Installation

Use npm to install this library.

npm i --save @zikeji/hypixel

Usage

import { Client as Hypixel } from "@zikeji/hypixel";
const client = new Hypixel("API_KEY");

Contributing

If some API result isn't documented / typed out fully, please open an issue and I can add it ASAP. Otherwise, pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

All changes must ensure they pass eslint, tests, and that testing is updated to meet or exceed the previous coverage.

License

MIT

Changelog

1.6.0 (2020-10-18)

Features

• docs: add Swagger client with some styling (7ef6f72)

Bug Fixes

• include all in dist folder (afa5044)

1.5.2 (2020-10-18)

Bug Fixes

• ci: add logging to action in attempt to troubleshoot missing information (c877fa4)

Documentation

• meta: add social, add embed metadata (858895a)
• readme: point to coveralls (1d30fe2)

1.5.1 (2020-10-18)

Bug Fixes

• docs: properly escape hero text (d3f789d)
• publishing: add publishconfig and explicit private (2fd4380)

Documentation

• readme: fix links (3565628)