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

23 lines (22 loc) 922 B
import { Paths } from "../../types/api"; import { Method } from "../../util/Method"; import { ResultArray } from "../../util/ResultArray"; import type { SkyblockProfilesResponse } from "../../types/AugmentedTypes"; /** * @example * ```typescript * const profiles = await client.skyblock.profiles.uuid("20934ef9488c465180a78f861586b4cf"); * ``` * @category Client */ export declare class SkyBlockProfiles extends Method { /** * Returns an array SkyBlock profile's data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings. The request takes a player UUID. * @example * ```typescript * const profiles = await client.skyblock.profiles.uuid("20934ef9488c465180a78f861586b4cf"); * ``` * @category API */ uuid(uuid: Paths.V2SkyblockProfiles.Get.Parameters.Uuid): Promise<ResultArray<SkyblockProfilesResponse, "profiles">>; }