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

67 lines (66 loc) 2.05 kB
import { Method } from "../../util/Method"; import { ResultObject } from "../../util/ResultObject"; import { GuildsResources } from "./guilds"; import { SkyBlockResources } from "./skyblock"; import { VanityResources } from "./vanity"; import type { ResourcesAchievementsResponse, ResourcesChallengesResponse, ResourcesGamesResponse, ResourcesQuestsResponse } from "../../types/AugmentedTypes"; /** * @example * ```typescript * const achievements = await client.resources.achievements(); * ``` * @category Client */ export declare class Resources extends Method { /** * Returns all the achievements for each gamemode on the Hypixel network. * @example * ```typescript * const achievements = await client.resources.achievements(); * ``` * @category API */ achievements(): Promise<ResultObject<ResourcesAchievementsResponse, ["achievements"]>>; /** * Returns all the challenges for each gamemode on the Hypixel network. * @example * ```typescript * const challenges = await client.resources.challenges(); * ``` * @category API */ challenges(): Promise<ResultObject<ResourcesChallengesResponse, ["challenges"]>>; /** * Returns information about Hypixel Games. * @example * ```typescript * const games = await client.resources.games(); * ``` * @category API */ games(): Promise<ResultObject<ResourcesGamesResponse, ["games"]>>; /** * Guild related resources. * @category API */ guilds: GuildsResources; /** * Returns all the quests for each gamemode on the Hypixel network. * @example * ```typescript * const quests = await client.resources.quests(); * ``` * @category API */ quests(): Promise<ResultObject<ResourcesQuestsResponse, ["quests"]>>; /** * SkyBlock related resources. * @category API */ skyblock: SkyBlockResources; /** * SkyBlock related resources. * @category API */ vanity: VanityResources; }