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