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

20 lines (19 loc) 679 B
import { Paths } from "../types/api"; import { Method } from "../util/Method"; import { ResultObject } from "../util/ResultObject"; import type { StatusResponse } from "../types/AugmentedTypes"; /** * @category Client */ export declare class Status extends Method { /** * Returns online status information for given player, including game, mode and map when available. * @example * ```typescript * const response = await client.status.uuid("20934ef9488c465180a78f861586b4cf"); * console.log(response); * ``` * @category API */ uuid(uuid: Paths.V2Status.Get.Parameters.Uuid): Promise<ResultObject<StatusResponse, ["session"]>>; }