refactoring and comments

fix(cli.js): refactor help and error handling logic for better readability and maintainability
feat(cli.js): add support for custom port and timeout options
fix(parallel.js): update list of hosts to ping
fix(bedrock.js): add comments and improve error handling in ping function
fix(java.js): add comments and improve error handling in ping function
fix(varint.js): add comments to functions and improve readability
fix(index.d.ts): export all functions from java.js and bedrock.js
fix(lib/bedrock.d.ts): update source link
fix(lib/java.d.ts): update source link
This commit is contained in:
2023-10-22 21:32:00 +03:00
parent 915edbec9c
commit 910184bf5f
8 changed files with 148 additions and 59 deletions

View File

@ -1,6 +1,14 @@
// https://wiki.vg/Data_types
/**
* A utility object for encoding and decoding varints.
*/
const varint = {
/**
* Encodes an integer value into a varint byte buffer.
* @param {number} val - The integer value to encode.
* @returns {Buffer}
*/
encodeInt: (val) => {
// "constInts are never longer than 5 bytes"
// https://wiki.vg/Data_types#constInt_and_constLong
@ -8,26 +16,43 @@ const varint = {
let written = 0;
while (true) {
if ((val & 0xFFFFFF80) === 0) {
buf.writeUInt8(val, written++);
const byte = val & 0x7F;
val >>>= 7;
if (val === 0) {
buf.writeUInt8(byte, written++);
break;
} else {
buf.writeUInt8(val & 0x7F | 0x80, written++);
val >>>= 7;
}
buf.writeUInt8(byte | 0x80, written++);
}
return buf.slice(0, written);
},
/**
* Encodes a string value into a UTF-8 byte buffer.
* @param {string} val - The string value to encode.
* @returns {Buffer}
*/
encodeString: (val) => {
return Buffer.from(val, 'utf-8');
},
/**
* Encodes an unsigned short value into a byte buffer.
* @param {number} val - The unsigned short value to encode.
* @returns {Buffer}
*/
encodeUShort: (val) => {
return Buffer.from([val >> 8, val & 0xFF]);
},
/**
* Concatenates multiple byte buffers into a single byte buffer.
* @param {Buffer[]} chunks - An array of byte buffers to concatenate.
* @returns {Buffer}
*/
concat: (chunks) => {
let length = 0;
@ -43,16 +68,22 @@ const varint = {
return Buffer.concat(buffer);
},
/**
* Decodes a varint integer value from a byte buffer.
* @param {Buffer} buffer - The byte buffer to decode from.
* @param {number} offset - The offset in the buffer to start decoding from.
* @returns {number}
*/
decodeInt: (buffer, offset) => {
let val = 0;
let count = 0;
while (true) {
const b = buffer.readUInt8(offset++);
const byte = buffer.readUInt8(offset++);
val |= (b & 0x7F) << count++ * 7;
val |= (byte & 0x7F) << count++ * 7;
if ((b & 0x80) != 128) {
if ((byte & 0x80) !== 0x80) {
break;
}
}
@ -60,8 +91,13 @@ const varint = {
return val;
},
// The number of bytes that the last .decodeInt() call had to use to decode.
/**
* Calculates the number of bytes required to decode a varint integer value.
* @param {number} val - The varint integer value.
* @returns {5 | 7 | 8 | 1 | 2 | 3 | 4 | 6 | 9 | 10}
*/
decodeLength: (val) => {
// Constants representing the powers of 2 used for comparison
const N1 = Math.pow(2, 7);
const N2 = Math.pow(2, 14);
const N3 = Math.pow(2, 21);
@ -72,6 +108,7 @@ const varint = {
const N8 = Math.pow(2, 56);
const N9 = Math.pow(2, 63);
// Return the number of bytes required based on the value
return (
val < N1 ? 1
: val < N2 ? 2