mineping/types/lib/bedrock.d.ts

/**
 * @param port The server port.
 * @param timeout The read/write socket timeout.
 */
export type BedrockPingOptions = {
    port?: number | undefined,
    timeout?: number | undefined;
};

export type BedrockPingResponse = {
    name: string;
    version: {
        gameVersion: string;
        protocol: string;
    };
    players: {
        max: string;
        online: string;
    };
    description: string;
    gamemode: string;
};

/**
 * Asynchronously ping Minecraft Bedrock server.
 * 
 * The optional `options` argument can be an object with a `ping` (default is `19132`) or/and `timeout` (default is `5000`) property.
 * 
 * @param host The Bedrock server address.
 * @param options The configuration for pinging Minecraft Bedrock server.
 * 
 * ```js
 * import { pingBedrock } from '@minescope/mineping';
 * 
 * const data = await pingBedrock('mco.mineplex.com');
 * console.log(data);
 * ```
 * 
 * The resulting output will resemble:
 * ```console
 * {
 *   version: { name: 'Mineplex', protocol: '475' },
 *   players: { max: '5207', online: '5206' },
 *   description: ' New Costumes',
 *   gamemode: 'Survival'
 * }
 * ```
 * @see [source](https://github.com/minescope/mineping/blob/915edbec9c9ad811459458600af3531ec0836911/lib/bedrock.js#L204)
 */
export function pingBedrock(host: string, options?: BedrockPingOptions): Promise<BedrockPingResponse>;