@zikeji/hypixel
Version:
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
26 lines (25 loc) • 906 B
TypeScript
/**
* This portion of code was ported from the [hypixel-php](https://github.com/Plancke/hypixel-php) library.
*
* Copyright (c) 2020 Zikeji
* Copyright (c) 2017 Aäron Plancke
*
* For the original full copyright and license information, please view the LICENSE-HYPIXEL-PHP.md that was distributed with this source code.
*/
import type { PlayerResponse } from "../types/AugmentedTypes";
/**
* Describes the results of the {@link getBedwarsLevelInfo} helper.
*/
export interface BedwarsLevelInfo {
level: number;
prestige: number;
prestigeName: string;
prestigeColor: string;
prestigeColorHex: string;
levelInCurrentPrestige: number;
}
/**
* Calculates the BedWars prestige and level of a player and returns a {@link BedwarsLevelInfo} interface.
* @category Helper
*/
export declare function getBedwarsLevelInfo(data: PlayerResponse["player"] | number): BedwarsLevelInfo;