Node.js v16.20.2 文档


¥String decoder

稳定性: 2 - 稳定的

¥Stability: 2 - Stable

源代码: lib/string_decoder.js

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

¥The node:string_decoder module provides an API for decoding Buffer objects into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 characters. It can be accessed using:

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

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

¥The following example shows the basic use of the StringDecoder class.

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

const cent = Buffer.from([0xC2, 0xA2]);

const euro = Buffer.from([0xE2, 0x82, 0xAC]);

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

¥When a Buffer instance is written to the StringDecoder instance, an internal buffer is used to ensure that the decoded string does not contain any incomplete multibyte characters. These are held in the buffer until the next call to stringDecoder.write() or until stringDecoder.end() is called.

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

¥In the following example, the three UTF-8 encoded bytes of the European Euro symbol () are written over three separate operations:

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



¥Class: StringDecoder

new StringDecoder([encoding])#

创建新的 StringDecoder 实例。

¥Creates a new StringDecoder instance.


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

¥Returns any remaining input stored in the internal buffer as a string. Bytes representing incomplete UTF-8 and UTF-16 characters will be replaced with substitution characters appropriate for the character encoding.

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

¥If the buffer argument is provided, one final call to stringDecoder.write() is performed before returning the remaining input. After end() is called, the stringDecoder object can be reused for new input.


返回已解码的字符串,确保从返回的字符串中省略 BufferTypedArrayDataView 末尾的任何不完整的多字节字符,并将其存储在内部缓冲区中,以备下次调用 stringDecoder.write()stringDecoder.end() 时使用。

¥Returns a decoded string, ensuring that any incomplete multibyte characters at the end of the Buffer, or TypedArray, or DataView are omitted from the returned string and stored in an internal buffer for the next call to stringDecoder.write() or stringDecoder.end().