@zikeji/hypixel
Advanced tools
An unopinionated async/await API wrapper for Hypixel's Public API developed in TypeScript complete with documentation, OpenAPI 3.0 spec, intellisense, typed interfaces for all API responses, rate-limit handling, a few helpers, and support for undocumented
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.
Use npm to install this library.
npm i --save @zikeji/hypixel
const { Client } = require("@zikeji/hypixel");
const client = new Client("API_KEY");
(async () => {
const status = await client.status.uuid("20934ef9488c465180a78f861586b4cf"); // Minikloon
console.log(status);
// {"online": false}
const stats = await client.watchdogstats();
console.log(stats);
// {watchdog_lastMinute: 1, staff_rollingDaily: 2609, watchdog_total: 5591714, watchdog_rollingDaily: 4213, …}
})();
This library adds multiple helpers to facilitate using the Hypixel API. If you would like to request a helper that doesn't exist, please open an issue. Otherwise if you would like to contribute one refer to the below section.
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.
This projected is licensed under the MIT license. For additional details see LICENSE.
This library contains derivative work based on classes from the hypixel-php library. Code that is derivative work of hypixel-php will be marked as such with a header comment. See LICENSE-HYPIXEL-PHP.md for additional details on the original license.
1.20.0 (2021-01-08)
FAQs
With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible
The npm package @zikeji/hypixel receives a total of 36 weekly downloads. As such, @zikeji/hypixel popularity was classified as not popular.
We found that @zikeji/hypixel demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.