@nuintun/buffer 0.1.0 → 0.2.1

package/README.md

@@ -22,18 +22,19 @@ export declare enum Endian {
   Big = 0,
   Little = 1
 }
+
 /**
  * @function endianness
  * @description 获取系统默认字节序
  * @returns {Endian}
  */
 export declare function endianness(): Endian;
+
 /**
  * @class Buffer
  * @classdesc Buffer 类提供用于优化读取，写入以及处理二进制数据的方法和属性
  */
 export declare class Buffer {
-  #private;
   /**
    * @constructor
    * @param {number} [length] 缓冲区初始大小
@@ -46,6 +47,7 @@ export declare class Buffer {
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
   constructor(bytes?: Uint8Array, pageSize?: number);
+
   /**
    * @public
    * @property {number} offset
@@ -53,6 +55,7 @@ export declare class Buffer {
    * @description 下一次调用读写方法时将在此位置开始读写
    */
   set offset(offset: number);
+
   /**
    * @public
    * @property {number} offset
@@ -60,6 +63,7 @@ export declare class Buffer {
    * @returns {number}
    */
   get offset(): number;
+
   /**
    * @public
    * @property {number} length
@@ -68,6 +72,7 @@ export declare class Buffer {
    * @description 如果将长度设置为大于当前长度的值，则用零填充字节数组的右侧
    */
   set length(length: number);
+
   /**
    * @public
    * @property {number} length
@@ -75,6 +80,7 @@ export declare class Buffer {
    * @returns {number}
    */
   get length(): number;
+
   /**
    * @public
    * @property {ArrayBuffer} buffer
@@ -82,6 +88,7 @@ export declare class Buffer {
    * @returns {ArrayBuffer}
    */
   get buffer(): ArrayBuffer;
+
   /**
    * @public
    * @property {Uint8Array} bytes
@@ -89,6 +96,7 @@ export declare class Buffer {
    * @returns {Uint8Array}
    */
   get bytes(): Uint8Array;
+
   /**
    * @public
    * @method writeInt8
@@ -96,6 +104,7 @@ export declare class Buffer {
    * @param {number} value 介于 -128 和 127 之间的整数
    */
   writeInt8(value: number): void;
+
   /**
    * @public
    * @method writeUint8
@@ -103,12 +112,14 @@ export declare class Buffer {
    * @param {number} value 介于 0 和 255 之间的整数
    */
   writeUint8(value: number): void;
+
   /**
    * @method writeBoolean
    * @description 在缓冲区中写入布尔值，true 写 1，false写 0
    * @param {boolean} value 布尔值
    */
   writeBoolean(value: boolean): void;
+
   /**
    * @method writeInt16
    * @description 在缓冲区中写入一个 16 位有符号整数
@@ -116,6 +127,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt16(value: number, littleEndian?: boolean): void;
+
   /**
    * @method writeUint16
    * @description 在缓冲区中写入一个 16 位无符号整数
@@ -123,6 +135,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint16(value: number, littleEndian?: boolean): void;
+
   /**
    * @method writeInt32
    * @description 在缓冲区中写入一个有符号的 32 位有符号整数
@@ -130,6 +143,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt32(value: number, littleEndian?: boolean): void;
+
   /**
    * @method writeUint32
    * @description 在缓冲区中写入一个无符号的 32 位无符号整数
@@ -137,6 +151,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint32(value: number, littleEndian?: boolean): void;
+
   /**
    * @method writeInt64
    * @description 在缓冲区中写入一个无符号的 64 位有符号整数
@@ -144,6 +159,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value: bigint, littleEndian?: boolean): void;
+
   /**
    * @method writeUint64
    * @description 在缓冲区中写入一个无符号的 64 位无符号整数
@@ -151,6 +167,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint64(value: bigint, littleEndian?: boolean): void;
+
   /**
    * @method writeFloat32
    * @description 在缓冲区中写入一个 IEEE 754 单精度 32 位浮点数
@@ -158,6 +175,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat32(value: number, littleEndian?: boolean): void;
+
   /**
    * @method writeFloat64
    * @description 在缓冲区中写入一个 IEEE 754 双精度 64 位浮点数
@@ -165,6 +183,7 @@ export declare class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat64(value: number, littleEndian?: boolean): void;
+
   /**
    * @method write
    * @description 将字符串用指定编码写入字节流
@@ -180,24 +199,28 @@ export declare class Buffer {
    * @param {number} [end] Uint8Array 对象结束索引
    */
   write(bytes: Uint8Array, start?: number, end?: number): void;
+
   /**
    * @method readInt8
    * @description 从缓冲区中读取有符号的整数
    * @returns {number} 介于 -128 和 127 之间的整数
    */
   readInt8(): number;
+
   /**
    * @method readUint8
    * @description 从缓冲区中读取无符号的整数
    * @returns {number} 介于 0 和 255 之间的无符号整数
    */
   readUint8(): number;
+
   /**
    * @method readBoolean
    * @description 从缓冲区中读取布尔值
    * @returns {boolean} 如果字节非零，则返回 true，否则返回 false
    */
   readBoolean(): boolean;
+
   /**
    * @method readInt16
    * @description 从缓冲区中读取一个 16 位有符号整数
@@ -205,6 +228,7 @@ export declare class Buffer {
    * @returns {number} 介于 -32768 和 32767 之间的 16 位有符号整数
    */
   readInt16(littleEndian?: boolean): number;
+
   /**
    * @method readUint16
    * @description 从缓冲区中读取一个 16 位无符号整数
@@ -212,6 +236,7 @@ export declare class Buffer {
    * @returns {number} 介于 0 和 65535 之间的 16 位无符号整数
    */
   readUint16(littleEndian?: boolean): number;
+
   /**
    * @method readInt32
    * @description 从缓冲区中读取一个 32 位有符号整数
@@ -219,6 +244,7 @@ export declare class Buffer {
    * @returns {number} 介于 -2147483648 和 2147483647 之间的 32 位有符号整数
    */
   readInt32(littleEndian?: boolean): number;
+
   /**
    * @method readUint32
    * @description 从缓冲区中读取一个 32 位无符号整数
@@ -226,6 +252,7 @@ export declare class Buffer {
    * @returns {number} 介于 0 和 4294967295 之间的 32 位无符号整数
    */
   readUint32(littleEndian?: boolean): number;
+
   /**
    * @method readInt64
    * @description 从缓冲区中读取一个 64 位有符号整数
@@ -233,6 +260,7 @@ export declare class Buffer {
    * @returns {bigint} 介于 -9223372036854775808 和 9223372036854775807 之间的 64 位有符号整数
    */
   readInt64(littleEndian?: boolean): bigint;
+
   /**
    * @method readUint64
    * @description 从缓冲区中读取一个 64 位无符号整数
@@ -240,6 +268,7 @@ export declare class Buffer {
    * @returns {bigint} 介于 0 和 18446744073709551615 之间的 64 位无符号整数
    */
   readUint64(littleEndian?: boolean): bigint;
+
   /**
    * @method readFloat32
    * @description 从缓冲区中读取一个 IEEE 754 单精度 32 位浮点数
@@ -247,6 +276,7 @@ export declare class Buffer {
    * @returns {number} 单精度 32 位浮点数
    */
   readFloat32(littleEndian?: boolean): number;
+
   /**
    * @method readFloat64
    * @description 从缓冲区中读取一个 IEEE 754 双精度 64 位浮点数
@@ -254,6 +284,7 @@ export declare class Buffer {
    * @returns {number} 双精度 64 位浮点数
    */
   readFloat64(littleEndian?: boolean): number;
+
   /**
    * @method read
    * @description 从缓冲区中读取指定长度的 Uint8Array 对象
@@ -269,6 +300,7 @@ export declare class Buffer {
    * @returns {string} 指定编码的字符串
    */
   read(length: number, encoding: string): string;
+
   /**
    * @public
    * @method slice
@@ -278,6 +310,7 @@ export declare class Buffer {
    * @returns {Buffer}
    */
   slice(start?: number, end?: number): Buffer;
+
   /**
    * @public
    * @method copyWithin
@@ -288,6 +321,7 @@ export declare class Buffer {
    * @returns {this}
    */
   copyWithin(target: number, start: number, end?: number): this;
+
   /**
    * @override
    * @method toString

package/cjs/Binary.cjs

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

package/cjs/Encoding/UTF8.cjs

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

package/cjs/Encoding/Unicode.cjs

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

package/cjs/Encoding/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.1.0
+ * @version 0.2.1
  * @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.1.0
+ * @version 0.2.1
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme