UNPKG

@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

24 lines (23 loc) 738 B
import { Paths } from "../types/api"; import { Method } from "../util/Method"; import { ResultObject } from "../util/ResultObject"; import type { PlayerResponse } from "../types/AugmentedTypes"; /** * @example * ```typescript * const player = await client.player.uuid("20934ef9488c465180a78f861586b4cf"); * ``` * @category Client */ export declare class Player extends Method { /** * Returns a player's data, such as game stats. * @example * ```typescript * const player = await client.player.uuid("20934ef9488c465180a78f861586b4cf"); * console.log(player); * ``` * @category API */ uuid(uuid: Paths.V2Player.Get.Parameters.Uuid): Promise<ResultObject<PlayerResponse, ["player"]>>; }