字符串解码器#

源代码: lib/string_decoder.js

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

const { StringDecoder } = require('node:string_decoder'); copy

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

const { StringDecoder } = require('node:string_decoder');
const decoder = new StringDecoder('utf8');

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

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro)); // Prints: € copy

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

在以下示例中，欧洲欧元符号 (€) 的三个 UTF-8 编码字节通过三个单独的操作写入

const { StringDecoder } = require('node:string_decoder');
const decoder = new StringDecoder('utf8');

decoder.write(Buffer.from([0xE2]));
decoder.write(Buffer.from([0x82]));
console.log(decoder.end(Buffer.from([0xAC]))); // Prints: € copy

类: StringDecoder#

new StringDecoder([encoding])#

添加于: v0.1.99

• encoding <string> StringDecoder 将使用的字符 编码。默认值: 'utf8'。

创建一个新的 StringDecoder 实例。

stringDecoder.end([buffer])#

添加于: v0.9.3

• buffer <string> | <Buffer> | <TypedArray> | <DataView> 要解码的字节。
• 返回值: <string>

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

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

stringDecoder.write(buffer)#

历史

版本	更改
v8.0.0	现在每个无效字符都用单个替换字符替换，而不是每个字节一个替换字符。
v0.1.99	添加于: v0.1.99

• buffer <string> | <Buffer> | <TypedArray> | <DataView> 要解码的字节。
• 返回值: <string>

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