@nuintun/buffer 0.6.0 → 0.7.0

package/README.md

@@ -53,6 +53,11 @@ export interface Options {
    * @description 文本解码函数
    */
   decode?: TextDecode;
+  /**
+   * @property {boolean} [littleEndian]
+   * @description 指定默认字节序，默认小端字节序
+   */
+  littleEndian?: boolean;
 }
 
 /**
@@ -79,12 +84,6 @@ export declare class Buffer {
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
   constructor(bytes: TypedArray, options?: Options);
-  /**
-   * @constructor
-   * @param {ArrayBuffer} buffer 缓冲区初始缓冲数据
-   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
-   */
-  constructor(buffer: ArrayBuffer, options?: Options);
   /**
    * @public
    * @property {number} offset
@@ -179,7 +178,7 @@ export declare class Buffer {
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个 64 位有符号整数
-   * @param {bigint} value 要写入的 32 位有符号整数
+   * @param {bigint} value 要写入的 64 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value: bigint, littleEndian?: boolean): void;

package/cjs/binary.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/encoding.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/enum.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/errors.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -53,6 +53,8 @@ class Buffer {
   #encode;
   // 文本解码方法
   #decode;
+  // 字节序
+  #littleEndian;
   constructor(input = 0, options = {}) {
     let length;
     let bytes;
@@ -73,6 +75,7 @@ class Buffer {
     this.#encode = options.encode ?? encoding.encode;
     this.#decode = options.decode ?? encoding.decode;
     this.#dataView = new DataView(bytes.buffer);
+    this.#littleEndian = options.littleEndian ?? true;
   }
   /**
    * @private
@@ -230,7 +233,7 @@ class Buffer {
    * @param {number} value 要写入的 16 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt16(value, littleEndian) {
+  writeInt16(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.INT16 */);
     this.#alloc(offset);
     this.#dataView.setInt16(this.#offset, value, littleEndian);
