@nuintun/buffer 0.3.2 → 0.4.0

package/cjs/index.d.cts

@@ -3,8 +3,26 @@
  */
 import type { TypedArray } from './utils.cjs';
 import { Endian } from './enum.cjs';
+import { TextDecode, TextEncode } from './encoding.cjs';
 export { Endian };
 export type { TypedArray };
+export interface Options {
+  /**
+   * @property {number} [pageSize]
+   * @description 缓存页大小
+   */
+  pageSize?: number;
+  /**
+   * @property {TextEncode} [encode]
+   * @description 文本编码函数
+   */
+  encode?: TextEncode;
+  /**
+   * @property {TextDecode} [decode]
+   * @description 文本解码函数
+   */
+  decode?: TextDecode;
+}
 /**
  * @function endianness
  * @description 获取系统默认字节序
@@ -22,19 +40,19 @@ export declare class Buffer {
    * @param {number} [length] 缓冲区初始字节大小
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(length?: number, pageSize?: number);
+  constructor(length?: number, options?: Options);
   /**
    * @constructor
    * @param {Uint8Array} bytes 缓冲区初始字节数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(bytes: TypedArray, pageSize?: number);
+  constructor(bytes: TypedArray, options?: Options);
   /**
    * @constructor
    * @param {ArrayBuffer} buffer 缓冲区初始缓冲数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(buffer: ArrayBuffer, pageSize?: number);
+  constructor(buffer: ArrayBuffer, options?: Options);
   /**
    * @public
    * @property {number} offset
@@ -289,6 +307,12 @@ export declare class Buffer {
    * @returns {IterableIterator<number>}
    */
   values(): IterableIterator<number>;
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator](): IterableIterator<number>;
   /**
    * @override
    * @method toString
@@ -296,10 +320,4 @@ 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.2
+ * @version 0.4.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/{cjs/Binary.d.cts → esm/binary.d.ts}

@@ -1,5 +1,5 @@
 /**
- * @module Binary
+ * @module binary
  */
 /**
  * @type {string[]}

package/esm/{Binary.js → binary.js}

@@ -1,14 +1,14 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.2
+ * @version 0.4.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
  */
 
 /**
- * @module Binary
+ * @module binary
  */
 /**
  * @type {string[]}

package/esm/encoding.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @module encoding
+ */
+export interface TextEncode {
+  /**
+   * @function encode
+   * @description 用指定编码编码字符串
+   * @param {string} content 待编码文本
+   * @param {string} encoding 编码类型
+   * @returns {Uint8Array}
+   */
+  (content: string, encoding: string): Uint8Array;
+}
+export interface TextDecode {
+  /**
+   * @function decode
+   * @description 用指定编码解码字节数组
+   * @param {Uint8Array} bytes 待解码字节数组
+   * @param {string} encoding 编码类型
+   * @returns {string}
+   */
+  (bytes: Uint8Array, encoding: string): string;
+}
+export declare function encode(content: string, encoding: string): Uint8Array;
+export declare function decode(bytes: Uint8Array, encoding: string): string;

package/esm/encoding.js

@@ -0,0 +1,91 @@
+/**
+ * @package @nuintun/buffer
+ * @license MIT
+ * @version 0.4.0
+ * @author nuintun <nuintun@qq.com>
+ * @description A buffer tool for javascript.
+ * @see https://github.com/nuintun/Buffer#readme
+ */
+
+import { encodingInvalid } from './errors.js';
+
+/**
+ * @module encoding
+ */
+/**
+ * @function encodeSBSC
+ * @description 单字节字符编码
+ * @param {string} content 文本内容
+ * @param {number} maxCode 最大编码
+ * @returns {Uint8Array}
+ */
+function encodeSBSC(content, maxCode) {
+  const bytes = [];
+  for (const character of content) {
+    const code = character.codePointAt(0);
+    // If gt max code, push "?".
+    bytes.push(code == null || code > maxCode ? 63 : code);
+  }
+  return new Uint8Array(bytes);
+}
+/**
+ * @function swapEndian
+ * @description 翻转字节序
+ * @param {number} value 待翻转字节序的值
+ * @returns {number}
+ */
+function swapEndian(value) {
+  return ((value & 0xff) << 8) | ((value >> 8) & 0xff);
+}
+/**
+ * @function encodeUTF16
+ * @param {string} input 待编码字符串
+ * @param {boolean} [littleEndian] 是否使用小端字节序
+ * @returns {Uint8Array}
+ */
+function encodeUTF16(input, littleEndian) {
+  let offset = 0;
+  // 分配内存
+  const codes = new Uint16Array(input.length);
+  for (const char of input) {
+    const code = char.codePointAt(0);
+    if (code > 0xffff) {
+      // 代理对处理
+      const high = 0xd800 | ((code - 0x10000) >> 10);
+      const low = 0xdc00 | (code & 0x3ff);
+      codes[offset++] = littleEndian ? high : swapEndian(high);
+      codes[offset++] = littleEndian ? low : swapEndian(low);
+    } else {
+      codes[offset++] = littleEndian ? code : swapEndian(code);
+    }
+  }
+  return new Uint8Array(codes.buffer, 0, offset * 2);
+}
+function encode(content, encoding) {
+  switch (encoding.toLowerCase()) {
+    case 'ascii':
+      return encodeSBSC(content, 0x7f);
+    case 'latin1':
+      return encodeSBSC(content, 0xff);
+    case 'utf8':
+    case 'utf-8':
+      return new TextEncoder().encode(content);
+    case 'utf16le':
+    case 'utf-16le':
+      return encodeUTF16(content, true);
+    case 'utf16be':
+    case 'utf-16be':
+      return encodeUTF16(content, false);
+    default:
+      throw new Error(encodingInvalid(encoding));
+  }
+}
+function decode(bytes, encoding) {
+  try {
+    return new TextDecoder(encoding).decode(bytes);
+  } catch {
+    throw new Error(encodingInvalid(encoding));
+  }
+}
+
+export { decode, encode };

