@zikeji/hypixel

@zikeji/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

ALPHA - this project is not ready for production use, expect breaking changes that do not follow semver. semantic-releaser bumped me to 1.0.0, I had intended to stay on 0.X.X, and use 1.0.0 as my release, but it didn't pan out. 2.0.0 will be my release once all necessary features are completed.

Roadmap

• Add rate limiting support
• Add method, typing, testing, and documentation for:
  • Boosters
  • Find Guild
  • Friends
  • Game Counts
  • Guild
  • Key
  • Leaderboards
  • Player
  • Player Count
  • Recent Games
  • Resources
    • Achievements
    • Challenges
    • Guilds
      • Achievements
      • Permissions
    • SkyBlock
      • Collections
      • Skills
    • Quests
  • SkyBlock
    • News
    • Profile
    • Profiles
    • Auction
    • Auctions
    • Bazaar
  • Status
  • Watchdog Stats

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.8.0 (2020-10-19)

Features

• api: add /status endpoint (29be746)
• docs: add support for code blocks in descriptions (e8025eb)
• docs: revamp the schema display styles (0aa2ab7)
• docs: use webpack to load openapi yaml schema (33bc537)

Bug Fixes

• ci: type in nyc command for ci coverage (9beee2e)
• cross-env: use a ci script (8f1b4e1)
• docs: fix issues causing docs:build to fail (59f0f37)

Documentation

• api: style authorization dialog (8554eca)
• config: add to watched files (2d9283a)
• openapi: add usage examples (77b6d6c)
• readme: update to include project readme instead of custom readme for /, fix some styling (6f162c0)
• swagger: change expand depth (44992cb)