@@ -242,7 +245,7 @@ class Buffer {
    * @param {number} value 要写入的 16 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint16(value, littleEndian) {
+  writeUint16(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
     this.#alloc(offset);
     this.#dataView.setUint16(this.#offset, value, littleEndian);
@@ -254,7 +257,7 @@ class Buffer {
    * @param {number} value 要写入的 32 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt32(value, littleEndian) {
+  writeInt32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.INT32 */);
     this.#alloc(offset);
     this.#dataView.setInt32(this.#offset, value, littleEndian);
@@ -266,7 +269,7 @@ class Buffer {
    * @param {number} value 要写入的 32 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint32(value, littleEndian) {
+  writeUint32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
     this.#alloc(offset);
     this.#dataView.setUint32(this.#offset, value, littleEndian);
@@ -275,10 +278,10 @@ class Buffer {
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个 64 位有符号整数
-   * @param {bigint} value 要写入的 32 位有符号整数
+   * @param {bigint} value 要写入的 64 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt64(value, littleEndian) {
+  writeInt64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.INT64 */);
     this.#alloc(offset);
     this.#dataView.setBigInt64(this.#offset, value, littleEndian);
@@ -290,7 +293,7 @@ class Buffer {
    * @param {bigint} value 要写入的 64 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint64(value, littleEndian) {
+  writeUint64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
     this.#alloc(offset);
     this.#dataView.setBigUint64(this.#offset, value, littleEndian);
@@ -302,7 +305,7 @@ class Buffer {
    * @param {number} value 单精度 32 位浮点数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeFloat32(value, littleEndian) {
+  writeFloat32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
     this.#alloc(offset);
     this.#dataView.setFloat32(this.#offset, value, littleEndian);
@@ -314,7 +317,7 @@ class Buffer {
    * @param {number} value 双精度 64 位浮点数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeFloat64(value, littleEndian) {
+  writeFloat64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
     this.#alloc(offset);
     this.#dataView.setFloat64(this.#offset, value, littleEndian);
@@ -373,7 +376,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 -32768 和 32767 之间的 16 位有符号整数
    */
-  readInt16(littleEndian) {
+  readInt16(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.INT16 */);
     this.#assertRead(offset);
     const value = this.#dataView.getInt16(this.#offset, littleEndian);
@@ -386,7 +389,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 0 和 65535 之间的 16 位无符号整数
    */
-  readUint16(littleEndian) {
+  readUint16(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
     this.#assertRead(offset);
     const value = this.#dataView.getUint16(this.#offset, littleEndian);
@@ -399,7 +402,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 -2147483648 和 2147483647 之间的 32 位有符号整数
    */
-  readInt32(littleEndian) {
+  readInt32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.INT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getInt32(this.#offset, littleEndian);
@@ -412,7 +415,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 0 和 4294967295 之间的 32 位无符号整数
    */
-  readUint32(littleEndian) {
+  readUint32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getUint32(this.#offset, littleEndian);
@@ -425,7 +428,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {bigint} 介于 -9223372036854775808 和 9223372036854775807 之间的 64 位有符号整数
    */
-  readInt64(littleEndian) {
+  readInt64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.INT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getBigInt64(this.#offset, littleEndian);
@@ -438,7 +441,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {bigint} 介于 0 和 18446744073709551615 之间的 64 位无符号整数
    */
-  readUint64(littleEndian) {
+  readUint64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getBigUint64(this.#offset, littleEndian);
@@ -451,7 +454,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 单精度 32 位浮点数
    */
-  readFloat32(littleEndian) {
+  readFloat32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getFloat32(this.#offset, littleEndian);
@@ -464,7 +467,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 双精度 64 位浮点数
    */
-  readFloat64(littleEndian) {
+  readFloat64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getFloat64(this.#offset, littleEndian);
@@ -493,10 +496,11 @@ class Buffer {
    * @returns {Buffer}
    */
   slice(start, end) {
-    return new Buffer(this.bytes.slice(start, end), {
+    return new Buffer(this.bytes.subarray(start, end), {
       encode: this.#encode,
       decode: this.#decode,
-      pageSize: this.#pageSize
+      pageSize: this.#pageSize,
+      littleEndian: this.#littleEndian
     });
   }
   /**

package/cjs/index.d.cts

@@ -22,6 +22,11 @@ export interface Options {
    * @description 文本解码函数
    */
   decode?: TextDecode;
+  /**
+   * @property {boolean} [littleEndian]
+   * @description 指定默认字节序，默认小端字节序
+   */
+  littleEndian?: boolean;
 }
 /**
  * @function endianness
@@ -141,7 +146,7 @@ export declare class Buffer {
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个 64 位有符号整数
-   * @param {bigint} value 要写入的 32 位有符号整数
+   * @param {bigint} value 要写入的 64 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value: bigint, littleEndian?: boolean): void;

package/cjs/utils.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/esm/binary.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/esm/encoding.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/esm/enum.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/esm/errors.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/esm/index.d.ts

@@ -22,6 +22,11 @@ export interface Options {
    * @description 文本解码函数
    */
   decode?: TextDecode;
+  /**
+   * @property {boolean} [littleEndian]
+   * @description 指定默认字节序，默认小端字节序
+   */
+  littleEndian?: boolean;
 }
 /**
  * @function endianness
@@ -141,7 +146,7 @@ export declare class Buffer {
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个 64 位有符号整数
-   * @param {bigint} value 要写入的 32 位有符号整数
+   * @param {bigint} value 要写入的 64 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value: bigint, littleEndian?: boolean): void;

package/esm/index.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -51,6 +51,8 @@ class Buffer {
   #encode;
   // 文本解码方法
   #decode;
+  // 字节序
+  #littleEndian;
   constructor(input = 0, options = {}) {
     let length;
     let bytes;
@@ -71,6 +73,7 @@ class Buffer {
     this.#encode = options.encode ?? encode;
     this.#decode = options.decode ?? decode;
     this.#dataView = new DataView(bytes.buffer);
+    this.#littleEndian = options.littleEndian ?? true;
   }
   /**
    * @private
@@ -228,7 +231,7 @@ class Buffer {
    * @param {number} value 要写入的 16 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt16(value, littleEndian) {
+  writeInt16(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.INT16 */);
     this.#alloc(offset);
     this.#dataView.setInt16(this.#offset, value, littleEndian);
@@ -240,7 +243,7 @@ class Buffer {
    * @param {number} value 要写入的 16 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint16(value, littleEndian) {
+  writeUint16(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
     this.#alloc(offset);
     this.#dataView.setUint16(this.#offset, value, littleEndian);
@@ -252,7 +255,7 @@ class Buffer {
    * @param {number} value 要写入的 32 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt32(value, littleEndian) {
+  writeInt32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.INT32 */);
     this.#alloc(offset);
     this.#dataView.setInt32(this.#offset, value, littleEndian);
@@ -264,7 +267,7 @@ class Buffer {
    * @param {number} value 要写入的 32 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint32(value, littleEndian) {
+  writeUint32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
     this.#alloc(offset);
     this.#dataView.setUint32(this.#offset, value, littleEndian);
@@ -273,10 +276,10 @@ class Buffer {
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个 64 位有符号整数
-   * @param {bigint} value 要写入的 32 位有符号整数
+   * @param {bigint} value 要写入的 64 位有符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeInt64(value, littleEndian) {
+  writeInt64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.INT64 */);
     this.#alloc(offset);
     this.#dataView.setBigInt64(this.#offset, value, littleEndian);
@@ -288,7 +291,7 @@ class Buffer {
    * @param {bigint} value 要写入的 64 位无符号整数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeUint64(value, littleEndian) {
+  writeUint64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
     this.#alloc(offset);
     this.#dataView.setBigUint64(this.#offset, value, littleEndian);
@@ -300,7 +303,7 @@ class Buffer {
    * @param {number} value 单精度 32 位浮点数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeFloat32(value, littleEndian) {
+  writeFloat32(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
     this.#alloc(offset);
     this.#dataView.setFloat32(this.#offset, value, littleEndian);
@@ -312,7 +315,7 @@ class Buffer {
    * @param {number} value 双精度 64 位浮点数
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
-  writeFloat64(value, littleEndian) {
+  writeFloat64(value, littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
     this.#alloc(offset);
     this.#dataView.setFloat64(this.#offset, value, littleEndian);
@@ -371,7 +374,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 -32768 和 32767 之间的 16 位有符号整数
    */
-  readInt16(littleEndian) {
+  readInt16(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.INT16 */);
     this.#assertRead(offset);
     const value = this.#dataView.getInt16(this.#offset, littleEndian);
@@ -384,7 +387,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 0 和 65535 之间的 16 位无符号整数
    */
-  readUint16(littleEndian) {
+  readUint16(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
     this.#assertRead(offset);
     const value = this.#dataView.getUint16(this.#offset, littleEndian);
@@ -397,7 +400,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 -2147483648 和 2147483647 之间的 32 位有符号整数
    */
-  readInt32(littleEndian) {
+  readInt32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.INT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getInt32(this.#offset, littleEndian);
@@ -410,7 +413,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 介于 0 和 4294967295 之间的 32 位无符号整数
    */
-  readUint32(littleEndian) {
+  readUint32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getUint32(this.#offset, littleEndian);
@@ -423,7 +426,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {bigint} 介于 -9223372036854775808 和 9223372036854775807 之间的 64 位有符号整数
    */
-  readInt64(littleEndian) {
+  readInt64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.INT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getBigInt64(this.#offset, littleEndian);
@@ -436,7 +439,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {bigint} 介于 0 和 18446744073709551615 之间的 64 位无符号整数
    */
-  readUint64(littleEndian) {
+  readUint64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getBigUint64(this.#offset, littleEndian);
@@ -449,7 +452,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 单精度 32 位浮点数
    */
-  readFloat32(littleEndian) {
+  readFloat32(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
     this.#assertRead(offset);
     const value = this.#dataView.getFloat32(this.#offset, littleEndian);
@@ -462,7 +465,7 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    * @returns {number} 双精度 64 位浮点数
    */
-  readFloat64(littleEndian) {
+  readFloat64(littleEndian = this.#littleEndian) {
     const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
     this.#assertRead(offset);
     const value = this.#dataView.getFloat64(this.#offset, littleEndian);
@@ -491,10 +494,11 @@ class Buffer {
    * @returns {Buffer}
    */
   slice(start, end) {
-    return new Buffer(this.bytes.slice(start, end), {
+    return new Buffer(this.bytes.subarray(start, end), {
       encode: this.#encode,
       decode: this.#decode,
-      pageSize: this.#pageSize
+      pageSize: this.#pageSize,
+      littleEndian: this.#littleEndian
     });
   }
   /**

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.6.0
+ * @version 0.7.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuintun/buffer",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A buffer tool for javascript.",
   "type": "module",
   "sideEffects": false,
@@ -41,7 +41,7 @@
     "magic-string": "^0.30.17",
     "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
-    "rollup": "^4.45.1",
+    "rollup": "^4.46.2",
     "typescript": "^5.8.3"
   },
   "scripts": {