@nuintun/buffer 0.3.1 → 0.4.0

package/esm/index.js

@@ -1,17 +1,17 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.1
+ * @version 0.4.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
  */
 
-import { mapping } from './Binary.js';
 import { unknownEndianness, readOverflow, offsetInvalid, lengthInvalid, readLengthInvalid } from './errors.js';
-import { encode, decode } from './Encoding/index.js';
+import { mapping } from './binary.js';
 import { Endian } from './enum.js';
-import { makeUint8Array, isNaturalNumber } from './utils.js';
+import { encode, decode } from './encoding.js';
+import { isTypedArray, makeUint8Array, isNaturalNumber } from './utils.js';
 
 /**
  * @module Buffer
@@ -22,10 +22,10 @@ import { makeUint8Array, isNaturalNumber } from './utils.js';
  * @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);
@@ -47,29 +47,36 @@ class Buffer {
   #offset = 0;
   // 已使用字节长度
   #length = 0;
-  /**
-   * @constructor
-   * @param {number | Uint8Array} input 缓冲区初始配置
-   * @param {number} pageSize 缓冲区分页大小，扩容时将按分页大小增加
-   */
-  constructor(input = 0, pageSize = 4096) {
+  // 文本编码方法
+  #encode;
+  // 文本解码方法
+  #decode;
+  constructor(input = 0, options = {}) {
     let length;
     let bytes;
-    let dataView;
-    if (input instanceof Uint8Array) {
-      length = input.length;
+    const { pageSize = 4096 } = options;
+    if (isTypedArray(input)) {
+      length = input.byteLength;
       bytes = makeUint8Array(length, pageSize);
-      bytes.set(input);
-      dataView = new DataView(bytes.buffer);
+      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 {
       length = input;
-      bytes = makeUint8Array(input, pageSize);
-      dataView = new DataView(bytes.buffer);
+      bytes = makeUint8Array(length, pageSize);
     }
     this.#bytes = bytes;
     this.#length = length;
-    this.#dataView = dataView;
     this.#pageSize = pageSize;
+    this.#encode = options.encode ?? encode;
+    this.#decode = options.decode ?? decode;
+    this.#dataView = new DataView(bytes.buffer);
   }
   /**
    * @private
@@ -174,16 +181,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() {
@@ -322,7 +329,7 @@ class Buffer {
     if (input instanceof Uint8Array) {
       bytes = input.subarray(start, end);
     } else {
-      bytes = encode(input, start);
+      bytes = this.#encode(input, start ?? 'utf-8');
     }
     const { length } = bytes;
     if (length > 0) {
@@ -476,8 +483,8 @@ class Buffer {
     this.#assertRead(offset);
     const bytes = this.#bytes.slice(this.#offset, offset);
     this.#seek(offset);
-    if (arguments.length >= 2) {
-      return decode(bytes, encoding);
+    if (encoding != null) {
+      return this.#decode(bytes, encoding);
     }
     return bytes;
   }
@@ -490,8 +497,11 @@ class Buffer {
    * @returns {Buffer}
    */
   slice(start, end) {
-    const bytes = this.#bytes.slice(start, end);
-    return new Buffer(bytes, this.#pageSize);
+    return new Buffer(this.#bytes.slice(start, end), {
+      encode: this.#encode,
+      decode: this.#decode,
+      pageSize: this.#pageSize
+    });
   }
   /**
    * @public
@@ -506,6 +516,38 @@ 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];
+    }
+  }
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator]() {
+    return this.values();
+  }
   /**
    * @override
    * @method toString
@@ -515,10 +557,8 @@ class Buffer {
   toString() {
     // 二进制编码字符串
     let binary = '';
-    // 提前获取 bytes，防止重复计算
-    const bytes = this.bytes;
     // 获取二进制编码
-    for (const byte of bytes) {
+    for (const byte of this) {
       binary += mapping[byte];
     }
     // 返回二进制编码

package/esm/utils.d.ts

@@ -1,18 +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: number): 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.1
+ * @version 0.4.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -10,6 +10,17 @@
 /**
  * @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 判断是否为自然数
@@ -17,20 +28,20 @@
  * @returns {boolean}
  */
 function isNaturalNumber(value) {
-  return value >= 0 && Number.isInteger(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 { isNaturalNumber, makeUint8Array };
+export { isNaturalNumber, isTypedArray, makeUint8Array };

package/package.json

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

package/cjs/Encoding/UTF8.cjs

@@ -1,33 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-'use strict';
-
-/**
- * @module UTF8
- */
-// 编码器实例
-const encoder = new TextEncoder();
-// 解码器实例
-const decoder = new TextDecoder();
-/**
- * @function encode
- * @param {string} input
- * @returns {Uint8Array}
- */
-const encode = encoder.encode.bind(encoder);
-/**
- * @function decode
- * @param {BufferSource} input
- * @returns {string}
- */
-const decode = decoder.decode.bind(decoder);
-
-exports.decode = decode;
-exports.encode = encode;

package/cjs/Encoding/UTF8.d.cts

@@ -1,15 +0,0 @@
-/**
- * @module UTF8
- */
-/**
- * @function encode
- * @param {string} input
- * @returns {Uint8Array}
- */
-export declare const encode: (input?: string) => Uint8Array;
-/**
- * @function decode
- * @param {BufferSource} input
- * @returns {string}
- */
-export declare const decode: (input?: BufferSource) => string;

package/cjs/Encoding/Unicode.cjs

@@ -1,45 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-'use strict';
-
-/**
- * @module Unicode
- */
-/**
- * @function encode
- * @param {string} input
- * @param {TypeArray} Buffer
- * @returns {Uint8Array}
- */
-function encode(input, TypeArray) {
-  const { length } = input;
-  const array = new TypeArray(length);
-  for (let i = 0; i < length; i++) {
-    array[i] = input.codePointAt(i) || 0;
-  }
-  return new Uint8Array(array.buffer);
-}
-/**
- * @function decode
- * @param {BufferSource} input
- * @param {TypeArray} Buffer
- * @returns {string}
- */
-function decode(input, TypeArray) {
-  let result = '';
-  const array = new TypeArray(ArrayBuffer.isView(input) ? input.buffer : input);
-  for (const code of array) {
-    result += String.fromCodePoint(code);
-  }
-  return result;
-}
-
-exports.decode = decode;
-exports.encode = encode;

package/cjs/Encoding/Unicode.d.cts

@@ -1,18 +0,0 @@
-/**
- * @module Unicode
- */
-export type TypeArray = typeof Uint16Array | typeof Uint32Array;
-/**
- * @function encode
- * @param {string} input
- * @param {TypeArray} Buffer
- * @returns {Uint8Array}
- */
-export declare function encode(input: string, TypeArray: TypeArray): Uint8Array;
-/**
- * @function decode
- * @param {BufferSource} input
- * @param {TypeArray} Buffer
- * @returns {string}
- */
-export declare function decode(input: BufferSource, TypeArray: TypeArray): string;

package/cjs/Encoding/index.cjs

@@ -1,65 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-'use strict';
-
-const UTF8 = require('./UTF8.cjs');
-const errors = require('../errors.cjs');
-const Unicode = require('./Unicode.cjs');
-
-/**
- * @module Encoding
- */
-/**
- * @function encode
- * @description 用指定编码编码字符串
- * @param {string} input 需要编码的字符串
- * @param {string} [encoding] 字符串编码
- * @returns {Uint8Array}
- */
-function encode(input, encoding = 'UTF8') {
-  switch (encoding.toUpperCase()) {
-    case 'UTF8':
-    case 'UTF-8':
-      return UTF8.encode(input);
-    case 'UTF16':
-    case 'UTF-16':
-      return Unicode.encode(input, Uint16Array);
-    case 'UTF32':
-    case 'UTF-32':
-      return Unicode.encode(input, Uint32Array);
-    default:
-      throw new TypeError(errors.encodingInvalid(encoding));
-  }
-}
-/**
- * @function decode
- * @description 用指定编码解码字符串数据
- * @param {BufferSource} input 需要解码的字符串数据
- * @param {string} [encoding] 字符串编码
- * @returns {string}
- */
-function decode(input, encoding = 'UTF8') {
-  switch (encoding.toUpperCase()) {
-    case 'UTF8':
-    case 'UTF-8':
-      return UTF8.decode(input);
-    case 'UTF16':
-    case 'UTF-16':
-      return Unicode.decode(input, Uint16Array);
-    case 'UTF32':
-    case 'UTF-32':
-      return Unicode.decode(input, Uint32Array);
-    default:
-      throw new TypeError(errors.encodingInvalid(encoding));
-  }
-}
-
-exports.decode = decode;
-exports.encode = encode;

package/cjs/Encoding/index.d.cts

@@ -1,19 +0,0 @@
-/**
- * @module Encoding
- */
-/**
- * @function encode
- * @description 用指定编码编码字符串
- * @param {string} input 需要编码的字符串
- * @param {string} [encoding] 字符串编码
- * @returns {Uint8Array}
- */
-export declare function encode(input: string, encoding?: string): Uint8Array;
-/**
- * @function decode
- * @description 用指定编码解码字符串数据
- * @param {BufferSource} input 需要解码的字符串数据
- * @param {string} [encoding] 字符串编码
- * @returns {string}
- */
-export declare function decode(input: BufferSource, encoding?: string): string;

package/esm/Encoding/UTF8.d.ts

@@ -1,15 +0,0 @@
-/**
- * @module UTF8
- */
-/**
- * @function encode
- * @param {string} input
- * @returns {Uint8Array}
- */
-export declare const encode: (input?: string) => Uint8Array;
-/**
- * @function decode
- * @param {BufferSource} input
- * @returns {string}
- */
-export declare const decode: (input?: BufferSource) => string;

package/esm/Encoding/UTF8.js

@@ -1,30 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-/**
- * @module UTF8
- */
-// 编码器实例
-const encoder = new TextEncoder();
-// 解码器实例
-const decoder = new TextDecoder();
-/**
- * @function encode
- * @param {string} input
- * @returns {Uint8Array}
- */
-const encode = encoder.encode.bind(encoder);
-/**
- * @function decode
- * @param {BufferSource} input
- * @returns {string}
- */
-const decode = decoder.decode.bind(decoder);
-
-export { decode, encode };

package/esm/Encoding/Unicode.d.ts

@@ -1,18 +0,0 @@
-/**
- * @module Unicode
- */
-export type TypeArray = typeof Uint16Array | typeof Uint32Array;
-/**
- * @function encode
- * @param {string} input
- * @param {TypeArray} Buffer
- * @returns {Uint8Array}
- */
-export declare function encode(input: string, TypeArray: TypeArray): Uint8Array;
-/**
- * @function decode
- * @param {BufferSource} input
- * @param {TypeArray} Buffer
- * @returns {string}
- */
-export declare function decode(input: BufferSource, TypeArray: TypeArray): string;

package/esm/Encoding/Unicode.js

@@ -1,42 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-/**
- * @module Unicode
- */
-/**
- * @function encode
- * @param {string} input
- * @param {TypeArray} Buffer
- * @returns {Uint8Array}
- */
-function encode(input, TypeArray) {
-  const { length } = input;
-  const array = new TypeArray(length);
-  for (let i = 0; i < length; i++) {
-    array[i] = input.codePointAt(i) || 0;
-  }
-  return new Uint8Array(array.buffer);
-}
-/**
- * @function decode
- * @param {BufferSource} input
- * @param {TypeArray} Buffer
- * @returns {string}
- */
-function decode(input, TypeArray) {
-  let result = '';
-  const array = new TypeArray(ArrayBuffer.isView(input) ? input.buffer : input);
-  for (const code of array) {
-    result += String.fromCodePoint(code);
-  }
-  return result;
-}
-
-export { decode, encode };

package/esm/Encoding/index.d.ts

@@ -1,19 +0,0 @@
-/**
- * @module Encoding
- */
-/**
- * @function encode
- * @description 用指定编码编码字符串
- * @param {string} input 需要编码的字符串
- * @param {string} [encoding] 字符串编码
- * @returns {Uint8Array}
- */
-export declare function encode(input: string, encoding?: string): Uint8Array;
-/**
- * @function decode
- * @description 用指定编码解码字符串数据
- * @param {BufferSource} input 需要解码的字符串数据
- * @param {string} [encoding] 字符串编码
- * @returns {string}
- */
-export declare function decode(input: BufferSource, encoding?: string): string;

package/esm/Encoding/index.js

@@ -1,62 +0,0 @@
-/**
- * @package @nuintun/buffer
- * @license MIT
- * @version 0.3.1
- * @author nuintun <nuintun@qq.com>
- * @description A buffer tool for javascript.
- * @see https://github.com/nuintun/Buffer#readme
- */
-
-import { encode as encode$2, decode as decode$2 } from './UTF8.js';
-import { encodingInvalid } from '../errors.js';
-import { encode as encode$1, decode as decode$1 } from './Unicode.js';
-
-/**
- * @module Encoding
- */
-/**
- * @function encode
- * @description 用指定编码编码字符串
- * @param {string} input 需要编码的字符串
- * @param {string} [encoding] 字符串编码
- * @returns {Uint8Array}
- */
-function encode(input, encoding = 'UTF8') {
-  switch (encoding.toUpperCase()) {
-    case 'UTF8':
-    case 'UTF-8':
-      return encode$2(input);
-    case 'UTF16':
-    case 'UTF-16':
-      return encode$1(input, Uint16Array);
-    case 'UTF32':
-    case 'UTF-32':
-      return encode$1(input, Uint32Array);
-    default:
-      throw new TypeError(encodingInvalid(encoding));
-  }
-}
-/**
- * @function decode
- * @description 用指定编码解码字符串数据
- * @param {BufferSource} input 需要解码的字符串数据
- * @param {string} [encoding] 字符串编码
- * @returns {string}
- */
-function decode(input, encoding = 'UTF8') {
-  switch (encoding.toUpperCase()) {
-    case 'UTF8':
-    case 'UTF-8':
-      return decode$2(input);
-    case 'UTF16':
-    case 'UTF-16':
-      return decode$1(input, Uint16Array);
-    case 'UTF32':
-    case 'UTF-32':
-      return decode$1(input, Uint32Array);
-    default:
-      throw new TypeError(encodingInvalid(encoding));
-  }
-}
-
-export { decode, encode };