@nxtedition/lib 28.0.23 → 28.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "28.0.23",
+  "version": "28.0.24",
   "license": "UNLICENSED",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",
@@ -92,5 +92,5 @@
     "canvas": "^3.1.0",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "2fbd54c297b3887f26f8c8f4384e1b0fa8fe1345"
+  "gitHead": "73f8163622322cb2cd3d0a1f6e9473c6d3b4693b"
 }

package/slice.js

@@ -3,15 +3,22 @@ import util from 'node:util'
 const EMPTY_BUF = Buffer.alloc(0)
 
 export class Slice {
-  buffer
+  /** @type {Buffer} */
+  buffer = EMPTY_BUF
+
+  /** @type {number} */
   byteOffset = 0
+
+  /** @type {number} */
   byteLength = 0
+
+  /** @type {number} */
   maxByteLength = 0
 
+  /** @type {Buffer} */
   static EMPTY_BUF = EMPTY_BUF
 
   /**
-   *
    * @param {Buffer} [buffer]
    * @param {number} [byteOffset]
    * @param {number} [byteLength]
@@ -49,6 +56,9 @@ export class Slice {
     this.maxByteLength = maxByteLength
   }
 
+  /**
+   * @returns {void}
+   */
   reset() {
     this.buffer = Slice.EMPTY_BUF
     this.byteOffset = 0
@@ -56,12 +66,15 @@ export class Slice {
     this.maxByteLength = 0
   }
 
+  /**
+   * @returns {number}
+   */
   get length() {
     return this.byteLength
   }
 
   /**
-   * @param {Buffer|Slice} target
+   * @param {Uint8Array} target
    * @param {number} [targetStart = 0]
    * @param {number} [sourceStart = 0]
    * @param {number} [sourceEnd = this.byteOffset]
@@ -94,12 +107,12 @@ export class Slice {
   }
 
   /**
-   * @param {Buffer|Slice} target
+   * @param {Uint8Array} target
    * @param {number} [targetStart = 0]
    * @param {number} [targetEnd = target.byteOffset]
    * @param {number} [sourceStart = 0]
    * @param {number} [sourceEnd = this.byteOffset]
-   * @returns
+   * @returns {-1 | 0 | 1}
    */
   compare(target, targetStart, targetEnd, sourceStart, sourceEnd) {
     if (target instanceof Slice) {
@@ -134,7 +147,6 @@ export class Slice {
   }
 
   /**
-   *
    * @param {string} string
    * @param {number} [offset=0]
    * @param {number} [length=this.byteLength - offset]
@@ -155,8 +167,13 @@ export class Slice {
     return this.buffer.write(string, offset, length, encoding)
   }
 
-  set(array, offset) {
-    if (array == null) {
+  /**
+   * @param {Buffer|Slice} source
+   * @param {number} offset
+   * @returns
+   */
+  set(source, offset) {
+    if (source == null) {
       return
     }
 
@@ -166,31 +183,28 @@ export class Slice {
       offset += this.byteOffset
     }
 
-    array?.copy(this.buffer, offset)
+    source.copy(this.buffer, offset)
   }
 
+  /**
+   * @param {number} index
+   * @returns {number}
+   */
   at(index) {
     return index >= 0
       ? this.buffer[this.byteOffset + index]
       : this.buffer[this.byteOffset + this.byteLength + index]
   }
 
+  /**
+   * @param {{ test: (Buffer: buffer, byteOffset: number, byteLength: number) => boolean }} expr
+   * @returns
+   */
   test(expr) {
     return expr.test(this.buffer, this.byteOffset, this.byteLength)
   }
 
-  readBigUInt64BE(offset = 0) {
-    if (offset === undefined) {
-      offset = this.byteOffset
-    } else {
-      offset += this.byteOffset
-    }
-
-    return this.buffer.readBigUInt64BE(offset)
-  }
-
   /**
-   *
    * @param {BufferEncoding} [encoding='utf8']
    * @param {number} [start=0]
    * @param {number} [end=this.byteLength]
@@ -212,6 +226,11 @@ export class Slice {
     return this.buffer.toString(encoding, start, end)
   }
 
+  /**
+   * @param {number} [start=0]
+   * @param {number} [end=this.byteLength]
+   * @returns {Buffer}
+   */
   toBuffer(start, end) {
     if (start === undefined) {
       start = this.byteOffset
@@ -228,10 +247,19 @@ export class Slice {
     return this.buffer.subarray(start, end)
   }
 
+  /**
+   * @returns {string}
+   */
   [Symbol.toStringTag]() {
     return this.toString()
   }
 
+  /**
+   * @param {*} depth
+   * @param {*} options
+   * @param {*} inspect
+   * @returns {string}
+   */
   [util.inspect.custom](depth, options, inspect) {
     const bytes = []
     for (let i = 0; i < this.byteLength; i++) {