@threadmc/minecraft-api/dist/server.d.ts

An advanced Minecraft API client for interacting with piston-meta, minecraft servers, and more

/**
 * Provides methods for interacting with Minecraft servers (ping, status, query, legacy ping).
 */
export declare class Server {
    /**
     * Get the status of a Minecraft server using the server list ping protocol.
     * @param host The server hostname or IP.
     * @param port The server port (default 25565).
     * @returns The server status response.
     */
    getStatus(host: string, port?: number): Promise<any>;
    /**
     * Ping a Minecraft server and return latency (ms).
     * @param host The server hostname or IP.
     * @param port The server port (default 25565).
     * @param returnStatus If true, return status JSON instead of latency.
     * @returns The latency in ms or the status JSON.
     */
    ping(host: string, port?: number, returnStatus?: boolean): Promise<any>;
    /**
     * Query a Minecraft server for player/sample info (requires server.properties enable-query=true).
     * @param host The server hostname or IP.
     * @param port The query port (default 25565).
     * @returns The query response JSON.
     */
    query(host: string, port?: number): Promise<any>;
    /**
     * Legacy ping for Minecraft servers (1.6 and below).
     * @param host The server hostname or IP.
     * @param port The server port (default 25565).
     * @returns The legacy ping response.
     */
    legacyPing(host: string, port?: number): Promise<any>;
}
declare global {
    interface Buffer {
        /**
         * Read a VarInt from the buffer at the given offset.
         * @param offset The offset to start reading.
         * @returns The integer value.
         */
        readVarInt(offset: number): number;
    }
}