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

60 lines (59 loc) 2.13 kB
import { Method } from "../../util/Method"; import { ResultObject } from "../../util/ResultObject"; import type { ResourcesSkyblockBingoResponse, ResourcesSkyblockCollectionsResponse, ResourcesSkyblockElectionResponse, ResourcesSkyblockItemsResponse, ResourcesSkyblockSkillsResponse } from "../../types/AugmentedTypes"; import { ResultArray } from "../../util/ResultArray"; /** * @example * ```typescript * const achievements = await client.resources.achievements(); * ``` * @category Client */ export declare class SkyBlockResources extends Method { /** * Information regarding the current bingo event and its goals. * @example * ```typescript * const bingo = await client.resources.skyblock.bingo(); * ``` * @category API */ bingo(): Promise<ResultObject<ResourcesSkyblockBingoResponse, ["success", "lastUpdated"]>>; /** * Returns the list of ingame collections. * @example * ```typescript * const collections = await client.resources.skyblock.collections(); * console.log(collections.FARMING); * ``` * @category API */ collections(): Promise<ResultObject<ResourcesSkyblockCollectionsResponse, ["collections"]>>; /** * Information regarding the current mayor and ongoing election in SkyBlock. * @example * ```typescript * const electionInfo = await client.resources.skyblock.election(); * ``` * @category API */ election(): Promise<ResultObject<ResourcesSkyblockElectionResponse, ["success", "lastUpdated"]>>; /** * Returns the current items from the SkyBlock gamemode. * @example * ```typescript * const items = await client.resources.skyblock.items(); * ``` * @category API */ items(): Promise<ResultArray<ResourcesSkyblockItemsResponse, "items">>; /** * Returns the current skills from the SkyBlock gamemode. * @example * ```typescript * const skills = await client.resources.skyblock.skills(); * ``` * @category API */ skills(): Promise<ResultObject<ResourcesSkyblockSkillsResponse, ["skills"]>>; }