Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hypixel-skyblock

zikeji17MITdeprecated1.3.0TypeScript support: included

WARNING: This project has been renamed to @zikeji/hypixel. Install using @zikeji/hypixel instead.

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

api, api-wrapper, hypixel, skyblock, minecraft, hypixel skyblock, minecraft hypixel, hypixel minecraft, hypixel minecraft skyblock, hypixel api, skyblock api, minecraft api

readme

hypixel-skyblock

npm npm bundle size visit docs Snyk Vulnerabilities for npm package version Libraries.io dependency status for latest release GitHub license GitHub last commit GitHub code size in bytes GitHub issues Coveralls github GitHub Workflow Status

An unopinionated async/await API wrapper for Hypixel's Skyblock 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 / completion of results.

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
  • <input disabled="" type="checkbox"> Add method, typing, testing, and documentation for:
    • <input disabled="" type="checkbox"> News
    • <input disabled="" type="checkbox"> Profile
    • <input disabled="" type="checkbox"> Profiles
    • <input disabled="" type="checkbox"> Auction
    • <input disabled="" type="checkbox"> Auctions
    • <input disabled="" type="checkbox"> Bazaar
      • <input disabled="" type="checkbox"> Product
      • <input disabled="" type="checkbox"> Products
    • <input disabled="" type="checkbox"> Resources
      • <input disabled="" type="checkbox"> Collections
      • <input disabled="" type="checkbox"> Skills

Installation

Use npm to install this library.

npm i --save hypixel-skyblock

Usage

import { Client as HypixelSkyblock } from "hypixel-skyblock";
const client = new HypixelSkyblock("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

Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.3.0 (2020-10-17)

Features

  • openapi: begin implementation of OpenAPI 3.0 spec (98dc4eb)

Documentation

  • readme: update shield (756e78f)
  • vuepress: rename typedoc generated content to ts-api (f56e9b3)

1.2.0 (2020-10-17)

Features

  • docs: add new documentation using vuepress (d9a1661)

Tests

  • queue: fix reset data issue (54ed1fd)

Code Refactoring

  • HypixelSkyblock to "Client". Add base index to re-export all for usage on NPM. (99401bb)

Documentation

  • readme: update readme (66b9c86)
  • more documentation for the profile interface (dab4a98)
  • more documentation tweaks, including namespacing (4de57ee)

1.1.0 (2020-10-12)

Features

  • ratelimit: add rate limit queue (707a342)

1.0.0 (2020-10-11)

Features

Bug Fixes

  • actions: add environment variable (773b7a1)
  • actions: drop support for node 8.0 (b8440f4)
  • ci: note to self: build before running tests (c70da5a)
  • semantic-release: use main branch (81276b0)

Documentation

  • readme: add another badge - shiny (9236b32)
  • readme: update readme & package (ddce35d)