字符串解码器

[稳定版: 2 - 稳定版]

稳定版: 2 稳定性: 2 - 稳定版

源代码: lib/string_decoder.js

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

ESM

import { StringDecoder } from 'node:string_decoder'

CJS

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

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

ESM

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)) // 输出: €

CJS

const { StringDecoder } = require('node:string_decoder')
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 编码字节通过三个单独的操作写入：

ESM

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]))) // 输出: €

CJS

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]))) // 输出: €

类: 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 <字符串> | <Buffer> | <TypedArray> | <DataView> 要解码的字节。
• 返回值: <字符串>

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