@nuintun/buffer 0.3.0 → 0.3.2

package/cjs/index.d.cts

@@ -1,10 +1,10 @@
 /**
  * @module Buffer
  */
-export declare enum Endian {
-  Big = 0,
-  Little = 1
-}
+import type { TypedArray } from './utils.cjs';
+import { Endian } from './enum.cjs';
+export { Endian };
+export type { TypedArray };
 /**
  * @function endianness
  * @description 获取系统默认字节序
@@ -19,16 +19,22 @@ export declare class Buffer {
   #private;
   /**
    * @constructor
-   * @param {number} [length] 缓冲区初始大小
+   * @param {number} [length] 缓冲区初始字节大小
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
   constructor(length?: number, pageSize?: number);
   /**
    * @constructor
-   * @param {Uint8Array} bytes 缓冲区初始数据
+   * @param {Uint8Array} bytes 缓冲区初始字节数据
+   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
+   */
+  constructor(bytes: TypedArray, pageSize?: number);
+  /**
+   * @constructor
+   * @param {ArrayBuffer} buffer 缓冲区初始缓冲数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(bytes?: Uint8Array, pageSize?: number);
+  constructor(buffer: ArrayBuffer, pageSize?: number);
   /**
    * @public
    * @property {number} offset
@@ -61,14 +67,14 @@ export declare class Buffer {
   /**
    * @public
    * @property {ArrayBuffer} buffer
-   * @description 获取 ArrayBuffer 缓冲区
+   * @description 获取全部 ArrayBuffer 原始缓冲区
    * @returns {ArrayBuffer}
    */
   get buffer(): ArrayBuffer;
   /**
    * @public
    * @property {Uint8Array} bytes
-   * @description 获取 Uint8Array 缓冲区
+   * @description 获取已写入 Uint8Array 原始缓冲区
    * @returns {Uint8Array}
    */
   get bytes(): Uint8Array;
@@ -271,6 +277,18 @@ export declare class Buffer {
    * @returns {this}
    */
   copyWithin(target: number, start: number, end?: number): this;
+  /**
+   * @method entries
+   * @description 获取迭代器
+   * @returns {IterableIterator<[number, number]>}
+   */
+  entries(): IterableIterator<[number, number]>;
+  /**
+   * @method values
+   * @description 获取迭代器
+   * @returns {IterableIterator<number>}
+   */
+  values(): IterableIterator<number>;
   /**
    * @override
    * @method toString
@@ -278,4 +296,10 @@ export declare class Buffer {
    * @returns {string}
    */
   toString(): string;
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator](): IterableIterator<number>;
 }

package/cjs/utils.cjs

@@ -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
@@ -12,18 +12,40 @@
 /**
  * @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);
 }
 
+exports.isNaturalNumber = isNaturalNumber;
+exports.isTypedArray = isTypedArray;
 exports.makeUint8Array = makeUint8Array;

package/cjs/utils.d.cts

@@ -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/Binary.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

package/esm/Encoding/UTF8.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

package/esm/Encoding/Unicode.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

package/esm/Encoding/index.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

package/esm/enum.d.ts

@@ -1,6 +1,10 @@
 /**
  * @module enum
  */
