Node.js v26.0.0 文档

String decoder#

node:string_decoder 模块提供了一个 API，用于将 Buffer 对象解码为字符串，并能以保持编码的多字节 UTF-8 和 UTF-16 字符的方式进行解码。可以通过以下方式访问：

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

以下示例展示了 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)); // Prints: ¢

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro)); // Prints: €
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 编码字节分三次独立的操作写入：

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]))); // Prints: €
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])#

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

创建一个新的 StringDecoder 实例。

stringDecoder.end([buffer])#

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

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

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

stringDecoder.write(buffer)#

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

返回一个解码后的字符串，确保 Buffer、TypedArray 或 DataView 末尾的任何不完整多字节字符不会出现在返回的字符串中，而是存储在内部缓冲区中，以供下一次调用 stringDecoder.write() 或 stringDecoder.end() 使用。