chore(package.json): bump version to 1.2.0

feat(pingJava): The ability to set a specific protocol version in the parameters. According to https://wiki.vg/Server_List_Ping#:~:text=0x00-,Protocol%20Version,-VarInt

README.md

@@ -1,6 +1,6 @@
 # mineping
 
-`mineping` is a Javasript library thar provides Minecraft server ping protocol implementation. It can be used to collect information about the server, such as MODT, current online, server icon (java edition only) and etc.
+This JavaScript library provides an implementation of the Minecraft server ping protocol. **It allows you to gather information about a Minecraft server**, such as the MOTD, current online players, server icon (Java Edition only), and more.
 
 Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center" width="20" height="20"/> Git](https://git.zeldon.ru/zeldon/mineping)
 
@@ -10,6 +10,8 @@ Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center
 
 ## Install
 
+To install `mineping`, simply run the following command:
+
 ```
 npm i @minescope/mineping
 ```
@@ -17,6 +19,7 @@ npm i @minescope/mineping
 ## Loading and configuration the module
 
 ### ES Modules (ESM)
+If you are using ES Modules, you can import the library like this:
 
 ```js
 import { pingJava, pingBedrock } from '@minescope/mineping';
@@ -59,5 +62,7 @@ console.log(data);
 
 ## Acknowledgements
 
+Special thanks to the following projects:
+
 - [mcping](https://github.com/Scetch/mcping) crate for Rust
 - [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers

example/parallel.js

@@ -13,6 +13,7 @@ const results = await Promise.allSettled(pingPromises);
 for (let result of results) {
     if (result.status === 'rejected') {
         console.error(result.reason);
+        break;
     }
 
     console.log(result.value);

lib/java.js

@@ -8,16 +8,15 @@
 import net from 'net';
 import varint from './varint.js';
 
-const PROTOCOL_VERSION = 0;
-
 /**
  * Ping a Minecraft Java server.
  * @param {string} host The host of the Java server.
  * @param {number} [port=25565] The port of the Java server.
  * @param {function} cb The callback function to handle the ping response.
  * @param {number} [timeout=5000] The timeout duration in milliseconds.
+ * @param {number} [protocolVersion=-1] The protocol version of the Java client.
  */
-function ping(host, port = 25565, cb, timeout = 5000) {
+function ping(host, port = 25565, cb, timeout = 5000, protocolVersion = -1) {
     const socket = net.createConnection(({ host, port }));
 
     // Set manual timeout interval.
@@ -56,7 +55,7 @@ function ping(host, port = 25565, cb, timeout = 5000) {
     socket.on('connect', () => {
         const handshake = varint.concat([
             varint.encodeInt(0),
-            varint.encodeInt(PROTOCOL_VERSION),
+            varint.encodeInt(protocolVersion),
             varint.encodeInt(host.length),
             varint.encodeString(host),
             varint.encodeUShort(port),
@@ -118,7 +117,7 @@ function ping(host, port = 25565, cb, timeout = 5000) {
 
 /**
  * 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.
+ * The optional `options` argument can be an object with a `port` (default is `25565`) or/and `timeout` (default is `5000`) or/and `protocolVersion` (default is `-1`) property.
  * @param {string} host The Java server address.
  * @param {import('../types/index.js').PingOptions} options The configuration for pinging Minecraft Java server.
  * @returns {Promise<import('../types/index.js').JavaPingResponse>}
@@ -126,11 +125,11 @@ function ping(host, port = 25565, cb, timeout = 5000) {
 export function pingJava(host, options = {}) {
     if (!host) throw new Error('Host argument is not provided');
 
-    const { port = 25565, timeout = 5000 } = options;
+    const { port = 25565, timeout = 5000, protocolVersion = -1 } = options;
 
     return new Promise((resolve, reject) => {
         ping(host, port, (res, err) => {
             err ? reject(err) : resolve(res);
-        }, timeout);
+        }, timeout, protocolVersion);
     });
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minescope/mineping",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Ping both Minecraft Bedrock and Java servers.",
   "main": "index.js",
   "types": "types/index.d.ts",

types/lib/bedrock.d.ts

@@ -2,7 +2,7 @@
  * @param port The server port.
  * @param timeout The read/write socket timeout.
  */
-export type PingOptions = {
+export type BedrockPingOptions = {
     port: number,
     timeout: number;
 };
@@ -45,5 +45,5 @@ export type BedrockPingResponse = {
  * ```
  * @see [source](https://github.com/minescope/mineping/blob/915edbec9c9ad811459458600af3531ec0836911/lib/bedrock.js#L204)
  */
-export function pingBedrock(host: string, options?: PingOptions): Promise<BedrockPingResponse>;
+export function pingBedrock(host: string, options?: BedrockPingOptions): Promise<BedrockPingResponse>;
 

types/lib/java.d.ts

@@ -1,4 +1,13 @@
-import { PingOptions } from "./bedrock";
+/**
+ * @param port The server port.
+ * @param timeout The read/write socket timeout.
+ * @param protocolVersion The protocol version.
+ */
+export type JavaPingOptions = {
+    port: number,
+    timeout: number,
+    protocolVersion: number;
+};
 
 /**
  * JSON format chat component used for description field.
@@ -67,5 +76,5 @@ export type JavaPingResponse = {
  * ```
  * @see [source](https://github.com/minescope/mineping/blob/915edbec9c9ad811459458600af3531ec0836911/lib/java.js#L117)
  */
-export function pingJava(host: string, options?: PingOptions): Promise<JavaPingResponse>;
+export function pingJava(host: string, options?: JavaPingOptions): Promise<JavaPingResponse>;