+export declare enum Endian {
+  Big = 0,
+  Little = 1
+}
 export declare const enum SizeOf {
   INT8 = 1,
   UINT8 = 1,

package/esm/enum.js

@@ -0,0 +1,20 @@
+/**
+ * @package @nuintun/buffer
+ * @license MIT
+ * @version 0.3.2
+ * @author nuintun <nuintun@qq.com>
+ * @description A buffer tool for javascript.
+ * @see https://github.com/nuintun/Buffer#readme
+ */
+
+/**
+ * @module enum
+ */
+// 字节序类型
+var Endian;
+(function (Endian) {
+  Endian[(Endian['Big'] = 0)] = 'Big';
+  Endian[(Endian['Little'] = 1)] = 'Little';
+})(Endian || (Endian = {}));
+
+export { Endian };

package/esm/errors.d.ts

@@ -1,9 +1,15 @@
 /**
  * @module errors
  */
+/**
+ * @function encodingInvalid
+ * @description 未支持的编码格式
+ * @param encoding 编码格式
+ */
 export declare function encodingInvalid(encoding: string): string;
-export declare const unknownEndianness = 'unknown endianness';
-export declare const lengthInvalid = 'invalid buffer length';
 export declare const offsetInvalid = 'invalid buffer offset';
+export declare const lengthInvalid = 'invalid buffer length';
+export declare const unknownEndianness = 'unknown endianness';
+export declare const readLengthInvalid = 'invalid read length';
 export declare const readOverflow = 'read is outside the bounds of the Buffer';
 export declare const offsetOverflow = 'offset is outside the bounds of the Buffer';

package/esm/errors.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,19 +10,23 @@
 /**
  * @module errors
  */
-// 未支持的编码格式
+/**
+ * @function encodingInvalid
+ * @description 未支持的编码格式
+ * @param encoding 编码格式
+ */
 function encodingInvalid(encoding) {
   return 'unsupported encoding ' + encoding;
 }
-// 未知字节序
-const unknownEndianness = 'unknown endianness';
-// 非法长度
-const lengthInvalid = 'invalid buffer length';
 // 非法读写指针
 const offsetInvalid = 'invalid buffer offset';
+// 非法长度
+const lengthInvalid = 'invalid buffer length';
+// 未知字节序
+const unknownEndianness = 'unknown endianness';
+// 数据读取长度非法
+const readLengthInvalid = 'invalid read length';
 // 数据读取溢出
 const readOverflow = 'read is outside the bounds of the Buffer';
-// 读写指针溢出
-const offsetOverflow = 'offset is outside the bounds of the Buffer';
 
-export { encodingInvalid, lengthInvalid, offsetInvalid, offsetOverflow, readOverflow, unknownEndianness };
+export { encodingInvalid, lengthInvalid, offsetInvalid, readLengthInvalid, readOverflow, unknownEndianness };

package/esm/index.d.ts

@@ -1,10 +1,10 @@
 /**
  * @module Buffer
  */
-export declare enum Endian {
-  Big = 0,
-  Little = 1
-}
+import type { TypedArray } from './utils.js';
+import { Endian } from './enum.js';
+export { Endian };
+export type { TypedArray };
 /**
  * @function endianness
  * @description 获取系统默认字节序
@@ -19,16 +19,22 @@ export declare class Buffer {
   #private;
   /**
    * @constructor
-   * @param {number} [length] 缓冲区初始大小
+   * @param {number} [length] 缓冲区初始字节大小
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
   constructor(length?: number, pageSize?: number);
   /**
    * @constructor
-   * @param {Uint8Array} bytes 缓冲区初始数据
+   * @param {Uint8Array} bytes 缓冲区初始字节数据
+   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
+   */
+  constructor(bytes: TypedArray, pageSize?: number);
+  /**
+   * @constructor
+   * @param {ArrayBuffer} buffer 缓冲区初始缓冲数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(bytes?: Uint8Array, pageSize?: number);
+  constructor(buffer: ArrayBuffer, pageSize?: number);
   /**
    * @public
    * @property {number} offset
@@ -61,14 +67,14 @@ export declare class Buffer {
   /**
    * @public
    * @property {ArrayBuffer} buffer
-   * @description 获取 ArrayBuffer 缓冲区
+   * @description 获取全部 ArrayBuffer 原始缓冲区
    * @returns {ArrayBuffer}
    */
   get buffer(): ArrayBuffer;
   /**
    * @public
    * @property {Uint8Array} bytes
-   * @description 获取 Uint8Array 缓冲区
+   * @description 获取已写入 Uint8Array 原始缓冲区
    * @returns {Uint8Array}
    */
   get bytes(): Uint8Array;
@@ -271,6 +277,18 @@ export declare class Buffer {
    * @returns {this}
    */
   copyWithin(target: number, start: number, end?: number): this;
+  /**
+   * @method entries
+   * @description 获取迭代器
+   * @returns {IterableIterator<[number, number]>}
+   */
+  entries(): IterableIterator<[number, number]>;
+  /**
+   * @method values
+   * @description 获取迭代器
+   * @returns {IterableIterator<number>}
+   */
+  values(): IterableIterator<number>;
   /**
    * @override
    * @method toString
@@ -278,4 +296,10 @@ export declare class Buffer {
    * @returns {string}
    */
   toString(): string;
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator](): IterableIterator<number>;
 }