54 lines
1.3 KiB
TypeScript
54 lines
1.3 KiB
TypeScript
|
import { PingOptions } from "..";
|
||
|
|
|
||
|
|
export type SampleProp = {
|
||
|
|
name: string,
|
||
|
|
id: string;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* `JSON Response` field of Response packet.
|
||
|
|
* @see https://wiki.vg/Server_List_Ping#Response
|
||
|
|
*/
|
||
|
|
export type JavaPingResponse = {
|
||
|
|
version: {
|
||
|
|
name: string;
|
||
|
|
protocol: number;
|
||
|
|
};
|
||
|
|
players: {
|
||
|
|
max: number;
|
||
|
|
online: number;
|
||
|
|
sample: SampleProp[];
|
||
|
|
};
|
||
|
|
description: string;
|
||
|
|
favicon: string;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Asynchronously ping Minecraft Java server.
|
||
|
|
*
|
||
|
|
* The optional `options` argument can be an object with a `ping` (default is `25565`) or/and `timeout` (default is `5000`) property.
|
||
|
|
*
|
||
|
|
* @param host The Java server address.
|
||
|
|
* @param options The configuration for pinging Minecraft Java server.
|
||
|
|
*
|
||
|
|
* ```js
|
||
|
|
* import { pingJava } from 'mineping';
|
||
|
|
*
|
||
|
|
* const data = await pingJava('mc.hypixel.net');
|
||
|
|
* console.log(data);
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* The resulting output will resemble:
|
||
|
|
* ```console
|
||
|
|
* {
|
||
|
|
* version: { name: 'Requires MC 1.8 / 1.18', protocol: 47 },
|
||
|
|
* players: { max: 200000, online: 67336, sample: [] },
|
||
|
|
* description: ' §f☃ §aHypixel Network §eTRIPLE COINS & EXP §f☃\n' +
|
||
|
|
* ' §6✰ §f§lHOLIDAY SALE §c§lUP TO 85% OFF §6✰',
|
||
|
|
* favicon: 'data:image/png;base64,iVBORw0KGg...
|
||
|
|
}
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export function pingJava(host: string, options?: PingOptions): Promise<JavaPingResponse>;
|
||
|
|
|