@nuintun/buffer 0.3.0 → 0.3.2

package/esm/index.js

@@ -1,36 +1,31 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
  */
 
-import { makeUint8Array } from './utils.js';
 import { mapping } from './Binary.js';
-import { unknownEndianness, readOverflow, offsetInvalid, offsetOverflow, lengthInvalid } from './errors.js';
+import { unknownEndianness, readOverflow, offsetInvalid, lengthInvalid, readLengthInvalid } from './errors.js';
 import { encode, decode } from './Encoding/index.js';
+import { Endian } from './enum.js';
+import { isTypedArray, makeUint8Array, isNaturalNumber } from './utils.js';
 
 /**
  * @module Buffer
  */
-// 字节序类型
-var Endian;
-(function (Endian) {
-  Endian[(Endian['Big'] = 0)] = 'Big';
-  Endian[(Endian['Little'] = 1)] = 'Little';
-})(Endian || (Endian = {}));
 /**
  * @function endianness
  * @description 获取系统默认字节序
  * @returns {Endian}
  */
 function endianness() {
-  switch (new Uint8Array(new Uint32Array([0x12345678]))[0]) {
-    case 0x12:
+  switch (new Uint8Array(new Uint16Array([0x00ff]).buffer)[0]) {
+    case 0x00:
       return Endian.Big;
-    case 0x78:
+    case 0xff:
       return Endian.Little;
     default:
       throw new TypeError(unknownEndianness);
@@ -52,45 +47,64 @@ class Buffer {
   #offset = 0;
   // 已使用字节长度
   #length = 0;
+  /**
+   * @constructor
+   * @param {number | Uint8Array | ArrayBuffer} [input] 缓冲区初始配置
+   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
+   */
   constructor(input = 0, pageSize = 4096) {
-    this.#pageSize = pageSize;
-    if (input instanceof Uint8Array) {
-      this.#bytes = input;
-      this.#length = input.length;
-      this.#dataView = new DataView(input.buffer);
+    let length;
+    let bytes;
+    if (isTypedArray(input)) {
+      length = input.byteLength;
+      bytes = makeUint8Array(length, pageSize);
+      if (length > 0) {
+        bytes.set(new Uint8Array(input.buffer));
+      }
+    } else if (input instanceof ArrayBuffer) {
+      length = input.byteLength;
+      bytes = makeUint8Array(length, pageSize);
+      if (length > 0) {
+        bytes.set(new Uint8Array(input));
+      }
     } else {
-      const bytes = makeUint8Array(input, pageSize);
-      this.#bytes = bytes;
-      this.#length = input;
-      this.#dataView = new DataView(bytes.buffer);
+      length = input;
+      bytes = makeUint8Array(length, pageSize);
     }
+    this.#bytes = bytes;
+    this.#length = length;
+    this.#pageSize = pageSize;
+    this.#dataView = new DataView(bytes.buffer);
   }
   /**
    * @private
-   * @method grow
-   * @description 增加长度
-   * @param {number} length 长度增加量
+   * @method seek
+   * @description 移动读写指针
+   * @param {number} offset 指针位置
    */
-  #grow(length) {
-    this.#length += length;
+  #seek(offset) {
+    if (offset > this.#length) {
+      this.#length = offset;
+    }
+    this.#offset = offset;
   }
   /**
    * @private
-   * @method seek
-   * @description 移动读写指针
-   * @param {number} offset 指针偏移量
+   * @method getOffset
+   * @description 根据数据类型获取最新指针位置
+   * @param size 数据类型长度
    */
-  #seek(offset) {
-    this.#offset += offset;
+  #getOffset(size) {
+    return this.#offset + size;
   }
   /**
    * @private
    * @method assertRead
    * @description 读取断言，防止越界读取
-   * @param {number} length 断言字节长度
+   * @param {number} size 断言字节长度
    */
   #assertRead(length) {
-    if (length < 0 || this.#offset + length > this.#length) {
+    if (length > this.#length) {
       throw new RangeError(readOverflow);
     }
   }
@@ -101,7 +115,6 @@ class Buffer {
    * @param {number} length 分配字节长度
    */
   #alloc(length) {
-    length += this.#offset;
     const bytes = this.#bytes;
     if (length > bytes.length) {
       const newBytes = makeUint8Array(length, this.#pageSize);
@@ -117,12 +130,9 @@ class Buffer {
    * @description 下一次调用读写方法时将在此位置开始读写
    */
   set offset(offset) {
-    if (offset < 0) {
+    if (!isNaturalNumber(offset)) {
       throw new RangeError(offsetInvalid);
     }
-    if (offset > this.#length) {
-      throw new RangeError(offsetOverflow);
-    }
     this.#offset = offset;
   }
   /**
@@ -142,7 +152,7 @@ class Buffer {
    * @description 如果将长度设置为大于当前长度的值，则用零填充字节数组的右侧
    */
   set length(length) {
-    if (length < 0) {
+    if (!isNaturalNumber(length)) {
       throw new RangeError(lengthInvalid);
     }
     const currentLength = this.#length;
@@ -169,16 +179,16 @@ class Buffer {
   /**
    * @public
    * @property {ArrayBuffer} buffer
-   * @description 获取 ArrayBuffer 缓冲区
+   * @description 获取全部 ArrayBuffer 原始缓冲区
    * @returns {ArrayBuffer}
    */
   get buffer() {
-    return this.bytes.buffer;
+    return this.#bytes.buffer;
   }
   /**
    * @public
    * @property {Uint8Array} bytes
-   * @description 获取 Uint8Array 缓冲区
+   * @description 获取已写入 Uint8Array 原始缓冲区
    * @returns {Uint8Array}
    */
   get bytes() {
@@ -191,10 +201,10 @@ class Buffer {
    * @param {number} value 介于 -128 和 127 之间的整数
    */
   writeInt8(value) {
-    this.#alloc(1 /* SizeOf.INT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.INT8 */);
+    this.#alloc(offset);
     this.#dataView.setInt8(this.#offset, value);
-    this.#grow(1 /* SizeOf.INT8 */);
-    this.#seek(1 /* SizeOf.INT8 */);
+    this.#seek(offset);
   }
   /**
    * @public
@@ -203,10 +213,10 @@ class Buffer {
    * @param {number} value 介于 0 和 255 之间的整数
    */
   writeUint8(value) {
-    this.#alloc(1 /* SizeOf.UINT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.UINT8 */);
+    this.#alloc(offset);
     this.#dataView.setUint8(this.#offset, value);
-    this.#grow(1 /* SizeOf.UINT8 */);
-    this.#seek(1 /* SizeOf.UINT8 */);
+    this.#seek(offset);
   }
   /**
    * @method writeBoolean
@@ -223,10 +233,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt16(value, littleEndian) {
-    this.#alloc(2 /* SizeOf.INT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.INT16 */);
+    this.#alloc(offset);
     this.#dataView.setInt16(this.#offset, value, littleEndian);
-    this.#grow(2 /* SizeOf.INT16 */);
-    this.#seek(2 /* SizeOf.INT16 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint16
@@ -235,10 +245,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint16(value, littleEndian) {
-    this.#alloc(2 /* SizeOf.UINT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
+    this.#alloc(offset);
     this.#dataView.setUint16(this.#offset, value, littleEndian);
-    this.#grow(2 /* SizeOf.UINT16 */);
-    this.#seek(2 /* SizeOf.UINT16 */);
+    this.#seek(offset);
   }
   /**
    * @method writeInt32
@@ -247,10 +257,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.INT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.INT32 */);
+    this.#alloc(offset);
     this.#dataView.setInt32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.INT32 */);
-    this.#seek(4 /* SizeOf.INT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint32
@@ -259,10 +269,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.UINT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
+    this.#alloc(offset);
     this.#dataView.setUint32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.UINT32 */);
-    this.#seek(4 /* SizeOf.UINT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeInt64
@@ -271,10 +281,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.INT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.INT64 */);
+    this.#alloc(offset);
     this.#dataView.setBigInt64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.INT64 */);
-    this.#seek(8 /* SizeOf.INT64 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint64
@@ -283,10 +293,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.UINT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
+    this.#alloc(offset);
     this.#dataView.setBigUint64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.UINT64 */);
-    this.#seek(8 /* SizeOf.UINT64 */);
+    this.#seek(offset);
   }
   /**
    * @method writeFloat32
@@ -295,10 +305,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.FLOAT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
+    this.#alloc(offset);
     this.#dataView.setFloat32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.FLOAT32 */);
-    this.#seek(4 /* SizeOf.FLOAT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeFloat64
@@ -307,10 +317,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.FLOAT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
+    this.#alloc(offset);
     this.#dataView.setFloat64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.FLOAT64 */);
-    this.#seek(8 /* SizeOf.FLOAT64 */);
+    this.#seek(offset);
   }
   write(input, start, end) {
     let bytes;
@@ -321,10 +331,10 @@ class Buffer {
     }
     const { length } = bytes;
     if (length > 0) {
-      this.#alloc(length);
+      const offset = this.#getOffset(length);
+      this.#alloc(offset);
       this.#bytes.set(bytes, this.#offset);
-      this.#grow(length);
-      this.#seek(length);
+      this.#seek(offset);
     }
   }
   /**
@@ -333,9 +343,10 @@ class Buffer {
    * @returns {number} 介于 -128 和 127 之间的整数
    */
   readInt8() {
-    this.#assertRead(1 /* SizeOf.INT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.INT8 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt8(this.#offset);
-    this.#seek(1 /* SizeOf.INT8 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -344,9 +355,10 @@ class Buffer {
    * @returns {number} 介于 0 和 255 之间的无符号整数
    */
   readUint8() {
-    this.#assertRead(1 /* SizeOf.UINT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.UINT8 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint8(this.#offset);
-    this.#seek(1 /* SizeOf.UINT8 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -364,9 +376,10 @@ class Buffer {
    * @returns {number} 介于 -32768 和 32767 之间的 16 位有符号整数
    */
   readInt16(littleEndian) {
-    this.#assertRead(2 /* SizeOf.INT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.INT16 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt16(this.#offset, littleEndian);
-    this.#seek(2 /* SizeOf.INT16 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -376,9 +389,10 @@ class Buffer {
    * @returns {number} 介于 0 和 65535 之间的 16 位无符号整数
    */
   readUint16(littleEndian) {
-    this.#assertRead(2 /* SizeOf.UINT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint16(this.#offset, littleEndian);
-    this.#seek(2 /* SizeOf.UINT16 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -388,9 +402,10 @@ class Buffer {
    * @returns {number} 介于 -2147483648 和 2147483647 之间的 32 位有符号整数
    */
   readInt32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.INT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.INT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.INT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -400,9 +415,10 @@ class Buffer {
    * @returns {number} 介于 0 和 4294967295 之间的 32 位无符号整数
    */
   readUint32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.UINT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.UINT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -412,9 +428,10 @@ class Buffer {
    * @returns {bigint} 介于 -9223372036854775808 和 9223372036854775807 之间的 64 位有符号整数
    */
   readInt64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.INT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.INT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getBigInt64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.INT64 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -424,9 +441,10 @@ class Buffer {
    * @returns {bigint} 介于 0 和 18446744073709551615 之间的 64 位无符号整数
    */
   readUint64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.UINT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getBigUint64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.UINT64 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -436,9 +454,10 @@ class Buffer {
    * @returns {number} 单精度 32 位浮点数
    */
   readFloat32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.FLOAT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getFloat32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.FLOAT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -448,16 +467,20 @@ class Buffer {
    * @returns {number} 双精度 64 位浮点数
    */
   readFloat64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.FLOAT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getFloat64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.FLOAT64 */);
+    this.#seek(offset);
     return value;
   }
   read(length, encoding) {
-    this.#assertRead(length);
-    const offset = this.#offset;
-    const bytes = this.#bytes.slice(offset, offset + length);
-    this.#seek(length);
+    if (!isNaturalNumber(length)) {
+      throw new RangeError(readLengthInvalid);
+    }
+    const offset = this.#getOffset(length);
+    this.#assertRead(offset);
+    const bytes = this.#bytes.slice(this.#offset, offset);
+    this.#seek(offset);
     if (arguments.length >= 2) {
       return decode(bytes, encoding);
     }
@@ -488,6 +511,30 @@ class Buffer {
     this.#bytes.copyWithin(target, start, end);
     return this;
   }
+  /**
+   * @method entries
+   * @description 获取迭代器
+   * @returns {IterableIterator<[number, number]>}
+   */
+  *entries() {
+    const bytes = this.bytes;
+    const length = this.#length;
+    for (let i = 0; i < length; i++) {
+      yield [i, bytes[i]];
+    }
+  }
+  /**
+   * @method values
+   * @description 获取迭代器
+   * @returns {IterableIterator<number>}
+   */
+  *values() {
+    const bytes = this.bytes;
+    const length = this.#length;
+    for (let i = 0; i < length; i++) {
+      yield bytes[i];
+    }
+  }
   /**
    * @override
    * @method toString
@@ -506,6 +553,14 @@ class Buffer {
     // 返回二进制编码
     return binary;
   }
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator]() {
+    return this.values();
+  }
 }
 
 export { Buffer, Endian, endianness };

package/esm/utils.d.ts

@@ -1,11 +1,37 @@
 /**
  * @module utils
  */
+export type TypedArray =
+  | Int8Array
+  | Int16Array
+  | Int32Array
+  | Uint8Array
+  | Uint16Array
+  | Uint32Array
+  | Float32Array
+  | Float64Array
+  | BigInt64Array
+  | BigUint64Array
+  | Uint8ClampedArray;
+/**
+ * @function isTypedArray
+ * @description 检测是否为 TypedArray
+ * @param value 待判断的值
+ * @returns {boolean}
+ */
+export declare function isTypedArray(value: unknown): value is TypedArray;
+/**
+ * @function isNaturalNumber
+ * @description 判断是否为自然数
+ * @param value 待判断的值
+ * @returns {boolean}
+ */
+export declare function isNaturalNumber(value: unknown): value is number;
 /**
  * @function makeUint8Array
  * @description 创建一个合适长度的 Uint8Array
- * @param {number} byteLength 数据字节总大小
+ * @param {number} length 数据长度大小
  * @param {number} pageSize 缓冲区页大小
  * @returns {Uint8Array}
  */
-export declare function makeUint8Array(byteLength: number, pageSize: number): Uint8Array;
+export declare function makeUint8Array(length: number, pageSize: number): Uint8Array;

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -10,18 +10,38 @@
 /**
  * @module utils
  */
+// 获取 TypedArray 原型
+const TypedArray = Object.getPrototypeOf(Uint8Array);
+/**
+ * @function isTypedArray
+ * @description 检测是否为 TypedArray
+ * @param value 待判断的值
+ * @returns {boolean}
+ */
+function isTypedArray(value) {
+  return value instanceof TypedArray;
+}
+/**
+ * @function isNaturalNumber
+ * @description 判断是否为自然数
+ * @param value 待判断的值
+ * @returns {boolean}
+ */
+function isNaturalNumber(value) {
+  return Number.isInteger(value) && value >= 0;
+}
 /**
  * @function makeUint8Array
  * @description 创建一个合适长度的 Uint8Array
- * @param {number} byteLength 数据字节总大小
+ * @param {number} length 数据长度大小
  * @param {number} pageSize 缓冲区页大小
  * @returns {Uint8Array}
  */
-function makeUint8Array(byteLength, pageSize) {
-  if (byteLength > pageSize) {
-    return new Uint8Array(Math.ceil(byteLength / pageSize) * pageSize);
+function makeUint8Array(length, pageSize) {
+  if (length > pageSize) {
+    return new Uint8Array(Math.ceil(length / pageSize) * pageSize);
   }
   return new Uint8Array(pageSize);
 }
 
-export { makeUint8Array };
+export { isNaturalNumber, isTypedArray, makeUint8Array };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuintun/buffer",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A buffer tool for javascript.",
   "type": "module",
   "sideEffects": false,