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

1.14.2 • Public • Published

Hive-Api-Node

A node.js wrapper for the api of https://hivemc.com, written in TypeScript.

Install

$ npm install hive-api

Documentation

https://lergin.github.io/hive-api/

Usage

JavaScript

const hive = require('hive-api');
 
let player = new hive.Player("Lergin_");
 
player.info().then(info => {
    console.log(`Tokens: ${info.tokens}`)
});

TypeScript

import {Player} from "hive-api";
 
let player: Player = new Player("Lergin_");
 
player.info().then((info: PlayerInfo) => {
    console.log(`Tokens: ${info.tokens}`)
});

Examples

Some examples are using async / await and therefor need to be wrapped into a async function. See: async_function

Print the unique players of each game

import {GameTypes, GameType} from "hive-api";
 
await GameTypes.update(); // update the list of GameTypes
 
GameTypes.list.forEach((type: GameType) => {
    type.uniquePlayers().then((players) => {
        console.log(`${type.name}${players} players`);
    });
});

Get the global achievements of the winner of the latest survival games game

import {GameTypes, Game, SgGameInfo, PlayerInfo, ServerAchievement, AchievementInfo} from "hive-api";
 
GameTypes.SG.latestGames()
    .then(games => games[0])
    .then((game: Game) => game.info())
    .then(async (gameInfo: SgGameInfo) => {
        let winnerInfo: PlayerInfo = await gameInfo.winner.info();
 
        winnerInfo.achievements.forEach((achievement: ServerAchievement) =>{
            achievement.info().then((info: AchievementInfo) => info.name)
            .then(console.log)
        });
    }).catch(console.error);

List the names of the skywars maps

import {GameTypes, GameMap} from "hive-api";
 
GameTypes.SKY.maps()
    .then((maps: GameMap[]) => maps.map((map: GameMap) => map.worldName))
    .then(console.log)

Get the amount of Beds destroyed by Malte662 in Bedwars

import {Player, BedPlayerGameInfo, GameTypes} from "hive-api"
 
let player: Player = new Player("Lergin_");
 
let playerBedInfo: BedPlayerGameInfo = (await player.gameInfo(GameTypes.BED)) as BedPlayerGameInfo;
 
console.log(playerBedInfo.bedsDestroyed);

There might be some more informations in the forums of HiveMC: https://forum.hivemc.com/threads/node-js-hive-api-library.279776/

Readme

Keywords

none

Package Sidebar

Install

npm i hive-api

Weekly Downloads

17

Version

1.14.2

License

MIT

Unpacked Size

5.86 MB

Total Files

440

Last publish

Collaborators

  • lergin