字符串解码器#

源代码: lib/string_decoder.js

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])#

新增于： 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() 时使用。