Skip to main content
Module

x/hypixel/index.ts>PlayerRank

With thorough IntelliSense support & 100% 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 (and an OpenAPI 3.0 schema!), built-in rate-limit handling, flexible cache support, helper functions, and support for undocumented endpoints.
zikeji/node-hypixel
Latest
interface PlayerRank
import { type PlayerRank } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Describes the results from the getPlayerRank helper.

Properties

priority: number

The priority of this rank as it relates to other ranks.

name: string

Name of the rank as it appears in the data.

cleanName: string

Cleaned up version of the name.

prefix: string

The chat prefix with Minecraft formatting codes.

cleanPrefix: string

The chat prefix without Minecraft formatting codes.

colorCode: MinecraftFormatting

The Minecraft formatting color code of this rank.

colorHex: MinecraftColorAsHex

The hex value of the color code.

optional
customRankColor: MinecraftFormatting

If they have a custom color for their rank. Note: this can be set when the player isn't MVP++. If you want to use this value, be sure to check if the rank is SUPERSTAR (MVP++).

optional
customRankColorHex: MinecraftColorAsHex

Same as customRankColor, but the hex version of the color.

optional
customPlusColor: MinecraftFormatting

If they have a custom color for the pluses in their rank (++). Note: this can be set when the player isn't MVP++. If you want to use this value, be sure to check if the rank is SUPERSTAR (MVP++).

optional
customPlusColorHex: MinecraftColorAsHex

Same as customPlusColor, but the hex version of the color.

staff: boolean

Whether or not this is a staff only rank.