package/esm/enum.js

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

package/esm/errors.d.ts

@@ -4,7 +4,7 @@
 /**
  * @function encodingInvalid
  * @description 未支持的编码格式
- * @param encoding 编码格式
+ * @param {string} encoding 编码格式
  */
 export declare function encodingInvalid(encoding: string): string;
 export declare const offsetInvalid = 'invalid buffer offset';

package/esm/errors.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.2
+ * @version 0.4.0
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -13,7 +13,7 @@
 /**
  * @function encodingInvalid
  * @description 未支持的编码格式
- * @param encoding 编码格式
+ * @param {string} encoding 编码格式
  */
 function encodingInvalid(encoding) {
   return 'unsupported encoding ' + encoding;

package/esm/index.d.ts

@@ -3,8 +3,26 @@
  */
 import type { TypedArray } from './utils.js';
 import { Endian } from './enum.js';
+import { TextDecode, TextEncode } from './encoding.js';
 export { Endian };
 export type { TypedArray };
+export interface Options {
+  /**
+   * @property {number} [pageSize]
+   * @description 缓存页大小
+   */
+  pageSize?: number;
+  /**
+   * @property {TextEncode} [encode]
+   * @description 文本编码函数
+   */
+  encode?: TextEncode;
+  /**
+   * @property {TextDecode} [decode]
+   * @description 文本解码函数
+   */
+  decode?: TextDecode;
+}
 /**
  * @function endianness
  * @description 获取系统默认字节序
@@ -22,19 +40,19 @@ export declare class Buffer {
    * @param {number} [length] 缓冲区初始字节大小
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(length?: number, pageSize?: number);
+  constructor(length?: number, options?: Options);
   /**
    * @constructor
    * @param {Uint8Array} bytes 缓冲区初始字节数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(bytes: TypedArray, pageSize?: number);
+  constructor(bytes: TypedArray, options?: Options);
   /**
    * @constructor
    * @param {ArrayBuffer} buffer 缓冲区初始缓冲数据
    * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
    */
-  constructor(buffer: ArrayBuffer, pageSize?: number);
+  constructor(buffer: ArrayBuffer, options?: Options);
   /**
    * @public
    * @property {number} offset
@@ -289,6 +307,12 @@ export declare class Buffer {
    * @returns {IterableIterator<number>}
    */
   values(): IterableIterator<number>;
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator](): IterableIterator<number>;
   /**
    * @override
    * @method toString
@@ -296,10 +320,4 @@ export declare class Buffer {
    * @returns {string}
    */
   toString(): string;
-  /**
-   * @method iterator
-   * @description 迭代器
-   * @returns {IterableIterator<number>}
-   */
-  [Symbol.iterator](): IterableIterator<number>;
 }

package/esm/index.js

@@ -1,16 +1,16 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.2
+ * @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 { encode, decode } from './encoding.js';
 import { isTypedArray, makeUint8Array, isNaturalNumber } from './utils.js';
 
 /**
@@ -47,14 +47,14 @@ class Buffer {
   #offset = 0;
   // 已使用字节长度
   #length = 0;
-  /**
-   * @constructor
-   * @param {number | Uint8Array | ArrayBuffer} [input] 缓冲区初始配置
-   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
-   */
-  constructor(input = 0, pageSize = 4096) {
+  // 文本编码方法
+  #encode;
+  // 文本解码方法
+  #decode;
+  constructor(input = 0, options = {}) {
     let length;
     let bytes;
+    const { pageSize = 4096 } = options;
     if (isTypedArray(input)) {
       length = input.byteLength;
       bytes = makeUint8Array(length, pageSize);
@@ -74,6 +74,8 @@ class Buffer {
     this.#bytes = bytes;
     this.#length = length;
     this.#pageSize = pageSize;
+    this.#encode = options.encode ?? encode;
+    this.#decode = options.decode ?? decode;
     this.#dataView = new DataView(bytes.buffer);
   }
   /**
@@ -327,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) {
@@ -481,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;
   }
@@ -495,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
@@ -535,6 +540,14 @@ class Buffer {
       yield bytes[i];
     }
   }
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator]() {
+    return this.values();
+  }
   /**
    * @override
    * @method toString
@@ -544,23 +557,13 @@ class Buffer {
   toString() {
     // 二进制编码字符串
     let binary = '';
-    // 提前获取 bytes，防止重复计算
-    const bytes = this.bytes;
     // 获取二进制编码
-    for (const byte of bytes) {
+    for (const byte of this) {
       binary += mapping[byte];
     }
     // 返回二进制编码
     return binary;
   }
-  /**
-   * @method iterator
-   * @description 迭代器
-   * @returns {IterableIterator<number>}
-   */
-  [Symbol.iterator]() {
-    return this.values();
-  }
 }
 
 export { Buffer, Endian, endianness };

package/esm/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.2
+ * @version 0.4.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.3.2",
+  "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.2
- * @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.2
- * @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.2
- * @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;