字符串解码器

稳定性：2 - 稳定

node:string_decoder 模块提供了一个 API，用于将 Buffer 对象解码为字符串，同时保留编码的多字节 UTF-8 和 UTF-16 字符。可以使用以下方式访问它：

import { StringDecoder } from 'node:string_decoder';

以下示例展示了 StringDecoder 类的基本用法。

import { StringDecoder } from 'node:string_decoder';
import { Buffer } from 'node:buffer';
const decoder = new StringDecoder('utf8');

const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent)); // 输出：¢

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro)); // 输出：€

当 Buffer 实例被写入 StringDecoder 实例时，会使用内部缓冲区以确保解码后的字符串不包含任何不完整的多字节字符。这些字符会保留在缓冲区中，直到下一次调用 stringDecoder.write() 或调用 stringDecoder.end()。

在以下示例中，欧洲欧元符号（€）的三个 UTF-8 编码字节分三次单独操作写入：

import { StringDecoder } from 'node:string_decoder';
import { Buffer } from 'node:buffer';
const decoder = new StringDecoder('utf8');

decoder.write(Buffer.from([0xE2]));
decoder.write(Buffer.from([0x82]));
console.log(decoder.end(Buffer.from([0xAC]))); // 输出：€

new StringDecoder(encoding?): void

创建一个新的 StringDecoder 实例。

stringDecoder.end(buffer?): void

将内部缓冲区中存储的任何剩余输入作为字符串返回。表示不完整 UTF-8 和 UTF-16 字符的字节将被替换为适合该字符编码的替换字符。

如果提供了 buffer 参数，则在返回剩余输入之前会执行一次最终的 stringDecoder.write() 调用。调用 end() 后，stringDecoder 对象可以重用以为新输入服务。

stringDecoder.write(buffer): void

返回解码后的字符串，确保省略 Buffer、TypedArray 或 DataView 末尾的任何不完整多字节字符，并将其存储在内部缓冲区中，以便下次调用 stringDecoder.write() 或 stringDecoder.end()。