{ } qjs-modules

string_decoder

Source: lib/string_decoder.js — import as string_decoder (also node:string_decoder, and require()); qjsm only

Node's string_decoder: decodes a byte stream chunk by chunk without splitting a character between two chunks. Built on textcode's TextDecoder and decode().

import { StringDecoder } from 'string_decoder';

const d = new StringDecoder('utf8');

d.write(Uint8Array.of(0xe2, 0x82)); // ''  (the bytes wait)
d.end(Uint8Array.of(0xac));         // '€'
MemberMeaning
new StringDecoder(encoding = 'utf8')utf8, utf16le, latin1, base64, base64url, hex, ascii, or an alias (utf-8, ucs2, ucs-2, utf-16le, binary), any case; else TypeError ERR_UNKNOWN_ENCODING
encodingthe normalized name, 'utf16le' for 'UCS-2'
write(buf)the text of the held bytes plus buf, up to the last whole character; a string buf is returned as is
end(buf?)write(buf) plus the held bytes, then the decoder starts over

buf is a TypedArray, DataView or Buffer; anything else throws TypeError ERR_INVALID_ARG_TYPE.

What waits for the next chunk, and what end() makes of it:

EncodingHeld backend()
utf8an incomplete characterU+FFFD
utf16lean odd byte, a high surrogate ending an even chunkthe lone surrogate, an odd byte is dropped
base64, base64urlthe bytes after the last whole 3-byte groupencoded, = padded for base64
hex, latin1, asciinothing—

A byte order mark is kept, as in Node. The default export is { StringDecoder }.

Not covered: Node's undocumented lastChar, lastNeed, lastTotal and text().

Export list

Generated by utilities/doc-api.js from the string_decoder dump of utilities/api-surface.sh: 6 members. Edit the text above this block, not the block.

StringDecoder

class, constructible

  • methods: end(), write()

default

object

  • static methods: StringDecoder()