import { default } from "https://deno.land/x/hypixel@v3.1.1/index.ts";
Properties
private
readonly
optional
cache: ClientOptions["cache"]private
readonly
emitter: EventEmitterprivate
readonly
queue: Queueprotected
rateLimit: RateLimitDatarecentGames: RecentGames
Returns recent games of a player. A maximum of 100 games are returned and recent games are only stored for up to 3 days at this time.
status: Status
Returns online status information for given player, including game, mode and map when available.
Methods
private
callMethod<T extends Components.Schemas.ApiSuccess & { cause?: string; } & { cloudflareCache?: DefaultMeta["cloudflareCache"]; }>(): Promise<T>private
createActionableCall<T extends Components.Schemas.ApiSuccess>(path: string, parameters?: Parameters): ActionableCall<T>private
executeActionableCall<T extends Components.Schemas.ApiSuccess>(call: ActionableCall<T>): Promise<T>private
getRateLimitHeaders(headers: Record<string, string>): voidboosters(): Promise<ResultObject<Paths.Boosters.Get.Responses.$200, ["success"]>>
Returns list of boosters.
call<T extends Components.Schemas.ApiSuccess>(path: string, parameters?: Parameters): Promise<T & { cached?: boolean; }>
The raw query method used by this library. You may use this if you need to use an undocumented method with this library.
gameCounts(): Promise<ResultObject<Paths.GameCounts.Get.Responses.$200, ["success"]>>
Returns the current player count along with the player count of each public game + mode on the server.
key(): Promise<ResultObject<Paths.Key.Get.Responses.$200, ["record"]>>
Returns information regarding given key.
leaderboards(): Promise<ResultObject<Paths.Leaderboards.Get.Responses.$200, ["leaderboards"]>>
Returns a list of the official leaderboards and their current standings for games on the network.
off<E extends keyof ClientEvents>(event: E, listener: ClientEvents[E]): this
on<E extends keyof ClientEvents>(event: E, listener: ClientEvents[E]): this
once<E extends keyof ClientEvents>(event: E, listener: ClientEvents[E]): this
playerCount(): Promise<ResultObject<Paths.PlayerCount.Get.Responses.$200, ["success"]>>
Returns current player count.
watchdogstats(): Promise<ResultObject<Paths.Watchdogstats.Get.Responses.$200, ["success"]>>
Returns some statistics about Watchdog & bans.
Static Properties
private
readonly
endpoint: URL