@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
31 lines (30 loc) • 973 B
TypeScript
import { Method } from "../../util/Method";
import { ResultObject } from "../../util/ResultObject";
import type { ResourcesVanityCompanionsResponse, ResourcesVanityPetsResponse } from "../../types/AugmentedTypes";
/**
* @example
* ```typescript
* const bingo = await client.resources.vanity.companions();
* ```
* @category Client
*/
export declare class VanityResources extends Method {
/**
* Retrieve a list of vanity companions.
* @example
* ```typescript
* const companions = await client.resources.vanity.companions();
* ```
* @category API
*/
companions(): Promise<ResultObject<ResourcesVanityCompanionsResponse, ["success", "lastUpdated"]>>;
/**
* Retrieve a list of vanity pets.
* @example
* ```typescript
* const pets = await client.resources.vanity.pets();
* ```
* @category API
*/
pets(): Promise<ResultObject<ResourcesVanityPetsResponse, ["success", "lastUpdated"]>>;
}