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) 784 B
import { Paths } from "../../types/api"; import { Method } from "../../util/Method"; import { ResultObject } from "../../util/ResultObject"; import type { SkyblockGardenResponse } from "../../types/AugmentedTypes"; /** * @example * ```typescript * const garden = await client.skyblock.gard.profile("20934ef9488c465180a78f861586b4cf"); * ``` * @category Client */ export declare class SkyBlockGarden extends Method { /** * SkyBlock garden data for the provided profile. * @example * ```typescript * const garden = await client.skyblock.garden.profile("20934ef9488c465180a78f861586b4cf"); * ``` * @category API */ profile(uuid: Paths.V2SkyblockGarden.Get.Parameters.Profile): Promise<ResultObject<SkyblockGardenResponse, ["garden"]>>; }