hypixie
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

hypixie Travis CI Build Status

A simplified interface for the Hypixel api.

NPM Badge

Install

npm install hypixie

Usage

const hypixie = require("hypixie");
 
(async () => {
    const { displayname } = await hypixie("player", {
        uuid: "56da43a4-088d-4a76-82b6-dd431535015e",
        key: "some api key"
    });
 
    console.log(displayname);
    //=> "Richienb"
})();

API

hypixie(endpoint, options)

endpoint

Type: string

The API endpoint to call.

options

Type: object

The options to pass to the API.

hypixie.HypixelError

Exposed for instanceof checks. This type of error is thrown when the API returns an error.

Package Sidebar

Install

npm i hypixie

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

4.23 kB

Total Files

6

Last publish

Collaborators

  • richienb