Source Code: lib/string_decoder.js
The node:string_decoder module provides an API for decoding Buffer objects\ninto strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16\ncharacters. It can be accessed using:
node:string_decoder
Buffer
const { StringDecoder } = require('node:string_decoder');\n
The following example shows the basic use of the StringDecoder class.
StringDecoder
const { StringDecoder } = require('node:string_decoder');\nconst decoder = new StringDecoder('utf8');\n\nconst cent = Buffer.from([0xC2, 0xA2]);\nconsole.log(decoder.write(cent));\n\nconst euro = Buffer.from([0xE2, 0x82, 0xAC]);\nconsole.log(decoder.write(euro));\n
When a Buffer instance is written to the StringDecoder instance, an\ninternal buffer is used to ensure that the decoded string does not contain\nany incomplete multibyte characters. These are held in the buffer until the\nnext call to stringDecoder.write() or until stringDecoder.end() is called.
stringDecoder.write()
stringDecoder.end()
In the following example, the three UTF-8 encoded bytes of the European Euro\nsymbol (€) are written over three separate operations:
€
const { StringDecoder } = require('node:string_decoder');\nconst decoder = new StringDecoder('utf8');\n\ndecoder.write(Buffer.from([0xE2]));\ndecoder.write(Buffer.from([0x82]));\nconsole.log(decoder.end(Buffer.from([0xAC])));\n
Returns any remaining input stored in the internal buffer as a string. Bytes\nrepresenting incomplete UTF-8 and UTF-16 characters will be replaced with\nsubstitution characters appropriate for the character encoding.
If the buffer argument is provided, one final call to stringDecoder.write()\nis performed before returning the remaining input.\nAfter end() is called, the stringDecoder object can be reused for new input.
buffer
end()
stringDecoder
Returns a decoded string, ensuring that any incomplete multibyte characters at\nthe end of the Buffer, or TypedArray, or DataView are omitted from the\nreturned string and stored in an internal buffer for the next call to\nstringDecoder.write() or stringDecoder.end().
TypedArray
DataView
Creates a new StringDecoder instance.